调用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. 参数无效

访问错误中心查看更多错误码。