Description

You can call this API to retrieve details about an instance.

Request parameters

Name Type Required Description
<Common request parameters> - Yes For more information, see Common parameters.
Action String Yes Required parameter, and the value is DescribeInstanceInfo.
InstanceId String Yes The ID of the instance.

Response parameters

Name Type Description
<Common response parameters> String For more information, see Common response parameters.
InstanceId String The ID of the instance.
Instance name String The description of an instance.
RegionId String The ID of the region.
ZoneId String The ID of the zone.
InstanceStatus String The status of the instance.
NetworkInfoItems List<NetworkInfoItem> The details about the network in which the instance resides.
Databases List<Database> The details about the database.
Table 1. NetworkInfoItem
Name Type Description
NetworkType String The network type:
  • PUBLIC: a public network.
  • INTERNAL: an internal network.
  • VPC: a VPC network.
ConnectionString String The connection string.
Port String The port number.
VpcId String The ID of the VPC.
VSwitchId String The ID of the vSwitch.
PrivateIpAddress String The private IP addresses for VPC-based instances.
Table 2. Database
Name Type Description
​DBName ​String The name of the database.
​ChargeType ​String The billing method.
  • PrePaid: Subscription.
  • PostPaid: Pay-As-You-Go.

Sample requests

https://petadata.aliyuncs.com/?Action=DescribeInstanceInfo
&InstanceId=pd-xxxxxxxxxxxx
&<[Common request parameters]>

Sample responses

XML format

<DescribeInstanceInfoResponse>  
    <Databases>
        <Database>
            <ChargeType>PrePaid</ChargeType>
            <DBName>adb</DBName>
        </Database>
        <Database>
            <ChargeType>PostPaid</ChargeType>
            <DBName>testdb</DBName>
        </Database>
        <Database>
            <ChargeType>PostPaid</ChargeType>
            <DBName>testdb_01</DBName>
        </Database>
    </Databases>
    <InstanceStatus>ACTIVE</InstanceStatus>
    <RegionId>cn-hangzhou</RegionId>
    <InstanceId>pd-xxxxxxxxxxxxx</InstanceId>
    <RequestId>4BB055BD-3555-4409-9154-921B00535CB7</RequestId>
    <ZoneId>cn-hangzhou-b</ZoneId>
    <NetworkInfoItems>
        <NetworkInfoItem>
            <NetworkType>INTERNAL</NetworkType>
            <Port>3306</Port>
            <ConnectionString>pd-xxxxxxxxxxxxxx.petadata.rds.aliyuncs.com</ConnectionString>
        </NetworkInfoItem>
    </NetworkInfoItems>
    <InstanceName>Created At: 2018-05-15-15-31-37</InstanceName>
</DescribeInstanceInfoResponse>

JSON format

{
    "Databases":{
        "Database":[
            {
                "ChargeType":"PrePaid",
                "DBName":"adb"
            },
            {
                "ChargeType":"PostPaid",
                "DBName":"testdb"
            },
            {
                "ChargeType":"PostPaid",
                "DBName":"testdb_01"
            }
        ]
    },
    "InstanceStatus":"ACTIVE",
    "RegionId":"cn-hangzhou",
    "InstanceId":"pd-xxxxxxxxxxxxxx",
    "RequestId":"4BB055BD-3555-4409-9154-921B00535CB7",
    "ZoneId":"cn-hangzhou-b",
    "NetworkInfoItems":{
        "NetworkInfoItem":[
            {
                "NetworkType":"INTERNAL",
                "Port":"3306",
                "ConnectionString":"pd-xxxxxxxxxxxxxx.petadata.rds.aliyuncs.com"
            }
        ]
    },
    "InstanceName":"pd-xxxxxxxxxxxxxx"
}