UpdateInstance - 更新執行個體 - ApsaraMQ for RocketMQ

更新雲訊息佇列 RocketMQ 版執行個體的基本資料和規格配置。

介面說明

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

rocketmq:UpdateInstance

update

*Instance

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

無

請求文法

PATCH /instances/{instanceId} HTTP/1.1

路徑參數

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

請求參數

名稱	類型	必填	描述	樣本值
body	object	否	請求體結構。
instanceName	string	否	更新後的執行個體名稱。	test_instance
remark	string	否	更新後的執行個體備忘資訊。	This is the remark for test.
networkInfo	object	否	更新後的執行個體網路資訊。
internetInfo	object	否	公網資訊，僅當執行個體開通公網訪問功能時，該參數有效。
ipWhitelist	array	否	公網訪問 IP 白名單列表。若不配置 IP 白名單，則預設放通所有 IP 位址段通過公網訪問雲訊息佇列 RocketMQ 版服務端。若配置 IP 白名單，則僅允許白名單內的 IP 位址通過公網訪問雲訊息佇列 RocketMQ 版服務端。
	string	否	公網訪問 IP 白名單。	192.168.x.x/24
productInfo	object	否	執行個體的擴充配置。
sendReceiveRatio	number	否	訊息發送和接收的比例。取值範圍：[0.25，1]	0.5
autoScaling	boolean	否	是否開啟規格外突發彈效能力。參數取值如下： true：開啟彈性 false：關閉彈性開啟彈性突發能力後，雲訊息佇列 RocketMQ 版允許該執行個體在一定範圍內超過基礎規格限制的 TPS，且超過基礎規格外的部分，需要收取額外的彈性規格費用。具體計費資訊，請參見計算能力費用。說明僅部分規格的執行個體支援開啟彈性突發規格能力，具體支援的執行個體，請參見執行個體規格。枚舉值： true : 開啟彈性 false : 關閉彈性	true
messageRetentionTime	integer	否	訊息儲存時間長度。單位：小時。取值範圍，請參見使用限制>資源配額>訊息儲存時間長度的限制值。雲訊息佇列 RocketMQ 版的訊息儲存完全實現 Serverless 彈性，按照實際儲存空間收取費用，您可以通過調整訊息儲存時間長度來控制訊息的儲存容量。更多資訊，請參見儲存費用。	72
traceOn	boolean	否	是否開啟訊息軌跡功能。 true：開啟訊息軌跡功能 false：關閉訊息軌跡功能該參數暫不生效，不管參數是否開啟，執行個體都預設支援軌跡功能。枚舉值： false : 關閉訊息軌跡功能 true : 開啟訊息軌跡功能	true
aclInfo	object	否	存取控制資訊。
aclTypes	array	否	執行個體的鑒權類型。
	string	否	執行個體的鑒權類型。 default: 智能身份識別 apache_acl: Apache RocketMQ ACL 枚舉值： default : 智能身份識別 apache_acl : Apache RocketMQ ACL	apache_acl
defaultVpcAuthFree	boolean	否	是否智能身份識別類型下，VPC 接入免密訪問 true 開啟免密訪問 false 關閉免密訪問枚舉值： true : 開啟免密訪問 false : 關閉免密訪問	false

返回參數

名稱	類型	描述	樣本值
	object	Result
requestId	string	請求 ID，每個請求 ID 都是唯一的，可用於排查和定位問題。	AA87DE09-DA44-52F4-9515-78B1B607****
success	boolean	執行結果是否成功。	true
data	boolean	返回結果。	true
code	string	錯誤碼。	MissingInstanceId
message	string	錯誤資訊。	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	HTTP 狀態代碼。	400
dynamicCode	string	動態錯誤碼。	InstanceId
dynamicMessage	string	動態錯誤資訊。	instanceId

樣本

正常返回樣本

JSON格式

{
  "requestId": "AA87DE09-DA44-52F4-9515-78B1B607****",
  "success": true,
  "data": true,
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

錯誤碼

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

變更歷史

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