ListInstances - 查询实例列表

更新时间: 2024-11-25 14:48:24

查询指定地域下的云消息队列 RabbitMQ 版实例列表以及各实例的基本信息,包括实例接入点、实例规格上限等信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
amqp:ListInstancelist
*全部资源
*

请求参数

名称类型必填描述示例值
NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a****
MaxResultsinteger

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

1
ResourceGroupIdstring

实例所属资源组 ID。

rg-aekzu74zjgdu4mq

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

CCBB1225-C392-480E-8C7F-D09AB2CD2***
Dataobject

数据。

NextTokenstring

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

caebacccb2be03f84eb48b699f0a****
MaxResultsinteger

最大结果集。

1
Instancesarray<object>

实例。

InstanceVOobject

实例。

Statusstring

实例状态。取值如下:

  • DEPLOYING:实例部署中

  • EXPIRED:实例已过期

  • SERVING:实例服务中

  • RELEASED:实例已被释放

SERVING
SupportEIPboolean

是否支持 EIP。

true
ExpireTimelong

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

1651507200000
OrderCreateTimelong

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

1572441939000
PrivateEndpointstring

实例的 VPC 接入点。

amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com
StorageSizeinteger

磁盘容量,单位:GB。

说明 专业版实例和企业版实例无此参数,返回**-1**。
200
MaxEipTpsinteger

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

24832
InstanceIdstring

实例 ID。

amqp-cn-st21x7kv****
InstanceTypestring

实例类型。

  • PROFESSIONAL:专业版

  • ENTERPRISE:企业版

  • VIP:铂金版

  • SERVERLESS:Serverless 版

professional
PublicEndpointstring

实例的公网接入点。

amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com
ClassicEndpointstring

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

amqp-cn-st21x7kv****.not-support
MaxVhostinteger

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

50
MaxTpsinteger

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

5000
AutoRenewInstanceboolean

是否自动更新实例。

false
InstanceNamestring

实例名称。

amqp-cn-st21x7kv****
MaxQueueinteger

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

50
OrderTypestring

订单类型。

  • PRE_PAID:预付费。
  • POST_PAID:后付费。
PRE_PAID
Tagsarray<object>

标签列表。

tagsobject

标签列表。

Keystring

标签键。

region
Valuestring

标签值。

hangzhou
ResourceGroupIdstring

资源组 ID。

rg-aek3axfj2w4czrq
EncryptedInstanceboolean

实例数据存储是否开启存储加密

false
KmsKeyIdstring

后端存储使用数据盘对应的 KMS 密钥 ID。

key-bjj66c2a893vmhawtq5fd

示例

正常返回示例

JSON格式

{
  "RequestId": "CCBB1225-C392-480E-8C7F-D09AB2CD2***",
  "Data": {
    "NextToken": "caebacccb2be03f84eb48b699f0a****",
    "MaxResults": 1,
    "Instances": [
      {
        "Status": "SERVING",
        "SupportEIP": true,
        "ExpireTime": 1651507200000,
        "OrderCreateTime": 1572441939000,
        "PrivateEndpoint": "amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com",
        "StorageSize": 200,
        "MaxEipTps": 24832,
        "InstanceId": "amqp-cn-st21x7kv****",
        "InstanceType": "professional",
        "PublicEndpoint": "amqp-cn-st21x7kv****.mq-amqp.cn-hangzhou-a.aliyuncs.com",
        "ClassicEndpoint": "amqp-cn-st21x7kv****.not-support",
        "MaxVhost": 50,
        "MaxTps": 5000,
        "AutoRenewInstance": false,
        "InstanceName": "amqp-cn-st21x7kv****",
        "MaxQueue": 50,
        "OrderType": "PRE_PAID",
        "Tags": [
          {
            "Key": "region",
            "Value": "hangzhou"
          }
        ],
        "ResourceGroupId": "rg-aek3axfj2w4czrq",
        "EncryptedInstance": false,
        "KmsKeyId": "key-bjj66c2a893vmhawtq5fd"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-11-25OpenAPI 返回结构发生变更查看变更详情
2023-11-07OpenAPI 返回结构发生变更查看变更详情
上一篇: UpdateInstanceName - 更新实例名称 下一篇: GetMetadataAmount - 获取实例的元数据