文档

OnsInstanceUpdate - 更新实例名称和描述

更新时间:
一键部署

调用OnsInstanceUpdate接口更新实例名称和描述。

接口说明

注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mq:UpdateInstanceWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Remarkstring

更新后的实例描述,传空值则不更新。

备注更新
InstanceNamestring

更新后的实例名称。取值说明如下:

  • 实例名称在该实例所部署的地域下要唯一,不可重名。

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

  • 传空值则不更新。

名字更新
InstanceIdstring

待更新名称或描述的实例 ID。

MQ_INST_188077086902****_BXSuW61e

返回参数

名称类型描述示例值
object
RequestIdstring

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

A07E3902-B92E-44A6-B6C5-6AA111111****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史

控制台操作

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