全部產品
Search

搜尋本產品

    ApsaraMQ for RocketMQ：OnsInstanceBaseInfo - 查詢執行個體基本資料和收發訊息的存取點

    文件中心

    ApsaraMQ for RocketMQ：OnsInstanceBaseInfo - 查詢執行個體基本資料和收發訊息的存取點

    更新時間：Jan 06, 2026

    調用OnsInstanceBaseInfo介面查詢執行個體基本資料和收發訊息的存取點。

    介面說明

    重要 阿里雲提供的 OpenAPI 屬於管控類 API，用於管理和查詢阿里雲服務的相關資源。僅推薦在管控鏈路整合，訊息收發的核心資料鏈路中嚴禁依賴 OpenAPI 實現，否則可能會導致鏈路產生風險。
    用戶端需要通過存取點接入雲訊息佇列 RocketMQ 版完成訊息的收發，可通過調用本介面查詢執行個體存取點。

    調試

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

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    mq:QueryInstanceBaseInfo

    get

    *Instance

    acs:mq:{#regionId}:{#accountId}:{#InstanceId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    InstanceId

    string

    是

    需查詢執行個體的 ID。

    MQ_INST_138015630679****_BAAy1Hac

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    InstanceBaseInfo

    object

    執行個體資訊對象。

    Endpoints

    object

    各個協議的存取點。

    TcpEndpoint

    string

    TCP 協議內網存取點。

    http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080
    TcpInternetEndpoint

    string

    TCP 協議公網存取點。

    • 僅西南１（成都）、華北 1（青島）或華南 1（深圳）地區的執行個體支援 TCP 協議公網存取點。

    • 若您需要使用 TCP 協議公網存取點，您需要將用戶端 SDK 升級至對應版本：

    • 使用 TCP 協議公網存取點需要收取公網流量費用。具體計費資訊，請參見公網流量費用。

    http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80
    HttpInternetEndpoint

    string

    HTTP 協議公網存取點。

    http://138015630679****.mqrest.cn-chengdu.aliyuncs.com
    HttpInternalEndpoint

    string

    HTTP 協議內網存取點。

    http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com
    HttpInternetSecureEndpoint

    string

    HTTPS 協議公網存取點。

    https://138015630679****.mqrest.cn-chengdu.aliyuncs.com
    IndependentNaming

    boolean

    執行個體是否有命名空間。取值說明如下：

    • true：擁有獨立命名空間，資源命名確保執行個體內唯一，跨執行個體之間可重名。

    • false：無獨立命名空間，執行個體內或者跨執行個體之間，資源命名必須全域唯一。

    true
    MaxTps

    integer

    訊息收發 TPS 上限。取值如下： 5000、10000、20000、50000、100000、200000、300000、500000、800000、1000000。

    詳細的解釋以購買頁的說明為準。

    說明

    該參數僅適用於雲訊息佇列 RocketMQ 版鉑金版執行個體。

    10000
    Remark

    string

    備忘。

    ons-cn-m7r1r5f****
    InstanceName

    string

    執行個體名稱。

    長度限制為 3～64 個字元，可以是中文、英文、數字、短劃線（-）以及底線（_）。

    test
    ReleaseTime

    integer

    鉑金版執行個體到期時間。

    1603555200000
    TopicCapacity

    integer

    該執行個體下允許建立的 Topic 數量上限。取值如下： 25、50、100、300、500。

    說明

    該參數僅適用於雲訊息佇列 RocketMQ 版鉑金版執行個體。

    50
    InstanceStatus

    integer

    執行個體狀態。取值說明如下：

    • 0：鉑金版執行個體部署中

    • 2：標準版執行個體已欠費

    • 5：標準版執行個體或鉑金版執行個體服務中

    • 7：鉑金版執行個體升級中且服務可用

    5
    InstanceId

    string

    執行個體 ID。

    MQ_INST_138015630679****_BAAy1Hac
    InstanceType

    integer

    執行個體類型。取值說明如下：

    • 1：標準版（後付費）執行個體

    • 2：鉑金版（訂用帳戶）執行個體

    雲訊息佇列 RocketMQ 版的執行個體類型和規格資訊，請參見執行個體規格。

    2
    CreateTime

    string

    執行個體的建立時間。 該參數值的格式為毫秒級 Unix 時間戳記。

    1570701259403
    spInstanceId

    string

    執行個體的商品售賣 ID。

    ons-cn-m7r1r5f****
    spInstanceType

    integer

    執行個體的售賣類型。

    枚舉值：

    • 1 :

      標準版（後付費）執行個體

    • 2 :

      鉑金版（訂用帳戶）執行個體

    1
    SupportClassic

    integer

    2
    RequestId

    string

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

    6CC46974-65E8-4C20-AB07-D20D102E****

    樣本

    正常返回樣本

    JSON格式

    {
  "InstanceBaseInfo": {
    "Endpoints": {
      "TcpEndpoint": "http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080",
      "TcpInternetEndpoint": "http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80",
      "HttpInternetEndpoint": "http://138015630679****.mqrest.cn-chengdu.aliyuncs.com",
      "HttpInternalEndpoint": "http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com",
      "HttpInternetSecureEndpoint": "https://138015630679****.mqrest.cn-chengdu.aliyuncs.com"
    },
    "IndependentNaming": true,
    "MaxTps": 10000,
    "Remark": "ons-cn-m7r1r5f****",
    "InstanceName": "test",
    "ReleaseTime": 1603555200000,
    "TopicCapacity": 50,
    "InstanceStatus": 5,
    "InstanceId": "MQ_INST_138015630679****_BAAy1Hac",
    "InstanceType": 2,
    "CreateTime": "1570701259403",
    "spInstanceId": "ons-cn-m7r1r5f****",
    "spInstanceType": 1,
    "SupportClassic": 2
  },
  "RequestId": "6CC46974-65E8-4C20-AB07-D20D102E****"
}

    錯誤碼

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

    變更歷史

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