GetInstance - 擷取指定執行個體的詳情 - ApsaraMQ for RocketMQ

擷取某個指定執行個體的詳細資料。

介面說明

重要阿里雲提供的 OpenAPI 屬於管控類 API，用於管理和查詢阿里雲服務的相關資源。僅推薦在管控鏈路整合，訊息收發的核心資料鏈路中嚴禁依賴 OpenAPI 實現，否則可能會導致鏈路產生風險。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

rocketmq:GetInstance

get

*Instance

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

無

請求文法

GET /instances/{instanceId} HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	待查詢執行個體的 ID。	rmq-cn-7e22ody****

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

返回參數

名稱	類型	描述	樣本值
	object	返回資料。
requestId	string	請求 ID，每個請求的 ID 都是唯一的，可用於排查和定位問題。	05AB7FBD-F1D3-5D87-BF78-BD782249****
success	boolean	執行結果是否成功。	true
data	object	返回結果。
regionId	string	執行個體所屬的地區 ID。	cn-hangzhou
instanceId	string	執行個體 ID。	rmq-cn-7e22ody****
instanceName	string	執行個體名稱。	test instance
status	string	執行個體狀態。參數取值如下： RELEASED：已釋放 RUNNING：運行中 STOPPED：已停服 CHANGING：變更中 CREATING：建立中枚舉值： RELEASED : 已釋放 RUNNING : 運行中 STOPPED : 已停服 CHANGING : 變更中 CREATING : 建立中	RUNNING
startTime	string	執行個體的啟動時間。	2022-08-01 00:00:00
expireTime	string	執行個體的到期時間。	2022-09-01 00:00:00
releaseTime	string	執行個體的釋放時間。	2022-09-07 00:00:00
userId	string	執行個體所屬的使用者識別碼。	111111111111111
bid	string	商品的售賣渠道 BID。	26842
commodityCode	string	訊息佇列 RocketMQ 5.x 系列執行個體的商品代號類似於 ons_rmqsub_public_cn。	ons_rmqsub_public_cn
serviceCode	string	執行個體所屬的服務編碼。訊息佇列 RocketMQ 版的服務編碼為 rmq。	rmq
seriesCode	string	執行個體的主系列編碼。主系列間的具體差異，請參見產品選型。參數取值如下： standard：標準版 ultimate：鉑金版 professional：專業版 shared: 共用版 dedicated：獨享版枚舉值： standard : 標準版 shared : 共用版 dedicated : 獨享版 ultimate : 鉑金版 professional : 專業版	standard
subSeriesCode	string	執行個體的子系列編碼。子系列間的具體差異，請參見產品選型。參數取值如下： cluster_ha：叢集高可用版 single_node：單節點版 serverless： serverless 版本枚舉值： serverless : serverless 版本 cluster_ha : 叢集高可用版 single_node : 單節點版	cluster_ha
paymentType	string	執行個體的付費類型。參數取值如下： PayAsYouGo：隨用隨付（後付費） Subscription：訂用帳戶（預付費）枚舉值： PayAsYouGo : 隨用隨付（後付費） Subscription : 訂用帳戶（預付費）	Subscription
remark	string	執行個體的備忘資訊。	This is remark for instance.
networkInfo	object	網路資訊。
vpcInfo	object	專用網路資訊。
vpcId	string	執行個體所關聯的專用網路的 ID。	vpc-uf6of9452b2pba82c****
vSwitchId `deprecated`	string	執行個體所關聯的交換器 ID。重要該欄位不推薦使用，請使用 vSwitches 欄位。此外，為了相容，該欄位目前只返回一個交換器。	vsw-uf6gwtbn6etadpvz7****
vSwitches	array<object>	交換器列表
	object
vSwitchId	string	交換器 ID	vsw-uf6gwtbn6etadpvz7****
zoneId	string	可用性區域 ID	cn-hangzhou
securityGroupIds	string	安全性群組 ID。	sg-hp35r2hc3a3sv8q2sb16
endpoints	array<object>	存取點資訊。
	object	存取點資訊。
