查詢指定實例下的主題列表信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
rocketmq:ListTopics | list | *Topic acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/* |
| 無 |
請求語法
GET /instances/{instanceId}/topics HTTP/1.1
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
instanceId | string | 是 | 指定需要獲取哪個實例下的主題列表。 | rmq-cn-7e22ody**** |
filter | string | 否 | 查詢的過濾條件,若不輸入則查詢該實例下所有的主題。 | topic_test |
pageNumber | integer | 否 | 分頁頁碼,查詢第幾頁的返回結果。 | 1 |
pageSize | integer | 否 | 分頁大小,每頁最多顯示的返回結果數量。 | 3 |
messageTypes | array | 否 | 主題的消息類型。 | |
string | 否 | 需要查詢實例下哪種類型的主題。若不輸入,則查詢實例下的所有主題。 參數取值如下:
| NORMAL |
返回參數
示例
正常返回示例
JSON
格式
{
"requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
"success": true,
"data": {
"pageNumber": 1,
"pageSize": 3,
"totalCount": 1,
"list": [
{
"regionId": "cn-hangzhou",
"instanceId": "rmq-cn-7e22ody****",
"topicName": "topic_test",
"messageType": "NORMAL",
"status": "RUNNING",
"remark": "This is the remark for test.",
"createTime": "2022-08-01 20:05:50",
"updateTime": "2022-08-01 20:05:50"
}
]
},
"code": "Topic.NotFound",
"message": "The topic cannot be found.",
"httpStatusCode": 400,
"dynamicCode": "TopicName",
"dynamicMessage": "topicName"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-03-28 | API 內部配置變更,不影響調用 | 查看變更詳情 |