全部產品
Search
文件中心

ApsaraMQ for RocketMQ:OnsRegionList - 擷取地區資訊列表

更新時間:Dec 12, 2025

調用OnsRegionList擷取雲訊息佇列 RocketMQ 版目前開放服務的地區(Region)資訊列表。

介面說明

重要 阿里雲提供的 OpenAPI 屬於管控類 API,用於管理和查詢阿里雲服務的相關資源。僅推薦在管控鏈路整合,訊息收發的核心資料鏈路中嚴禁依賴 OpenAPI 實現,否則可能會導致鏈路產生風險。
在您使用 SDK 接入雲訊息佇列 RocketMQ 版服務並進行管控操作時,需要依次指定兩個地區的資訊,第二個地區的資訊才是通過 OnsRegionList 介面擷取。具體情境如下:

  • 將您的應用接入雲訊息佇列 RocketMQ 版服務:根據您的應用的部署地區選擇就近的 API Gateway存取點,填寫相應的 regionId。該 regionId 實際上只用於接入阿里雲 OpenAPI Gateway,因為雲訊息佇列 RocketMQ 版通過阿里雲 OpenAPI 平台(即 POP)來提供 API 服務。

  • 串連要進行管控操作的地區:指定您要對哪個地區的雲訊息佇列 RocketMQ 版資源進行操作,填寫該地區相應的 ID。此時要填寫的地區 ID,可通過 OnsRegionList 介面擷取。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

公用參數,每個請求的 ID 都是唯一的,可用於排查和定位問題。

72D14A84-45E5-4E01-A6DB-F63C4721****

Data

object

RegionDo

array<object>

查詢結果。

object

UpdateTime

integer

更新時間。

1411623866000

RegionName

string

地區名稱。

華東1(杭州)

ChannelName

string

渠道名稱。

ALIYUN

CreateTime

integer

建立時間。

1411623866000

Id

integer

ID。

1

OnsRegionId

string

地區的 ID。

cn-hangzhou

樣本

正常返回樣本

JSON格式

{
  "RequestId": "72D14A84-45E5-4E01-A6DB-F63C4721****",
  "Data": {
    "RegionDo": [
      {
        "UpdateTime": 1411623866000,
        "RegionName": "華東1(杭州)",
        "ChannelName": "ALIYUN",
        "CreateTime": 1411623866000,
        "Id": 1,
        "OnsRegionId": "cn-hangzhou"
      }
    ]
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情