文档

OnsInstanceInServiceList - 查询指定地域下实例列表

更新时间:
一键部署

查询当前账号在指定地域(Region)下所有的云消息队列 RocketMQ 版4.x实例信息。

接口说明

注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Tagobject []

实例所绑定的标签列表。列表元素个数不得超过 20。

Keystring

实例的标签键。KeyValue 值必须同时输入或同时不输入。若同时输入表示根据 Tag 过滤符合条件的实例,若不输入表示查询所有实例。

  • 如果输入该值,则取值不允许为空字符串。
  • 最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://
CartService
Valuestring

资源的标签值。KeyValue 值必须同时输入或同时不输入。若同时输入表示根据 Tag 过滤符合条件的实例,若不输入表示查询所有实例。

  • 如果输入该值,取值允许为空字符串。
  • 最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://
SericeA
NeedResourceInfoboolean

是否需要资源统计信息。即实例下 Topic 的数量和 Group 的数量。

true

返回参数

名称类型描述示例值
object
RequestIdstring

公共参数,每个请求的 ID 都是唯一的,可用于排查和定位问题。

0598E46F-DB06-40E2-AD7B-C45923EE****
Dataobject []

返回所有已发布的实例信息列表。

IndependentNamingboolean

实例是否有命名空间。取值说明如下:

  • true:拥有独立命名空间,资源命名确保实例内唯一,跨实例之间可重名。

  • false:无独立命名空间,实例内或者跨实例之间,资源命名必须全局唯一。

true
InstanceNamestring

实例名称。

test1
ReleaseTimelong

铂金版实例的过期时间。

1551024000000
InstanceStatusinteger

实例状态。取值说明如下:

  • 0:铂金版实例部署中

  • 2:标准版实例已欠费

  • 5:标准版实例或铂金版实例服务中

  • 7:铂金版实例升级中且服务可用

5
Tagsobject []

实例所绑定的标签。

Keystring

标签键。

CartService
Valuestring

标签值。

ServiceA
InstanceIdstring

实例 ID。

MQ_INST_188077086902****_BXSuW61e
InstanceTypeinteger

实例类型。取值说明如下:

  • 1:标准版实例

  • 2:铂金版实例

各类型实例的规格和差异说明,请参见实例规格

2
CreateTimelong

实例的创建时间。 该参数值的格式为毫秒级 Unix 时间戳。

1640847284000
TopicCountinteger

主题数量。

1
GroupCountinteger

消费者分组数量。

3

示例

正常返回示例

JSON格式

{
  "RequestId": "0598E46F-DB06-40E2-AD7B-C45923EE****",
  "Data": {
    "InstanceVO": [
      {
        "IndependentNaming": true,
        "InstanceName": "test1",
        "ReleaseTime": 1551024000000,
        "InstanceStatus": 5,
        "Tags": {
          "Tag": [
            {
              "Key": "CartService",
              "Value": "ServiceA"
            }
          ]
        },
        "InstanceId": "MQ_INST_188077086902****_BXSuW61e",
        "InstanceType": 2,
        "CreateTime": 1640847284000,
        "TopicCount": 1,
        "GroupCount": 3
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-22OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:NeedResourceInfo
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