Queries Time Series Database (TSDB) instances.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
PageNumber | Integer | Yes | 1 |
The number of the page to return. |
PageSize | Integer | Yes | 30 |
The number of entries to return on each page. |
RegionId | String | Yes | cn-hangzhou |
The ID of the region. |
QueryStr | String | No | test |
The keyword of the instance name. You can configure this parameter for fuzzy searches. |
StatusList | String | No | ["ACTIVATION", "DELETED"] |
The statuses of the instances to return. Specify this parameter in the JSON format. The InstanceStatus parameter enumerates the instances of the specified statuses. |
EngineType | String | No | tsdb_tsdb |
The type of the engine. Valid values: tsdb_tsdb and tsdb_influxdb. The tsdb_tsdb value specifies the OpenTSDB engine. The tsdb_influxdb value specifies the InfluxDB®️ engine. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
InstanceList | Array of Instance |
The instances returned. |
|
ChargeType | String | POSTPAY |
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. |
CreateTime | Long | 1603426323000 |
The timestamp when the instance was created. |
EngineType | String | tsdb_tsdb |
The type of the engine. Valid values: tsdb_tsdb and tsdb_influxdb. The tsdb_tsdb value indicates the OpenTSDB engine. The tsdb_influxdb value indicates the InfluxDB®️ engine. |
ExpiredTime | Long | 1611417600000 |
The timestamp when the instance expires. This parameter is returned only when the 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 expires. This parameter is returned only when the instance uses the subscription billing method. The time is in the yyyy-MM-dd HH:mm:ss format. |
InstanceAlias | String | test_tsdb |
The alias of the instance. |
InstanceClass | String | tsdb.1x.basic |
The type of the instance. |
InstanceDescription | String | test |
The description of the instance. |
InstanceId | String | ts-xxxxxxxxxxxxxxxxx |
The ID of the instance. |
InstanceStatus | String | ACTIVATION |
Enumerates the instances of the specified statuses. |
InstanceStorage | String | 50 |
The storage of the instance. Unit: GB. |
InstanceTps | String | 960000 |
The transactions per second (TPS) of the instance. |
LockMode | String | 0 |
Indicates whether the instance is locked. Valid values: 0 and 1. 0: unlocked. 1: locked. |
MaxSeriesPerDatabase | String | 10000 |
The maximum number of time series that can be stored in a database. |
NetworkType | String | VPC |
The network type of the instance. The VPC value indicates a virtual private cloud (VPC). |
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. |
RegionId | String | cn-hangzhou |
The region ID of the instance. |
Status | String | ACTIVATION |
The status of the instance. Valid values: ACTIVATION, CREATING, NET_CREATING, CLASS_CHANGING, LOCKED, and DELETED. ACTIVATION: The instance is running. CREATING: The instance is being created. NET_CREATING: A network connection is being established. CLASS_CHANGING: The configuration of the instance is being modified. LOCKED: The instance is locked. DELETED: The instance is deleted. |
UserId | String | 1000000000000000 |
The ID of the user. |
VpcId | String | vpc-bp1xxxxxxxxxxxxxxxxxx |
The ID of the VPC. |
VswitchId | String | vsw-bp1xxxxxxxxxxxxxxxxxx |
The ID of the vSwitch. |
ZoneId | String | cn-hongkong-b |
The ID of the zone in which the instance is deployed. |
PageNumber | Integer | 1 |
The page number of the returned page. |
PageSize | Integer | 20 |
The number of entries returned per page. |
RequestId | String | 0A7153E4-8354-497E-87E5-5D0EBEF5AEB1 |
The ID of the request. |
Total | Integer | 10 |
The total number of entries returned. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeHiTSDBInstanceList
&PageNumber=1
&PageSize=30
&RegionId=cn-hangzhou
&<Common request parameters>
Sample success responses
XML
format
<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
format
{
"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"
}
]
}
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.