Queries the details about an instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribeHiTSDBInstance

The operation that you want to perform. Set the value to DescribeHiTSDBInstance.

InstanceId String Yes ts-ufxxxxxxxxxx

The ID of the instance.
RegionId String No cn-hangzhou

The ID of the region.

Response parameters

Parameter Type Example Description
AutoRenew Boolean true

Indicates whether auto-renewal is enabled for the instance that uses the subscription billing method.

ChargeType String PREPAY

The billing method of the instance. Valid values: PREPAY and POSTPAY. The PREPAY value indicates the subscription billing method. The POSTPAY value indicates the pay-as-you-go billing method.

ConnectionString String ts-xxxxxxxxxxxxxxxxx.hitsdb.tsdb.aliyuncs.com:8242

The endpoint of the instance.
CpuNumber String 2

The number of CPU cores.
CreateTime Long 1603426323000

The timestamp that indicates the time when the instance was created.
DiskCategory String cloud_efficiency

The disk type. For an TSDB for InfluxDB®️ instance, the valid values are cloud_efficiency and cloud_ssd. cloud_efficiency indicates ultra disks. cloud_ssd indicates standard SSDs.

EngineType String tsdb_tsdb

The engine type. Valid values: tsdb_tsdb and tsdb_influxdb. tsdb_tsdb indicates TSDB. tsdb_influxdb indicates TSDB for InfluxDB®️.

ExpiredTime Long 1611417600000

The timestamp that indicates the time when the instance subscription expires. This parameter is returned only if the specified instance uses the subscription billing method.

GmtCreated String 2020-11-16 16:22:56

The time when the instance was created. The time is in the yyyy-MM-dd HH:mm:ss format.
GmtExpire String 2020-12-17 00:00:00

The time when the instance subscription expires. The time is in the yyyy-MM-dd HH:mm:ss format. This parameter is returned only if the specified instance uses the subscription billing method.

InstanceAlias String tsdb_test

The name of the instance.
InstanceClass String tsdb.96x.large_lindorm

The instance type.
InstanceDescription String test

The description of the instance.
InstanceId String ts-xxxxxxxxxxxxxxxxx

The ID of the instance.
InstanceStatus String ACTIVATION

The status of the instance. Valid values: ACTIVATION, CREATING, NET_CREATING, CLASS_CHANGING, LOCKED, and DELETED. ACTIVATION indicates that the instance is running. CREATING indicates that the instance is being created. NET_CREATING indicates that a network connection to the instance is being created. CLASS_CHANGING indicates that the configuration of the instance is being modified.

LOCKED indicates that the instance is locked. DELETED indicates that the instance is deleted.

InstanceStorage String 320

The storage of the instance. Unit: GB.
InstanceTps String 960000

The transactions per second (TPS) of the instance. Unit: TPS.
MaxTimelineLimit String 2400000

The number of time series supported by the instance. This parameter is returned only if your instance is a TSDB instance.

MemSize String 8

The memory size of the instance. This parameter is returned only if your instance is a TSDB for InfluxDB®️ instance.

NetworkType String VPC

The network type of the instance.
PaymentType String PREPAY

The billing method of the instance. Valid values: PREPAY and POSTPAY. The PREPAY value indicates the subscription billing method. The POSTPAY value indicates the pay-as-you-go billing method.

PublicConnectionString String ts-xxxxxxxxxxxxxxxxx.influxdata.rds.aliyuncs.com:3242

The public endpoint of the instance. You can use the public endpoint to access the instance over the Internet.

RegionId String cn-shanghai

The ID of the region.
RequestId String 8D156621-1FCB-414A-BD29-361C3CA4DD56

The ID of the request.
SecurityIpList Array of SecurityIp

The IP address whitelist of the instance.
Ip String 0.0.0.0/0

The IP address in the whitelist of the instance.
Series Integer 1

The edition of the TSDB for InfluxDB®️ instance. Valid values: 0 and 1. 0 indicates the Standard Edition. 1 indicates the High-availability Edition.

Status String ACTIVATION

The status of the instance. Valid values: ACTIVATION, CREATING, NET_CREATING, CLASS_CHANGING, LOCKED, and DELETED. ACTIVATION indicates that the instance is running. CREATING indicates that the instance is being created. NET_CREATING indicates that a network connection to the instance is being created. CLASS_CHANGING indicates that the configuration of the instance is being modified.

LOCKED indicates that the instance is locked. DELETED indicates that the instance is deleted.

VpcId String vpc-xxxxxxxxxxxxxxxxxxxxx

The ID of the virtual private cloud (VPC).
VswitchId String vsw-xxxxxxxxxxxxxxxxxxxxx

The ID of the vSwitch.
ZoneId String cn-shanghai-f

The ID of the zone where the instance is deployed.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeHiTSDBInstance
&InstanceId=ts-ufxxxxxxxxxx
&<Common request parameters>

Successful response examples

XML format 

<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 format 

{
  "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"
}

Error codes

HttpCode Error code Error message Description
400 TSDB.Errorcode.ParameterInvaild The parameter is invalid. The error message returned because the specified parameters are invalid.

For a list of error codes, visit the API Error Center.