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