使用OnsInstanceInServiceList查询指定地域实例列表-云消息队列 RocketMQ 版-阿里云-云消息队列 RocketMQ 版(RocketMQ)-阿里云帮助中心

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

接口说明

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mq:QueryInstanceBaseInfo

list

Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

无

请求参数

名称	类型	必填	描述	示例值
Tag	array<object>	否	实例所绑定的标签列表。列表元素个数不得超过 20。
	object	否	实例所绑定的标签。
Key	string	否	实例的标签键。Key 和 Value 值必须同时输入或同时不输入。若同时输入表示根据 Tag 过滤符合条件的实例，若不输入表示查询所有实例。如果输入该值，则取值不允许为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	CartService
Value	string	否	资源的标签值。Key 和 Value 值必须同时输入或同时不输入。若同时输入表示根据 Tag 过滤符合条件的实例，若不输入表示查询所有实例。如果输入该值，取值允许为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	SericeA
NeedResourceInfo	boolean	否	是否需要资源统计信息。即实例下 Topic 的数量和 Group 的数量。	true

返回参数

名称	类型	描述	示例值
	object
RequestId	string	公共参数，每个请求的 ID 都是唯一的，可用于排查和定位问题。	0598E46F-DB06-40E2-AD7B-C45923EE****
Data	object
InstanceVO	array<object>	返回所有已发布的实例信息列表。
	array<object>	返回所有已发布的实例信息列表。
IndependentNaming	boolean	实例是否有命名空间。取值说明如下： true：拥有独立命名空间，资源命名确保实例内唯一，跨实例之间可重名。 false：无独立命名空间，实例内或者跨实例之间，资源命名必须全局唯一。	true
InstanceName	string	实例名称。	test1
ReleaseTime	integer	铂金版实例的过期时间。	1551024000000
InstanceStatus	integer	实例状态。取值说明如下： 0：铂金版实例部署中 2：标准版实例已欠费 5：标准版实例或铂金版实例服务中 7：铂金版实例升级中且服务可用	5
Tags	object
Tag	array<object>	实例所绑定的标签。
	object	实例所绑定的标签。
Key	string	标签键。	CartService
Value	string	标签值。	ServiceA
InstanceId	string	实例 ID。	MQ_INST_188077086902****_BXSuW61e
InstanceType	integer	实例类型。取值说明如下： 1：标准版实例 2：铂金版实例各类型实例的规格和差异说明，请参见实例规格。	2
CreateTime	integer	实例的创建时间。该参数值的格式为毫秒级 Unix 时间戳。	1640847284000
TopicCount	integer	主题数量。	1
GroupCount	integer	消费者分组数量。	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
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。