調用DescribeHiTSDBInstanceList查詢數據庫獲取實例列表。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
PageNumber Integer 是 1

頁碼
PageSize Integer 是 30

每頁大小
RegionId String 是 cn-hangzhou

地域ID
QueryStr String 否 test

實例名稱關鍵字，可根據該參數做模糊搜索
StatusList String 否 ["ACTIVATION", "DELETED"]

狀態過濾列表，JSON格式，枚舉值為InstanceStatus。
EngineType String 否 tsdb_tsdb

引擎類型，tsdb_tsdb-tsdb類型，tsdb_influxdb-TSDB for InfluxDB??類型

返回數據

名稱 類型 示例值 描述
InstanceList Array of Instance

實例列表
ChargeType String POSTPAY

付費類型，PREPAY-包年包月；POSTPAY-按量付費
CreateTime Long 1603426323000

實例創建的時間戳
EngineType String tsdb_tsdb

引擎類型，tsdb_tsdb-tsdb類型，tsdb_influxdb-TSDB for InfluxDB??類型
ExpiredTime Long 1611417600000

對于包年包月類型，實例過期的時間戳
GmtCreated String 2020-11-16 16:22:56

實例創建時間，格式為yyyy-MM-dd HH:mm:ss
GmtExpire String 2020-12-17 00:00:00

付費類型為包年包月的實例的到期時間，格式為yyyy-MM-dd HH:mm:ss
InstanceAlias String test_tsdb

實例名稱
InstanceClass String tsdb.1x.basic

實例規格
InstanceDescription String test

實例描述
InstanceId String ts-xxxxxxxxxxxxxxxxx

實例ID
InstanceStatus String ACTIVATION

實例狀態， 枚舉
InstanceStorage String 50

實例存儲， 單位 G
InstanceTps String 960000

實例 Tps 性能， 單位<請求/秒>
LockMode String 0

實例是否被鎖定，0-未鎖定，1-鎖定
MaxSeriesPerDatabase String 10000

單個數據庫時間線的最大數量
NetworkType String VPC

實例網絡類型：VPC-專有網絡
PaymentType String PREPAY

付費類型，PREPAY-包年包月；POSTPAY-按量付費
RegionId String cn-hangzhou

實例所在地域ID
Status String ACTIVATION

實例狀態，ACTIVATION-運行中，CREATING-創建中，NET_CREATING-創建網絡鏈接中，CLASS_CHANGING-實例變配中，LOCKED-已鎖定，DELETED-已刪除
UserId String 1000000000000000

用戶ID
VpcId String vpc-bp1xxxxxxxxxxxxxxxxxx

專有網絡（VPC）的ID
VswitchId String vsw-bp1xxxxxxxxxxxxxxxxxx

虛擬交換機的ID
ZoneId String cn-hongkong-b

實例可用區ID
PageNumber Integer 1

頁碼
PageSize Integer 20

分頁大小
RequestId String 0A7153E4-8354-497E-87E5-5D0EBEF5AEB1

請求ID
Total Integer 10

總條數

示例

請求示例

http(s)://[Endpoint]/?Action=DescribeHiTSDBInstanceList
&PageNumber=1
&PageSize=30
&RegionId=cn-hangzhou
&<公共請求參數>

正常返回示例

XML 格式 

<PageSize>20</PageSize>
<RequestId>0A7153E4-8354-497E-87E5-5D0EBEF5AEB1</RequestId>
<PageNumber>1</PageNumber>
<Total>10</Total>
<InstanceList>
    <MaxSeriesPerDatabase>10000</MaxSeriesPerDatabase>
    <GmtCreated>2020-11-16 16:22:56</GmtCreated>
    <GmtExpire>2020-12-17 00:00:00</GmtExpire>
    <NetworkType>VPC</NetworkType>
    <InstanceStatus>ACTIVATION</InstanceStatus>
    <InstanceAlias>test_tsdb</InstanceAlias>
    <ExpiredTime>1611417600000</ExpiredTime>
    <PaymentType>PREPAY</PaymentType>
    <EngineType>tsdb_tsdb</EngineType>
    <InstanceTps>960000</InstanceTps>
    <Status>ACTIVATION</Status>
    <InstanceStorage>50</InstanceStorage>
    <ZoneId>cn-hongkong-b</ZoneId>
    <InstanceId>ts-xxxxxxxxxxxxxxxxx</InstanceId>
    <CreateTime>1603426323000</CreateTime>
    <InstanceClass>tsdb.1x.basic</InstanceClass>
    <LockMode>0</LockMode>
    <VswitchId>vsw-bp1xxxxxxxxxxxxxxxxxx</VswitchId>
    <VpcId>vpc-bp1xxxxxxxxxxxxxxxxxx</VpcId>
    <ChargeType>POSTPAY</ChargeType>
    <UserId>1000000000000000</UserId>
    <InstanceDescription>test</InstanceDescription>
    <RegionId>cn-hangzhou</RegionId>
</InstanceList>

JSON 格式 

{
  "PageSize": "20",
  "RequestId": "0A7153E4-8354-497E-87E5-5D0EBEF5AEB1",
  "PageNumber": "1",
  "Total": "10",
  "InstanceList": [
    {
      "MaxSeriesPerDatabase": "10000",
      "GmtCreated": "2020-11-16 16:22:56",
      "GmtExpire": "2020-12-17 00:00:00",
      "NetworkType": "VPC",
      "InstanceStatus": "ACTIVATION",
      "InstanceAlias": "test_tsdb",
      "ExpiredTime": "1611417600000",
      "PaymentType": "PREPAY",
      "EngineType": "tsdb_tsdb",
      "InstanceTps": "960000",
      "Status": "ACTIVATION",
      "InstanceStorage": "50",
      "ZoneId": "cn-hongkong-b",
      "InstanceId": "ts-xxxxxxxxxxxxxxxxx",
      "CreateTime": "1603426323000",
      "InstanceClass": "tsdb.1x.basic",
      "LockMode": "0",
      "VswitchId": "vsw-bp1xxxxxxxxxxxxxxxxxx",
      "VpcId": "vpc-bp1xxxxxxxxxxxxxxxxxx",
      "ChargeType": "POSTPAY",
      "UserId": "1000000000000000",
      "InstanceDescription": "test",
      "RegionId": "cn-hangzhou"
    }
  ]
}

錯誤碼

HttpCode 錯誤碼 錯誤信息 描述
400 TSDB.Errorcode.ParameterInvaild The parameter is invalid. 參數無效

訪問錯誤中心查看更多錯誤碼。