edit-icon download-icon


Last Updated: Mar 30, 2018


Obtains instance details.

Request parameters

Name Type Required or not Description
RegionId String Yes ID of the region in which the instance is located
InstanceId String Yes Instance ID

NOTE: All the above request parameters have no default value.

Response parameters

Name Type Description
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
InstanceStatus String Instance status, enumerative
NetworkType String Instance network type, enumerative
VpcId String VPC ID
VswitchId String VSwitch ID
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>
ConnectionString String Instance connection string
PublicConnectionString String Instance public network connection string
MaxTimelineLimit String Performance of the instance time series, in the unit of <count>
SecurityIpList List List of the instance whitelist
Ip String IP address of the instance whitelist

Return example

JSON format:

    "code": "200",
    "data": {
        "InstanceStorage": "200",
        "ZoneId": "cn-shanghai-b",
        "RequestId": "B538A711-D97D-440B-9881-34A7AC151271",
        "InstanceId": "hb-bp100012um014wzlw",
        "InstanceClass": "hitsdb.n1.6xlarge",
        "GmtCreated": "2017-10-27 11:15:28.0",
        "VswitchId": "vsw-xxxxxx",
        "VpcId": "vpc-xxxxxx",
        "ChargeType": "POSTPAY",
        "GmtExpire": "2018-10-27 11:15:28.0",
        "InstanceAlias": "xxx",
        "InstanceStatus": "ACTIVATION",
        "NetworkType": "VPC",
        "ReverseVpcIp": "",
        "ReverseVpcPort": "8243",
        "MaxTimelineLimit": "1000000",
        "InstanceDescription": "",
        "RegionId": "cn-shanghai",
        "ConnectionString": "ts-uf62749flv997b74710860.hitsdb.rds.aliyuncs.com:8242",
        "InstanceTps": "50000",
        "SecurityIpList": [
                "Ip": ""
                "Ip": ""
    "requestId": "B8161286-7E9A-40DD-8C9B-A578DE77214F",
    "successResponse": true
Thank you! We've received your feedback.