文档

UpdateInstance - 更新实例

更新时间:

更新云消息队列 RocketMQ 版实例的基本信息和规格配置。

接口说明

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

调试

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

授权信息

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

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

请求语法

PATCH /instances/{instanceId}

请求参数

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

待更新实例的 ID。

rmq-cn-7e22ody****
bodyobject

请求体结构。

instanceNamestring

更新后的实例名称。

test_instance
remarkstring

更新后的实例备注信息。

This is the remark for test.
networkInfoobject

更新后的实例网络信息。

internetInfoobject

公网信息,仅当实例开通公网访问功能时,该参数有效。

ipWhitelistarray

公网访问 IP 白名单列表。

  • 若不配置 IP 白名单,则默认放通所有 IP 地址段通过公网访问云消息队列 RocketMQ 版服务端。
  • 若配置 IP 白名单,则仅允许白名单内的 IP 地址通过公网访问云消息队列 RocketMQ 版服务端。
string

公网访问 IP 白名单。

192.168.x.x/24
productInfoobject

实例的扩展配置。

sendReceiveRatiofloat

消息发送和接收的比例。

取值范围:[0.25,1]

0.5
autoScalingboolean

是否开启规格外突发弹性能力。

参数取值如下:

  • true:开启弹性
  • false:关闭弹性

开启弹性突发能力后,云消息队列 RocketMQ 版允许该实例在一定范围内超过基础规格限制的 TPS,且超过基础规格外的部分,需要收取额外的弹性规格费用。具体计费信息,请参见计算能力费用

说明 仅部分规格的实例支持开启弹性突发规格能力,具体支持的实例,请参见实例规格
true
messageRetentionTimeinteger

消息保存时长。单位:小时。

取值范围,请参见使用限制>资源配额>消息保存时长的限制值。

云消息队列 RocketMQ 版的消息存储完全实现 Serverless 弹性,按照实际存储空间收取费用,您可以通过调整消息保存时长来控制消息的存储容量。更多信息,请参见存储费用

72
traceOnboolean

是否开启消息轨迹功能。

  • true:开启消息轨迹功能
  • false:关闭消息轨迹功能

该参数仅对 Serverless 类型的实例生效,若开启消息轨迹功能,会产生相关的消息轨迹费用,具体计费信息,请参见 Serverless 计费说明。 对于按量付费和包年包月实例,该参数不生效,即不管参数是否开启,都默认支持消息轨迹功能。

true
aclInfoobject

访问控制信息。

aclTypesarray

实例的鉴权类型。

string

实例的鉴权类型。

  • default: 智能身份识别
  • apache_acl: Apache RocketMQ ACL
apache_acl
defaultVpcAuthFreeboolean

是否智能身份识别类型下,VPC 接入免密访问

  • true 开启免密访问
  • false 关闭免密访问
false

返回参数

名称类型描述示例值
object

Result

requestIdstring

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

AA87DE09-DA44-52F4-9515-78B1B607****
successboolean

执行结果是否成功。

true
databoolean

返回结果。

true
codestring

错误码。

MissingInstanceId
messagestring

错误信息。

Parameter instanceId is mandatory for this action .
httpStatusCodeinteger

HTTP 状态码。

400
dynamicCodestring

动态错误码。

InstanceId
dynamicMessagestring

动态错误信息。

instanceId

示例

正常返回示例

JSON格式

{
  "requestId": "AA87DE09-DA44-52F4-9515-78B1B607****",
  "success": true,
  "data": true,
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-29API 内部配置变更,不影响调用查看变更详情
2023-10-09API 内部配置变更,不影响调用查看变更详情
2022-12-15API 内部配置变更,不影响调用查看变更详情