Queries instances.

Request parameters

Parameter Type Required Example Description
Action String Yes ListInstances

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

ListInstances.

MaxResults Integer Yes 1

The maximum number of entries to return. Valid values:

1 to 100
RegionId String Yes cn-hangzhou

The ID of the region where the instances that you want to query are deployed.

NextToken String No caeba0bbb2be03f84eb48b699f0a***

The token that marks the end position of the previous returned page. Call the operation again by using the value of the NextToken parameter returned by the previous request to obtain the next set of data. Leave this parameter empty the first time you call this operation. If all results have been returned, the value of NextToken in the response parameter is empty.

Response parameters

Parameter Type Example Description
Data Struct

The returned data.

Instances Array of InstanceVO

An array of instances.

AutoRenewInstance Boolean false

Indicates whether the instance is automatically renewed.

ClassicEndpoint String amqp-cn-st21x7kv****.not-support

The endpoint that is used to access the instance over the classic network. This parameter is deprecated.

ExpireTime Long 1

The time period after which the instance expires.

InstanceId String amqp-cn-st21x7kv****

The ID of the instance.

InstanceName String amqp-cn-st21x7kv****

The name of the instance.

InstanceType String PROFESSIONAL

The type of the instance.

MaxEipTps Integer 24832

The maximum number of Internet-based transactions per second on the instance.

MaxQueue Integer 50

The maximum number of queues in the instance.

MaxTps Integer 5000

The maximum number of virtual private cloud (VPC)-based transactions per second on the instance.

MaxVhost Integer 50

The maximum number of vhosts that can be created in the instance.

OrderCreateTime Long 1572441939000

The time when the order was created.

OrderType String PRE_PAID

The type of the order.

PrivateEndpoint String amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com

The private endpoint used to access the instance from a VPC.

PublicEndpoint String amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com

The public endpoint used to access the instance from the Internet.

Status String SERVING

The status of the instance.

StorageSize Integer 200

The size of the disk. Unit: GB.

SupportEIP Boolean true

Indicates whether the instance supports elastic IP addresses (EIPs).

MaxResults Integer 1

The maximum number of returned entries.

NextToken String caebacccb2be03f84eb48b699f0a****

The token that marks the end of the current returned page. If this parameter is empty, it indicates that you have retrieved all the data.

RequestId String CCBB1225-C392-480E-8C7F-D09AB2CD2***

The ID of the request.

Examples

Sample requests

http(s)://amqp-open.cn-hangzhou.aliyuncs.com/?Action=ListInstances
&MaxResults=1
&RegionId=cn-hangzhou
&<Common request parameters>|

Sample success responses

XML format

<ListInstancesResponse>
      <RequestId>CCBB1225-C392-480E-8C7F-D09AB2CD2***</RequestId>
      <Data>
            <Instances>
                  <Status>SERVING</Status>
                  <MaxTps>5000</MaxTps>
                  <MaxEipTps>24832</MaxEipTps>
                  <ClassicEndpoint>amqp-cn-st21x7kv****.not-support</ClassicEndpoint>
                  <InstanceId>amqp-cn-st21x7kv****</InstanceId>
                  <MaxQueue>50</MaxQueue>
                  <SupportEIP>true</SupportEIP>
                  <StorageSize>200</StorageSize>
                  <InstanceName>amqp-cn-st21x7kv****</InstanceName>
                  <OrderType>PRE_PAID</OrderType>
                  <OrderCreateTime>1572441939000</OrderCreateTime>
                  <MaxVhost>50</MaxVhost>
                  <PublicEndpoint>amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com</PublicEndpoint>
                  <InstanceType>PROFESSIONAL</InstanceType>
                  <ExpireTime>1</ExpireTime>
                  <AutoRenewInstance>false</AutoRenewInstance>
                  <PrivateEndpoint>amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com</PrivateEndpoint>
            </Instances>
            <NextToken>,</NextToken>
            <MaxResults>1</MaxResults>
      </Data>
</ListInstancesResponse>

JSON format

{
    "RequestId": "CCBB1225-C392-480E-8C7F-D09AB2CD2***",
    "Data": {
        "Instances": {
            "Status": "SERVING",
            "MaxTps": 5000,
            "MaxEipTps": 24832,
            "ClassicEndpoint": "amqp-cn-st21x7kv****.not-support",
            "InstanceId": "amqp-cn-st21x7kv****",
            "MaxQueue": 50,
            "SupportEIP": true,
            "StorageSize": 200,
            "InstanceName": "amqp-cn-st21x7kv****",
            "OrderType": "PRE_PAID",
            "OrderCreateTime": 1572441939000,
            "MaxVhost": 50,
            "PublicEndpoint": "amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com",
            "InstanceType": "PROFESSIONAL",
            "ExpireTime": 1,
            "AutoRenewInstance": false,
            "PrivateEndpoint": "amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com"
        },
        "NextToken": ",",
        "MaxResults": 1
    }
}

Error codes

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