endpointType	string	表示執行個體的存取點類型。枚舉值： TCP_VPC : VPC 存取點 TCP_INTERNET : 公網存取點	TCP_INTERNET
endpointUrl	string	執行個體的存取點。	rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080
ipWhitelist	array	公網訪問 IP 白名單。僅公網存取點支援配置 IP 白名單，VPC 存取點暫不支援。若不配置 IP 白名單，則預設放通所有 IP 位址段通過公網訪問訊息佇列 RocketMQ 版服務端。若配置 IP 白名單，則僅允許白名單內的 IP 位址通過公網訪問訊息佇列 RocketMQ 版服務端。該欄位不再推薦使用，請使用 internetInfo.ipWhitelist 欄位。	192.168.x.x/24
	string	公網訪問 IP 白名單。	192.168.x.x/24
endpointId	string	關聯的 pvl ep 執行個體	ep-bpxxx
internetInfo	object	執行個體公網資訊。
internetSpec	string	是否開通公網訪問。參數取值如下： enable：開啟公網訪問 disable：關閉公網訪問執行個體預設支援 VPC 訪問方式，若開啟公網訪問，訊息佇列 RocketMQ 版會收取公網下行頻寬費用。具體計費資訊，請參見公網訪問費用。枚舉值： enable : 開啟公網訪問 disable : 關閉公網訪問	enable
flowOutType	string	公網計費類型。參數取值如下： payByBandwidth：固定頻寬計費，開啟公網訪問時，設定為該參數值。 uninvolved：不涉及，未開啟公網訪問時，設定為該參數值。枚舉值： payByBandwidth : 固定頻寬計費 uninvolved : 不涉及	payByBandwidth
flowOutBandwidth	integer	公網頻寬規格。單位：1 Mb/s。	1
ipWhitelist	array	公網訪問 IP 白名單列表。若不配置 IP 白名單，則預設放通所有 IP 位址段通過公網訪問訊息佇列 RocketMQ 版服務端。若配置 IP 白名單，則僅允許白名單內的 IP 位址通過公網訪問訊息佇列 RocketMQ 版服務端。
	string	公網訪問 IP 白名單。	192.168.x.x/24
accountInfo	object	帳號資訊。
username	string	執行個體的使用者名稱。使用公網訪問時，SDK 代碼中需要配置執行個體的使用者名稱和密碼，進行身分識別驗證。	6W0xz2uPfiwp****
instanceQuotas	array<object>	容量資訊。
	object	容量資訊。
