查詢指定實例下所有的Group ID信息。
接口說明
注意 阿里云提供的 OpenAPI 屬于管控類 API，用于管理和查詢阿里云服務的相關資源。僅推薦在管控鏈路集成，消息收發的核心數據鏈路中嚴禁依賴 OpenAPI 實現，否則可能會導致鏈路產生風險。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| mq:ListGroup | list | *Group acs:mq:{#regionId}:{#accountId}:{#InstanceId} |
|
|
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 需獲取資源列表的 Group ID 所對應的實例 ID。 | MQ_INST_111111111111_DOxxxxxx |
| GroupId | string | 否 | 模糊查詢指定 Group ID 時設置，否則查詢所有 Group ID。 如果輸入 GID_ABC 查詢，那么會以前后綴匹配的方式進行模糊查詢，返回所有包含*GID_ABC*的 Group ID，例如 GID_test_GID_ABC_123、GID_ABC_356。 | GID_test_group_id |
| GroupType | string | 否 | 查詢的 Group ID 適用的協議。TCP 協議和 HTTP 協議的 Group ID 不可以共用，需要分別創建。取值說明如下：
| tcp |
| Tag | array<object> | 否 | Group ID 所綁定的標簽列表。列表元素個數不得超過 20。 | |
| object | 否 | |||
| Key | string | 是 | Group ID 的標簽鍵。Key 和 Value 值必須同時輸入或同時不輸入。若同時輸入表示根據 Tag 過濾符合條件的 Group ID，若不輸入表示查詢所有 Group ID。
| CartService |
| Value | string | 是 | Group ID 的標簽值。Key 和 Value 值必須同時輸入或同時不輸入。若同時輸入表示根據 Tag 過濾符合條件的 Group ID，若不輸入表示查詢所有 Group ID。
| ServiceA |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "16996623-AC4A-43AF-9248-FD9D2D75****",
"Data": {
"SubscribeInfoDo": [
{
"Owner": "138015630679****",
"UpdateTime": 1570700979000,
"IndependentNaming": true,
"GroupId": "GID_test_group_id",
"Remark": "test",
"CreateTime": 1568896605000,
"Tags": {
"Tag": [
{
"Key": "CartService",
"Value": "ServiceA"
}
]
},
"InstanceId": "MQ_INST_111111111111_DOxxxxxx",
"GroupType": "tcp"
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史