UpdateInstance - 更新实例

更新时间:

更新云消息队列RabbitMQ的实例,升降配规格。

调试

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

授权信息

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

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

请求参数

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

客户端 Token。

c2c5d1274axxxxxxxx
InstanceIdstring

云消息队列 RabbitMQ 版实例的 ID。

amqp-cn-jtexxxxx
ModifyTypestring

变配类型,取值如下:

  • UPGRADE:升配
  • DOWNGRADE:降配
UPGRADE
InstanceTypestring

实例规格类型, 预付费类型的取值如下:

  • professional:专业版
  • enterprise:企业版
  • vip:铂金版

后付费实例:无需填写

professional
ServerlessChargeTypestring

后付费(即 Serverless)实例的计费类型,取值如下:

  • onDemand:按量累计
onDemand
MaxPrivateTpslong

私网 TPS 流量,单位:次/秒

1000
SupportEipboolean

是否支持公网

false
MaxEipTpslong

公网 TPS 流量峰值,单位:次/秒

128
QueueCapacityinteger

配置 Queue 的数量上限

1000
MaxConnectionsinteger

最大连接数

1000
StorageSizeinteger

配置消息存储空间

7
SupportTracingboolean

是否开通消息轨迹功能

false
TracingStorageTimeinteger

配置消息轨迹的保存时长

3
EncryptedInstanceboolean

独享实例专属功能。实例是否开通数据存储加密功能。

  • 独享实例 EncryptedInstance、KmsKeyId 属性不能更改(包括变配成非加密;降级成共享加密;降级成共享非加密);即独享实例使用 UpdateInstance 升/降级配置时,不允许携带 EncryptedInstance、KmsKeyId 参数;

  • EncryptedInstance 的 EncryptedInstance、KmsKeyId 参数,运用场景是,共享实例升级成加密独享实例。

false
KmsKeyIdstring

独享实例专属功能,当 EncryptedInstance 为 true 时需要填写此字段。 数据加密存储使用的 KMS 密钥 ID。 对密钥有以下要求:

  • KMS 密钥实例须要与 RabbitMQ 实例在同一个地域;

  • 不能是服务密钥;

  • 密钥状态必须是开启的;

  • 必须是对称密钥,不能是非对称密钥;

  • 密钥用途必须是加解密;

  • KMS 密钥过期/删除后,数据读写不可用,RabbitMQ 实例异常;

key-bjj66c2a893vmhawtq5fd

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

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

628705FD-03EE-4ABE-BB21-E1672960***
Codeinteger

返回码。返回 200 代表成功。

200
Messagestring

返回信息。

InstanceNotExist
Dataany

返回数据,涵盖 orderId 和 instanceId。例如

"Data": {
    "instanceId": "amqp-cn-xxxxx",
    "orderId": 22222
  }
{'instanceId': 'rabbitmq-serverless-cn-lf63qsjlf06', 'orderId': 234170302080010}
Successstring

请求是否成功。

true
StatusCodestring

状态码。

200

示例

正常返回示例

JSON格式

{
  "RequestId": "628705FD-03EE-4ABE-BB21-E1672960***",
  "Code": 200,
  "Message": "InstanceNotExist",
  "Data": "{'instanceId': 'rabbitmq-serverless-cn-lf63qsjlf06', 'orderId': 234170302080010}",
  "Success": "true",
  "StatusCode": "200"
}

错误码

HTTP status code错误码错误信息描述
400INSUFFICIENT_AVAILABLE_QUOTAYour account available limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
403UnauthorizedOperationThe request has failed due to unauthorized operation.该请求未经授权。

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

变更历史

变更时间变更内容概要操作
2024-11-25OpenAPI 入参发生变更查看变更详情