調用OnsInstanceUpdate接口更新實例名稱和描述。
接口說明
注意 阿里云提供的 OpenAPI 屬于管控類 API，用于管理和查詢阿里云服務的相關資源。僅推薦在管控鏈路集成，消息收發的核心數據鏈路中嚴禁依賴 OpenAPI 實現，否則可能會導致鏈路產生風險。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| mq:UpdateInstance | *Instance acs:mq:{#regionId}:{#accountId}:{#InstanceId} |
|
|
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Remark | string | 否 | 更新后的實例描述，傳空值則不更新。 | 備注更新 |
| InstanceName | string | 是 | 更新后的實例名稱。取值說明如下：
| 名字更新 |
| InstanceId | string | 是 | 待更新名稱或描述的實例 ID。 | MQ_INST_188077086902****_BXSuW61e |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史
控制臺操作
除了調用 OnsInstanceUpdate 接口，您還可以通過云消息隊列 RocketMQ 版控制臺更新實例名稱和描述。具體操作，請參見實例管理。