quotaName	string	執行個體的配額名稱。參數取值如下： TOPIC_COUNT：執行個體的 Topic 建立額度枚舉值： TOPIC_COUNT : 執行個體的 Topic 建立額度	TOPIC_COUNT
usedCount	number	已使用量。單位：個。	10
freeCount	number	免費額度。單位：個。	20
totalCount	number	總配額。單位：個。	100
createTime	string	執行個體的建立時間。	2022-08-01 00:00:00
updateTime	string	執行個體最後的修改時間。	2022-08-02 00:00:00
extConfig `deprecated`	object	擴充配置。該欄位不再推薦使用，請使用 productInfo、internetInfo、aclInfo 等欄位替代。
aclType	string	執行個體的鑒權類型。參數取值如下： default：智能身份識別枚舉值： default : 智能身份識別	default
sendReceiveRatio	number	訊息發送和接收的比例。	0.5
autoScaling	boolean	是否開啟規格外突發彈效能力。參數取值如下： true：開啟彈效能力 false：不開啟彈效能力僅當 supportAutoScaling 參數值為 enable，即執行個體支援開啟彈效能力，該參數才有效。枚舉值： true : 開啟彈效能力 false : 不開啟彈效能力	true
messageRetentionTime	integer	訊息儲存時間長度。單位：小時。取值範圍，請參見使用限制>資源配額>訊息儲存時間長度的限制值。訊息佇列 RocketMQ 版的訊息儲存完全實現 Serverless 彈性，按照實際儲存空間收取費用，您可以通過調整訊息儲存時間長度來控制訊息的儲存容量。更多資訊，請參見儲存費用。	72
supportAutoScaling	boolean	執行個體是否支援開啟規格外突發彈效能力。參數取值如下： true：支援開啟彈效能力 false：不支援開啟彈效能力開啟彈性突發能力後，訊息佇列 RocketMQ 允許該執行個體在一定範圍內超過基礎規格限制的 TPS，且超過基礎規格外的部分，需要收取額外的彈性規格費用。具體計費資訊，請參見計算能力費用。說明僅部分規格的執行個體支援開啟彈性突發規格能力，具體支援的執行個體，請參見執行個體規格。枚舉值： true : 支援開啟彈效能力 false : 不支援開啟彈效能力	true
internetSpec	string	是否開通公網訪問。參數取值如下： enable：開通公網訪問 disable：關閉公網訪問執行個體預設支援 VPC 訪問方式，若開啟公網訪問，訊息佇列 RocketMQ 版會收取公網下行頻寬費用。具體計費資訊，請參見公網訪問費用。枚舉值： enable : 開通公網訪問 disable : 關閉公網訪問	enable
flowOutType	string	公網計費類型。參數取值如下： payByTraffic：按流量計費 payByBandwidth：按頻寬計費 uninvolved：不涉及枚舉值： payByTraffic : 按流量計費 payByBandwidth : 按頻寬計費 uninvolved : 不涉及	payByBandwidth
flowOutBandwidth	integer	公網頻寬規格。單位：Mb/s。	10
msgProcessSpec	string	訊息收發計算規格。具體訊息收發 TPS 上限，請參見執行個體規格。	rmq.s2.2xlarge
resourceGroupId	string	資源群組 ID。	rg-acfm3tmjruyribi
productInfo	object	執行個體的擴充配置。
msgProcessSpec	string	訊息收發計算規格。具體訊息收發 TPS 上限，請參見執行個體規格。	rmq.s2.2xlarge
sendReceiveRatio	number	訊息發送和接收的比例。	0.5
autoScaling	boolean	是否開啟規格外突發彈效能力。參數取值如下： true：支援開啟彈效能力 false：不支援開啟彈效能力僅當 supportAutoScaling 參數值為 enable，即執行個體支援開啟彈效能力，該參數才有效。枚舉值： true : 開啟彈效能力 false : 不開啟彈效能力	true
messageRetentionTime	integer	訊息儲存時間長度。單位：小時。取值範圍，請參見使用限制>資源配額>訊息儲存時間長度的限制值。訊息佇列 RocketMQ 版的訊息儲存完全實現 Serverless 彈性，按照實際儲存空間收取費用，您可以通過調整訊息儲存時間長度來控制訊息的儲存容量。更多資訊，請參見儲存費用。	72
supportAutoScaling	boolean	是否支援開啟規格外突發彈效能力。參數取值如下： true：支援開啟彈效能力 false：不支援開啟彈效能力開啟彈性突發能力後，訊息佇列 RocketMQ 允許該執行個體在一定範圍內超過基礎規格限制的 TPS，且超過基礎規格外的部分，需要收取額外的彈性規格費用。具體計費資訊，請參見計算能力費用。說明僅部分規格的執行個體支援開啟彈性突發規格能力，具體支援的執行個體，請參見執行個體規格。枚舉值： true : 支援開啟彈效能力 false : 不支援開啟彈效能力	true
traceOn	boolean	是否開啟訊息軌跡功能。 true：開啟訊息軌跡功能 false：關閉訊息軌跡功能該參數暫不生效，不管參數是否開啟，執行個體都預設支援軌跡功能。	true
storageEncryption	boolean	是否開啟儲存加密	false
storageSecretKey	string	儲存加密金鑰 Key	xxxxx
capacityType	string	容量模式: provisioned：預留+彈性 ondemand：隨用隨付枚舉值： provisioned : 預留+彈性 ondemand : 隨用隨付	provisioned
provisionedCapacity	integer	預留容量	3000
aclInfo	object	存取控制資訊。
aclTypes	array	執行個體的鑒權類型列表。
	string	執行個體的鑒權類型。枚舉值： default : 智能身份識別 apache_acl : ACL 身份識別	default
