找不到 API ? 点击 反馈吧
- 实例
- 主题
- 消费者分组
- 订阅关系
- 消费
- 消息
- 轨迹
- ACL
- Global Replicator
- 标签
- 资源组
- 其他
ListInstances
查询指定地域下,所有的云消息队列 RocketMQ 版实例的列表信息
服务地址:
华东1 金融云
参数配置
高级配置
输入参数
只看必填
注意事项
filter查询的过滤条件
pageNumber分页页码
pageSize分页大小
resourceGroupId实例所属的资源组ID
tags资源标签列表
seriesCodes实例的主系列编码
storageSecretKey存储加密密钥Key
文档
调用结果
SDK 示例
CLI示例
相关示例
调用历史
错误码
流控
插件下载了解更多
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
接口说明
注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。
请求语法
GET /instances HTTP/1.1
请求参数
字段名称 | 字段详情 |
---|---|
filterstring | 查询的过滤条件,若不输入则查询所有实例。 示例值:rmq-cn-7e22ody**** |
pageNumberinteger<int32> | 分页页码,查询第几页的返回结果。展开详情 示例值:1取值 <= 100000000 |
pageSizeinteger<int32> | 分页大小,每页最多显示的返回结果数量。展开详情 示例值:10取值 <= 200 |
resourceGroupIdstring | 实例所属的资源组 ID。 示例值:rg-acfmx7caj****** |
tagsstring | 资源标签列表,用于筛选实例。 示例值:[{"key": "rmq-test", "value": "test"}] |
seriesCodesarray<string> | 实例的主系列编码。展开详情 |
storageSecretKeystring | 存储加密密钥 Key 示例值:xxxxx |
返回参数
字段名称 | 字段详情 |
---|---|
requestIdstring | 请求 ID,每个请求的 ID 都是唯一的,可用于排查和定位问题。 示例值:84445A20-2B50-5306-A3C0-AF99FC1833C6 |
successboolean | 执行结果是否成功。 示例值:true |
dataobject | 返回结果。 |
codestring | 错误码。 示例值:MissingPageNumber |
messagestring | 错误信息。 示例值:Parameter pageNumber is mandatory for this action . |
httpStatusCodeinteger<int32> | HTTP 状态码。 示例值:400 |
dynamicCodestring | 动态错误码。 示例值:PageNumber |
dynamicMessagestring | 动态错误信息。 示例值:pageNumber |
变更历史
变更时间 | 变更内容概要 | 操作 | |
---|---|---|---|
2024-11-26 | 新增请求参数storageSecretKey | ||
2024-05-31 | 变更请求参数pageNumber 变更请求参数pageSize | ||
2023-10-09 | 变更返回参数 | ||
2023-08-02 | 新增请求参数tags 变更返回参数 | ||
2023-05-08 | 变更请求参数pageNumber 变更请求参数pageSize | ||
2023-03-14 | 变更请求参数pageNumber 变更请求参数pageSize |