edit-icon download-icon

DescribeHiTSDBInstanceList

Last Updated: Mar 30, 2018

Description

Queries the database to obtain the instance list.

Request parameters

Name Type Required or not Default value Description
RegionId String Yes None ID of the region in which the instance is located
StatusList String Yes [] Status filter list, in the JSON format. The enumerated value is InstanceStatus.
PageSize Integer Yes 30 Number of records per page
PageNumber Integer Yes 1 Page number
QueryStr String No None Alias key word

Response parameters

Name Type Description
PageSize Int Page size
PageNumber Int Page number
Total Int Total number of results
InstanceList List Instance list
InstanceId String Instance ID
InstanceStorage String Instance storage space, in the unit of GB
ZoneId String Instance zone ID
InstanceClass String Instance type
GmtCreated String Instance creation date
ChargeType String Instance charge type
GmtExpire String Instance expiration time
InstanceAlias String Instance alias
UserId String User ID
InstanceStatus String Instance status, enumerative
NetworkType String Instance network type, enumerative
ReverseVpcIp String Reverse VPC IP address of the instance
ReverseVpcPort String Reverse VPC port of the instance
InstanceDescription String Instance description
RegionId String ID of the region in which the instance is located
InstanceTps String Instance TPS, in the unit of <request/second>

Return example

JSON format:

{
    "code": "200",
    "data": {
        "PageSize": 100,
        "RequestId": "D1BDDC07-6DEF-4DE3-BCA0-2A9B8BB69E91",
        "PageNumber": 1,
        "Total": 2,
        "InstanceList": [
            {
                "InstanceStorage": "200",
                "ZoneId": "cn-hangzhou-e",
                "InstanceId": "hb-bp17pca5t4ristmb1",
                "InstanceClass": "hitsdb.n1.6xlarge",
                "GmtCreated": "2017-07-30 23:30:38.0",
                "ChargeType": "POSTPAY",
                "GmtExpire": "2018-07-30 23:30:38.0",
                "InstanceAlias": "fenghaotest-730-1123",
                "UserId": "1623695425786218",
                "InstanceStatus": "ACTIVATION",
                "NetworkType": "VPC",
                "ReverseVpcIp": "100.100.64.1",
                "ReverseVpcPort": "7834",
                "InstanceDescription": "",
                "RegionId": "cn-hangzhou",
                "InstanceTps": "50000"
            },
            {
                "InstanceStorage": "200",
                "ZoneId": "cn-hangzhou-e",
                "InstanceId": "hb-bp100012um014wzlw",
                "InstanceClass": "hitsdb.n1.6xlarge",
                "GmtCreated": "2017-07-30 21:12:37.0",
                "ChargeType": "POSTPAY",
                "GmtExpire": "2018-07-30 21:12:37.0",
                "InstanceAlias": "Abnormal instance-2",
                "UserId": "1623695425786218",
                "InstanceStatus": "ACTIVATION",
                "NetworkType": "VPC",
                "ReverseVpcIp": "100.100.64.1",
                "ReverseVpcPort": "7831",
                "InstanceDescription": "",
                "RegionId": "cn-hangzhou",
                "InstanceTps": "50000"
            }
        ]
    },
    "requestId": "D1BDDC07-6DEF-4DE3-BCA0-2A9B8BB69E91",
    "successResponse": true
}
Thank you! We've received your feedback.