查询当前账号在指定地域(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 过滤符合条件的实例,若不输入表示查询所有实例。
| CartService |
Value | string | 否 | 资源的标签值。Key 和 Value 值必须同时输入或同时不输入。若同时输入表示根据 Tag 过滤符合条件的实例,若不输入表示查询所有实例。
| SericeA |
NeedResourceInfo | boolean | 否 | 是否需要资源统计信息。即实例下 Topic 的数量和 Group 的数量。 | true |
返回参数
示例
正常返回示例
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-22 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |