使用OnsInstanceInServiceList查詢指定地區執行個體列表-雲訊息佇列 RocketMQ 版-阿里雲

查詢當前帳號在指定地區（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 過濾合格執行個體，若不輸入表示查詢所有執行個體。如果輸入該值，則取值不允許為空白字串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	CartService
Value	string	否	資源的標籤值。Key 和 Value 值必須同時輸入或同時不輸入。若同時輸入表示根據 Tag 過濾合格執行個體，若不輸入表示查詢所有執行個體。如果輸入該值，取值允許為空白字串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	SericeA
NeedResourceInfo	boolean	否	是否需要資源統計資訊。即執行個體下 Topic 的數量和 Group 的數量。	true

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	公用參數，每個請求的 ID 都是唯一的，可用於排查和定位問題。	0598E46F-DB06-40E2-AD7B-C45923EE****
Data	object
InstanceVO	array<object>	返回所有發行的執行個體資訊列表。
	array<object>	返回所有發行的執行個體資訊列表。
IndependentNaming	boolean	執行個體是否有命名空間。取值說明如下： true：擁有獨立命名空間，資源命名確保執行個體內唯一，跨執行個體之間可重名。 false：無獨立命名空間，執行個體內或者跨執行個體之間，資源命名必須全域唯一。	true
InstanceName	string	執行個體名稱。	test1
ReleaseTime	integer	鉑金版執行個體的到期時間。	1551024000000
InstanceStatus	integer	執行個體狀態。取值說明如下： 0：鉑金版執行個體部署中 2：標準版執行個體已欠費 5：標準版執行個體或鉑金版執行個體服務中 7：鉑金版執行個體升級中且服務可用	5
Tags	object
Tag	array<object>	執行個體所綁定的標籤。
	object	執行個體所綁定的標籤。
Key	string	標籤鍵。	CartService
Value	string	標籤值。	ServiceA
InstanceId	string	執行個體 ID。	MQ_INST_188077086902****_BXSuW61e
InstanceType	integer	執行個體類型。取值說明如下： 1：標準版執行個體 2：鉑金版執行個體各類型執行個體的規格和差異說明，請參見執行個體規格。	2
CreateTime	integer	執行個體的建立時間。該參數值的格式為毫秒級 Unix 時間戳記。	1640847284000
TopicCount	integer	主題數量。	1
GroupCount	integer	消費者分組數量。	3

樣本

正常返回樣本

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
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。