查詢指定Queue的在線Consumer客戶端。
接口說(shuō)明
云消息隊(duì)列 RabbitMQ 版僅支持查看在線 Consumer 客戶端,不支持查看離線 Consumer 客戶端。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫(xiě)入(Write)、讀取(Read)或列出(List)。
- 資源類(lèi)型:是指操作中支持授權(quán)的資源類(lèi)型。具體說(shuō)明如下:
- 對(duì)于必選的資源類(lèi)型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類(lèi)型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
amqp:GetInstance | get |
|
|
|
請(qǐng)求參數(shù)
名稱 | 類(lèi)型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 云消息隊(duì)列 RabbitMQ 版實(shí)例的 ID。 | amqp-cn-5yd3aw****** |
VirtualHost | string | 是 | Vhost 名稱。 | test |
Queue | string | 是 | 隊(duì)列名稱。 | queue-rabbit-springboot-advance5 |
NextToken | string | 否 | 用來(lái)標(biāo)記當(dāng)前查詢結(jié)束的位置,以便下一次調(diào)用時(shí)作為參數(shù)傳入,繼續(xù)翻頁(yè)。首次調(diào)用或返回最后一頁(yè)時(shí),取值為空字符串。 | caeba0bbb2be03f84eb48b699f0a**** |
QueryCount | integer | 否 | 拉取數(shù)據(jù)的條數(shù)。如果不設(shè)置,默認(rèn)值為 1。 取值范圍:[1,100]。 | 1 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "4409B7D5-E4EC-4EB5-804A-385DCDFCD***",
"Data": {
"MaxResults": 1,
"NextToken": "caebacccb2be03f84eb48b699f0a****",
"Consumers": [
{
"ConsumerTag": "sgen-1"
}
]
}
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
500 | InternalError | The request processing has failed due to some unknown error. | 請(qǐng)求因遭遇某些未知錯(cuò)誤而失敗。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|
暫無(wú)變更歷史