查询指定Queue的在线Consumer客户端。
接口说明
云消息队列 RabbitMQ 版仅支持查看在线 Consumer 客户端,不支持查看离线 Consumer 客户端。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
amqp:GetInstance | get |
|
|
|
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 云消息队列 RabbitMQ 版实例的 ID。 | amqp-cn-5yd3aw****** |
VirtualHost | string | 是 | Vhost 名称。 | test |
Queue | string | 是 | 队列名称。 | queue-rabbit-springboot-advance5 |
NextToken | string | 否 | 用来标记当前查询结束的位置,以便下一次调用时作为参数传入,继续翻页。首次调用或返回最后一页时,取值为空字符串。 | caeba0bbb2be03f84eb48b699f0a**** |
QueryCount | integer | 否 | 拉取数据的条数。如果不设置,默认值为 1。 取值范围:[1,100]。 | 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "4409B7D5-E4EC-4EB5-804A-385DCDFCD***",
"Data": {
"MaxResults": 1,
"NextToken": "caebacccb2be03f84eb48b699f0a****",
"Consumers": [
{
"ConsumerTag": "sgen-1"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError | The request processing has failed due to some unknown error. | 请求因遭遇某些未知错误而失败。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史