调用DescribeHiTSDBInstance获取实例详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

请求参数

名称类型是否必选示例值描述
名称 类型 是否必选 示例值 描述
Action String 否 DescribeHiTSDBInstance

系统规定参数。取值：DescribeHiTSDBInstance。

InstanceId String 是 ts-ufxxxxxxxxxx

实例ID
RegionId String 否 cn-hangzhou

区域ID

返回数据

名称类型示例值描述
名称 类型 示例值 描述
AutoRenew Boolean true

付费类型为包年包月的实例，是否开通自动续费
ChargeType String PREPAY

付费类型，PREPAY-包年包月；POSTPAY-按量付费
ConnectionString String ts-xxxxxxxxxxxxxxxxx.hitsdb.tsdb.aliyuncs.com:8242

数据库连接地址
CpuNumber String 2

CPU核数
CreateTime Long 1603426323000

实例创建的时间戳
DiskCategory String cloud_efficiency

对于TSDB for InfluxDB®️类型，cloud_efficiency-高效云盘，cloud_ssd-SSD云盘
EngineType String tsdb_tsdb

引擎类型，tsdb_tsdb-tsdb类型，tsdb_influxdb-TSDB for InfluxDB®️类型，tsdb1.5-tsdb1.5类型
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 tsdb_test

实例名称
InstanceClass String tsdb.96x.large_lindorm

实例规格
InstanceDescription String test

实例描述
InstanceId String ts-xxxxxxxxxxxxxxxxx

实例ID
InstanceStatus String ACTIVATION

实例状态，ACTIVATION-运行中，CREATING-创建中，NET_CREATING-创建网络链接中，CLASS_CHANGING-实例变配中

，LOCKED-已锁定，DELETED-已删除
InstanceStorage String 320

实例存储， 单位 G
InstanceTps String 960000

实例 Tps 性能， 单位<请求/秒>
MaxTimelineLimit String 2400000

实例时间线性能， 单位<条>，针对TSDB类型实例
MemSize String 8

数据库内存大小，针对TSDB for InfluxDB®️类型实例
NetworkType String VPC

实例网络类型
PaymentType String PREPAY

付费类型，PREPAY-包年包月；POSTPAY-按量付费
PublicConnectionString String ts-xxxxxxxxxxxxxxxxx.influxdata.rds.aliyuncs.com:3242

实例公网连接串
RegionId String cn-shanghai

区域ID
RequestId String 8D156621-1FCB-414A-BD29-361C3CA4DD56

请求ID
SecurityIpList Array of SecurityIp

实例白名单列表
Ip String 0.0.0.0/0

实例白名单 IP
Series Integer 1

TSDB for InfluxDB®️类型实例的版本，0-基础版，1-高可用版
Status String ACTIVATION

实例状态，ACTIVATION-运行中，CREATING-创建中，NET_CREATING-创建网络链接中，CLASS_CHANGING-实例变配中

，LOCKED-已锁定，DELETED-已删除
VpcId String vpc-xxxxxxxxxxxxxxxxxxxxx

专有网络ID
VswitchId String vsw-xxxxxxxxxxxxxxxxxxxxx

专有网络交换机ID
ZoneId String cn-shanghai-f

实例可用区ID

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeHiTSDBInstance
&InstanceId=ts-ufxxxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式 

<AutoRenew>true</AutoRenew>
<GmtCreated>2020-11-16 16:22:56</GmtCreated>
<CpuNumber>2</CpuNumber>
<MemSize>8</MemSize>
<GmtExpire>2020-12-17 00:00:00</GmtExpire>
<NetworkType>VPC</NetworkType>
<InstanceStatus>ACTIVATION</InstanceStatus>
<InstanceAlias>tsdb_test</InstanceAlias>
<MaxTimelineLimit>2400000</MaxTimelineLimit>
<EngineType>tsdb_tsdb</EngineType>
<PublicConnectionString>ts-xxxxxxxxxxxxxxxxx.influxdata.rds.aliyuncs.com:3242</PublicConnectionString>
<InstanceTps>960000</InstanceTps>
<InstanceStorage>320</InstanceStorage>
<ZoneId>cn-shanghai-f</ZoneId>
<RequestId>8D156621-1FCB-414A-BD29-361C3CA4DD56</RequestId>
<InstanceId>ts-xxxxxxxxxxxxxxxxx</InstanceId>
<DiskCategory>cloud_efficiency</DiskCategory>
<InstanceClass>tsdb.96x.large_lindorm</InstanceClass>
<VswitchId>vsw-xxxxxxxxxxxxxxxxxxxxx</VswitchId>
<Series>1</Series>
<VpcId>vpc-xxxxxxxxxxxxxxxxxxxxx</VpcId>
<ChargeType>PREPAY</ChargeType>
<SecurityIpList>
    <Ip>0.0.0.0/0</Ip>
</SecurityIpList>
<InstanceDescription>test</InstanceDescription>
<RegionId>cn-shanghai</RegionId>
<ConnectionString>ts-xxxxxxxxxxxxxxxxx.hitsdb.tsdb.aliyuncs.com:8242</ConnectionString>

JSON 格式 

{
  "AutoRenew": "true",
  "GmtCreated": "2020-11-16 16:22:56",
  "CpuNumber": "2",
  "MemSize": "8",
  "GmtExpire": "2020-12-17 00:00:00",
  "NetworkType": "VPC",
  "InstanceStatus": "ACTIVATION",
  "InstanceAlias": "tsdb_test",
  "ExpiredTime": "1611417600000",
  "PaymentType": "PREPAY",
  "MaxTimelineLimit": "2400000",
  "EngineType": "tsdb_tsdb",
  "PublicConnectionString": "ts-xxxxxxxxxxxxxxxxx.influxdata.rds.aliyuncs.com:3242",
  "InstanceTps": "960000",
  "Status": "ACTIVATION",
  "InstanceStorage": "320",
  "ZoneId": "cn-shanghai-f",
  "RequestId": "8D156621-1FCB-414A-BD29-361C3CA4DD56",
  "InstanceId": "ts-xxxxxxxxxxxxxxxxx",
  "CreateTime": "1603426323000",
  "DiskCategory": "cloud_efficiency",
  "InstanceClass": "tsdb.96x.large_lindorm",
  "VswitchId": "vsw-xxxxxxxxxxxxxxxxxxxxx",
  "Series": "1",
  "VpcId": "vpc-xxxxxxxxxxxxxxxxxxxxx",
  "ChargeType": "PREPAY",
  "SecurityIpList": [
    {
      "Ip": "0.0.0.0/0"
    }
  ],
  "InstanceDescription": "test",
  "RegionId": "cn-shanghai",
  "ConnectionString": "ts-xxxxxxxxxxxxxxxxx.hitsdb.tsdb.aliyuncs.com:8242"
}

错误码

HttpCode错误码错误信息描述
HttpCode 错误码 错误信息 描述
400 TSDB.Errorcode.ParameterInvaild The parameter is invalid. 参数无效

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