查詢指定地域下，所有的云消息隊列 RocketMQ 版實例的列表信息。
接口說明
注意 阿里云提供的 OpenAPI 屬于管控類 API，用于管理和查詢阿里云服務的相關資源。僅推薦在管控鏈路集成，消息收發的核心數據鏈路中嚴禁依賴 OpenAPI 實現，否則可能會導致鏈路產生風險。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| rocketmq:ListInstances | list | *Instance acs:rocketmq:{#regionId}:{#accountId}:instance/* |
| 無 |
請求語法
GET /instances HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| filter | string | 否 | 查詢的過濾條件，若不輸入則查詢所有實例。 | rmq-cn-7e22ody**** |
| pageNumber | integer | 否 | 分頁頁碼，查詢第幾頁的返回結果。 取值范圍：1~100000000。 若您設置的參數值小于 1，則系統默認按照參數值為 1 處理；若您設置的參數值大于 100000000，則系統默認按照參數值為 100000000 處理。 | 1 |
| pageSize | integer | 否 | 分頁大小，每頁最多顯示的返回結果數量。 取值范圍：10~200。 若您設置的參數值小于 10，則系統默認按照參數值為 10 處理；若您設置的參數值大于 200，則系統默認按照參數值為 200 處理。 | 10 |
| resourceGroupId | string | 否 | 實例所屬的資源組 ID。 | rg-acfmx7caj****** |
| tags | string | 否 | 資源標簽列表，用于篩選實例。 | [{"key": "rmq-test", "value": "test"}] |
| seriesCodes | array | 否 | 實例的主系列編碼。 參數取值如下：
| |
| string | 否 | 實例的主系列編碼。 | standard | |
| storageSecretKey | string | 否 | 存儲加密密鑰 Key | xxxxx |
返回參數
示例
正常返回示例
JSON格式
{
"requestId": "84445A20-2B50-5306-A3C0-AF99FC1833C6",
"success": true,
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalCount": 100,
"list": [
{
"regionId": "cn-hangzhou",
"instanceId": "rmq-cn-7e22ody****",
"instanceName": "test instance",
"status": "RUNNING",
"startTime": "2022-08-01 00:00:00",
"expireTime": "2022-09-01 00:00:00",
"releaseTime": "2022-09-07 00:00:00",
"userId": "6W0xz2uPfiwp****",
"commodityCode": "ons_rmqsub_public_cn",
"serviceCode": "rmq",
"seriesCode": "standard",
"subSeriesCode": "cluster_ha",
"paymentType": "Subscription",
"remark": "This is remark for instance.",
"topicCount": 20,
"groupCount": 10,
"createTime": "2022-08-01 00:00:00",
"updateTime": "2022-08-02 00:00:00",
"resourceGroupId": "rg-acfmx7caj******",
"tags": [
{
"key": "key",
"value": "value"
}
],
"productInfo": {
"traceOn": true
}
}
]
},
"code": "MissingPageNumber",
"message": "Parameter pageNumber is mandatory for this action .",
"httpStatusCode": 400,
"dynamicCode": "PageNumber",
"dynamicMessage": "pageNumber"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-11-26 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-05-31 | API 內部配置變更，不影響調用 | 查看變更詳情 |
| 2023-10-09 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-08-02 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-05-08 | API 內部配置變更，不影響調用 | 查看變更詳情 |
| 2023-03-14 | API 內部配置變更，不影響調用 | 查看變更詳情 |