调用ListInstances查询实例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListInstances

要执行的操作。取值:

ListInstances

MaxResults Integer 1

最大结果集。建议取值在1~100之间。

RegionId String cn-hangzhou

实例的地域ID。

NextToken String caeba0bbb2be03f84eb48b699f0a****

用来标记当前查询结束的位置,以便下一次调用时作为参数传入,继续翻页。首次调用或返回最后一页时,取值为空字符串。

返回数据

名称 类型 示例值 描述
Data Struct

数据。

Instances Array of InstanceVO

实例。

AutoRenewInstance Boolean false

是否自动更新实例。

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

经典接入点,该参数不再使用。

ExpireTime Long 1651507200000

过期时间戳,单位:毫秒。

InstanceId String amqp-cn-st21x7kv****

实例ID。

InstanceName String amqp-cn-st21x7kv****

实例名称。

InstanceType String professional

实例类型。

  • professional:专业版
  • enterprise:企业版
  • vip:铂金版
MaxEipTps Integer 24832

实例的公网TPS流量峰值,单位:条/秒。

MaxQueue Integer 50

实例的Queue的数量上限,单位:个。

MaxTps Integer 5000

实例的私网TPS流量峰值,单位:条/秒。

MaxVhost Integer 50

实例的Vhost的数量上限,单位:个。

OrderCreateTime Long 1572441939000

订单创建时间戳,单位:毫秒。

OrderType String PRE_PAID

订单类型。

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

VPC接入点。

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

公网接入点。

Status String SERVING

实例状态。取值如下:

  • DEPLOYING:实例部署中
  • EXPIRED:实例已过期
  • SERVING:实例服务中
  • RELEASED:实例已被释放
StorageSize Integer 200

磁盘容量,单位:GB。

说明 专业版实例和企业版实例无此参数,返回-1
SupportEIP Boolean true

是否支持EIP。

MaxResults Integer 1

最大结果集。

NextToken String caebacccb2be03f84eb48b699f0a****

表示当前调用返回读取到的位置,空代表数据已经读取完毕。

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

请求ID。

示例

请求示例

http(s)://amqp-open.cn-hangzhou.aliyuncs.com/?Action=ListInstances
&MaxResults=1
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<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>1651507200000</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格式

{
    "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": 1651507200000,
            "AutoRenewInstance": false,
            "PrivateEndpoint": "amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com"
        },
        "NextToken": "",
        "MaxResults": 1
    }
}

错误码

访问错误中心查看更多错误码。