查询指定地域下，所有的云消息队列 RocketMQ 版实例的列表信息。
接口说明
注意 阿里云提供的 OpenAPI 属于管控类 API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖 OpenAPI 实现，否则可能会导致链路产生风险。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rocketmq:ListInstances | list | *Instance acs:rocketmq:{#regionId}:{#accountId}:instance/* |
| 无 |
请求语法
GET /instances HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| filter | string | 否 | 查询的过滤条件，若不输入则查询所有实例。 | rmq-cn-7e22ody**** |
| pageNumber | integer | 否 | 分页页码，查询第几页的返回结果。 取值范围：1~100000000。 若您设置的参数值小于 1，则系统默认按照参数值为 1 处理；若您设置的参数值大于 100000000，则系统默认按照参数值为 100000000 处理。 | 1 |
| pageSize | integer | 否 | 分页大小，每页最多显示的返回结果数量。 取值范围：10~200。 若您设置的参数值小于 10，则系统默认按照参数值为 10 处理；若您设置的参数值大于 200，则系统默认按照参数值为 200 处理。 | 10 |
| resourceGroupId | string | 否 | 实例所属的资源组 ID。 | rg-acfmx7caj****** |
| tags | string | 否 | 资源标签列表，用于筛选实例。 | [{"key": "rmq-test", "value": "test"}] |
| seriesCodes | array | 否 | 实例的主系列编码。 参数取值如下：
| |
| string | 否 | 实例的主系列编码。 | standard | |
| storageSecretKey | string | 否 | 存储加密密钥 Key | xxxxx |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "84445A20-2B50-5306-A3C0-AF99FC1833C6",
"success": true,
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalCount": 100,
"list": [
{
"regionId": "cn-hangzhou",
"instanceId": "rmq-cn-7e22ody****",
"instanceName": "test instance",
"status": "RUNNING",
"startTime": "2022-08-01 00:00:00",
"expireTime": "2022-09-01 00:00:00",
"releaseTime": "2022-09-07 00:00:00",
"userId": "6W0xz2uPfiwp****",
"commodityCode": "ons_rmqsub_public_cn",
"serviceCode": "rmq",
"seriesCode": "standard",
"subSeriesCode": "cluster_ha",
"paymentType": "Subscription",
"remark": "This is remark for instance.",
"topicCount": 20,
"groupCount": 10,
"createTime": "2022-08-01 00:00:00",
"updateTime": "2022-08-02 00:00:00",
"resourceGroupId": "rg-acfmx7caj******",
"tags": [
{
"key": "key",
"value": "value"
}
],
"productInfo": {
"traceOn": true
}
}
]
},
"code": "MissingPageNumber",
"message": "Parameter pageNumber is mandatory for this action .",
"httpStatusCode": 400,
"dynamicCode": "PageNumber",
"dynamicMessage": "pageNumber"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-11-26 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2024-05-31 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2023-10-09 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-08-02 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-05-08 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2023-03-14 | API 内部配置变更，不影响调用 | 查看变更详情 |