defaultVpcAuthFree	boolean	內網免身份識別開關。枚舉值： true : 開啟 false : 關閉	true
aclType `deprecated`	string	執行個體的鑒權類型。已廢棄，推薦使用 aclTypes 欄位枚舉值： default : 智能身份識別 apache_acl : ACL 身份識別	default
software	object	執行個體軟體資訊。
softwareVersion	string	軟體版本。	5.0-rmq-20230619-1
maintainTime	string	升級時間段。	02:00-06:00
upgradeMethod	string	升級方式。參數取值如下 auto：自動升級 manual：手動升級枚舉值： auto : 自動升級 maunal : 手動升級	auto
topicCount	integer	主題數量。	10
groupCount	integer	消費組數量。	10
tags	array<object>	資源標籤列表。
	object	資源標籤。
key	string	資源標籤 key 值。	key
value	string	資源標籤 value 值。	value
code	string	錯誤碼。	MissingInstanceId
message	string	錯誤資訊。	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	HTTP 狀態代碼。	400
dynamicCode	string	動態錯誤碼。	InstanceId
dynamicMessage	string	動態錯誤資訊。	instanceId

樣本

正常返回樣本

JSON格式

{
  "requestId": "05AB7FBD-F1D3-5D87-BF78-BD782249****",
  "success": true,
  "data": {
    "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": "111111111111111",
    "bid": "26842",
    "commodityCode": "ons_rmqsub_public_cn",
    "serviceCode": "rmq",
    "seriesCode": "standard",
    "subSeriesCode": "cluster_ha",
    "paymentType": "Subscription",
    "remark": "This is remark for instance.",
    "networkInfo": {
      "vpcInfo": {
        "vpcId": "vpc-uf6of9452b2pba82c****",
        "vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
        "vSwitches": [
          {
            "vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
            "zoneId": "cn-hangzhou"
          }
        ],
        "securityGroupIds": "sg-hp35r2hc3a3sv8q2sb16"
      },
      "endpoints": [
        {
          "endpointType": "TCP_INTERNET",
          "endpointUrl": "rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080",
          "ipWhitelist": [
            "192.168.x.x/24"
          ],
          "endpointId": "ep-bpxxx"
        }
      ],
      "internetInfo": {
        "internetSpec": "enable",
        "flowOutType": "payByBandwidth",
        "flowOutBandwidth": 1,
        "ipWhitelist": [
          "192.168.x.x/24"
        ]
      }
    },
    "accountInfo": {
      "username": "6W0xz2uPfiwp****"
    },
    "instanceQuotas": [
      {
        "quotaName": "TOPIC_COUNT",
        "usedCount": 10,
        "freeCount": 20,
        "totalCount": 100
      }
    ],
    "createTime": "2022-08-01 00:00:00 ",
    "updateTime": "2022-08-02 00:00:00 ",
    "extConfig": {
      "aclType": "default",
      "sendReceiveRatio": 0.5,
      "autoScaling": true,
      "messageRetentionTime": 72,
      "supportAutoScaling": true,
      "internetSpec": "enable",
      "flowOutType": "payByBandwidth",
      "flowOutBandwidth": 10,
      "msgProcessSpec": "rmq.s2.2xlarge"
    },
    "resourceGroupId": "rg-acfm3tmjruyribi",
    "productInfo": {
      "msgProcessSpec": "rmq.s2.2xlarge",
      "sendReceiveRatio": 0.5,
      "autoScaling": true,
      "messageRetentionTime": 72,
      "supportAutoScaling": true,
      "traceOn": true,
      "storageEncryption": false,
      "storageSecretKey": "xxxxx",
      "capacityType": "provisioned",
      "provisionedCapacity": 3000
    },
    "aclInfo": {
      "aclTypes": [
        "default"
      ],
      "defaultVpcAuthFree": true,
      "aclType": "default"
    },
    "software": {
      "softwareVersion": "5.0-rmq-20230619-1",
      "maintainTime": "02:00-06:00",
      "upgradeMethod": "auto"
    },
    "topicCount": 10,
    "groupCount": 10,
    "tags": [
      {
        "key": "key",
        "value": "value"
      }
    ]
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

錯誤碼

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

變更歷史

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