使用说明

每个地域（Region）最大的实例数量为8。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

授权信息

默认仅限阿里云账号使用本接口，RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息，请参见权限策略和示例。


API	Action	Resource
OnsInstanceUpdate	mq:QueryInstanceBaseInfo mq:UpdateInstance	acs:mq:::{instanceId}

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	OnsInstanceUpdate	系统规定参数。取值：OnsInstanceUpdate。
Remark	String	否	备注更新	更新后的实例描述，传空值则不更新。
InstanceName	String	是	名字更新	更新后的实例名称。取值说明如下：实例名称在该实例所部署的地域下要唯一，不可重名。长度限制为3~64个字符，可以是中文、英文、数字、短划线（-）以及下划线（_）。传空值则不更新。
InstanceId	String	是	MQ_INST_188077086902****_BXSuW61e	待更新名称或描述的实例ID。

返回数据


名称	类型	示例值	描述
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格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

控制台操作

除了调用OnsInstanceUpdate接口，您还可以通过消息队列RocketMQ版控制台更新实例名称和描述。具体操作，请参见实例管理。