查詢當前賬號在指定地域(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 返回結構發生變更 | 查看變更詳情 |