使用 OnsInstanceUpdate 更新实例名称和描述。

使用本接口时,请注意以下几点:

  • 默认仅限主账号使用本接口,RAM 用户只有在被授予了相关权限后方可使用。
  • 每个地域(Region)最大的实例数量为 8。
  • 实例名称在该实例所部署的地域下要唯一,不可重名。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String OnsInstanceUpdate

系统规定参数。取值:OnsInstanceUpdate

InstanceId String MQ_INST_188077086902****_BXSuW61e

实例 ID。

InstanceName String 名字更新

实例名称。

长度限制为3 ~ 64 个字符,可以是中文、英文、数字、短划线(-)以及下划线(_)。

传空值则不更新。

Remark String 备注更新

备注,传空值则不修改。

返回数据

名称 类型 示例值 描述
RequestId String A07E3902-B92E-44A6-B6C5-6AA111111****

为公共参数,每个请求的 ID 都是唯一的,可用于排查和定位问题。

示例

请求示例

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsInstanceUpdate
&InstanceId=MQ_INST_188077086902****_BXSuW61e
&InstanceName=名字更新
&Remark=备注更新
&<公共请求参数>

正常返回示例

XML 格式

<OnsInstanceUpdateResponse>
  <RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>
</OnsInstanceUpdateResponse>

JSON 格式

{
    "RequestId":"A07E3902-B92E-44A6-B6C5-6AA111111****"
}

错误码

访问错误中心查看更多错误码。