调用ModifyInstance对实例资源配置进行变更。调用接口会创建一个变配实例资源的订单，并自动支付。

调试

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

请求参数

名称类型是否必选示例值描述
ActionString是ModifyInstance

系统规定参数。取值：ModifyInstance。

ModifyTypeString是Upgrade

变配类型，取值

  • Upgrade：升级。
  • Downgrade：降级。
Parameter.N.CodeString是test

第N个模块属性code配置，如有多个模块属性参数，按照N=0,1,2,3…N的形式拼接多个参数。

说明 只设置需要变更配置的模块属性信息，如A,B两个属性中，只有A需要变更配置，则只传A属性相关即可。

该参数需与Parameter.N.Value一起使用，云消息队列 RabbitMQ 版实例支持的变更配置包括：

  • 变更公网TPS流量峰值：您需设置Parameter.N.Code为MaxEipTps，对应Parameter.N.Value参数，请根据云消息队列 RabbitMQ 版控制台购买页所给出的取值设置。
  • 变更私网TPS流量峰值：您需设置Parameter.N.Code为MaxTps，对应Parameter.N.Value参数，请根据云消息队列 RabbitMQ 版控制台购买页所给出的取值设置。
  • 变更Queue的数量上限：您需设置Parameter.N.Code为QueueCapacity，对应Parameter.N.Value的取值范围为[50,6000]，单位：个。
  • 变更消息存储空间：铂金版实例支持变更消息存储空间。您需设置Parameter.N.Code为StorageSize，对应Parameter.N.Value的取值为m×100，其中m的取值范围为[7,28]，单位：GB。
  • 变更消息轨迹功能是否开启：您需要设置Parameter.N.Code为SupportTracing，对应Parameter.N.Value取值如下：
    • tracing_true：表示开通消息轨迹功能。
    • tracing_false：表示不开通消息轨迹功能。
    重要
    • 铂金版实例免费提供15天消息轨迹功能，轨迹功能只能选择开启且轨迹保存时长只能设置为15天。
    • 其他规格类型实例可选择开启或关闭轨迹功能，关闭轨迹功能时，轨迹保存时长只能设置为0。
    具体取值组合，请参见下文消息轨迹参数取值约束。
  • 变更消息轨迹保存时长：您需要设置Parameter.N.Code为TracingStorageTime，对应Parameter.N.Value取值为0、3、7、15，单位：天。
Parameter.N.ValueString是test

第N个模块属性Code对应的Value，按照N=0,1,2,3…N的形式拼接多个参数。

ProductCodeString是ons

产品代码，固定为：ons。

SubscriptionTypeString是Subscription

付费类型，取值：

  • Subscription：预付费。
  • PayAsYouGo：后付费。
云消息队列 RabbitMQ 版实例不再支持按量付费模式，即该参数只能为Subscription。
ProductTypeString是ons_onsproxy_pre产品类型，固定为：ons_onsproxy_pre。
InstanceIdString是amqp-cn-zvp2ajsj****

变更配置的实例ID。

ClientTokenString否JAKSJFHFAKJSF

用于保证请求的幂等性，防止请求重复提交。

表 1. 消息轨迹参数取值约束
InstanceType参数取值SupportTracing参数取值TracingStorageTime参数取值
  • professional
  • enterprise
tracing_false0
  • professional
  • enterprise
tracing_true
  • 3
  • 7
  • 15
viptracing_true15

返回数据

名称类型示例值描述
CodeStringSuccess

状态码。

DataStruct

返回数据。

HostIdStringcn

主机ID。

OrderIdString21017220559****

创建成功的订单ID。

MessageStringSuccessful！

提示信息。

RequestIdStringDFCE1EB7-6AE6-5AC9-BC3C-42B0EC5B****

请求ID。

SuccessBooleantrue

是否成功。

示例

请求示例

http(s)://business.aliyuncs.com/?Action=ModifyInstance
&ModifyType=Upgrade
&Parameter.0.Code=MaxTps
&Parameter.0.Value=60000
&Parameter.1.Code=MaxEipTps
&Parameter.1.Value=49408
&Parameter.2.Code=QueueCapacity
&Parameter.2.Value=60
&InstanceId=amqp-cn-i7m2a8bq****
&ProductCode=ons
&&ProductType=ons_onsproxy_pre
&SubscriptionType=Subscription&<公共请求参数>

正常返回示例

XML 格式

<ModifyInstanceResponse>
      <Message>Successful!</Message>
      <RequestId>DFCE1EB7-6AE6-5AC9-BC3C-42B0EC5B****</RequestId>
      <Data>
            <OrderId>21017220559****</OrderId>
            <HostId>cn</HostId>
      </Data>
      <Code>Success</Code>
      <Success>true</Success>      
</ModifyInstanceResponse>

JSON 格式

{
  "Message": "Successful!",
  "RequestId": "DFCE1EB7-6AE6-5AC9-BC3C-42B0EC5B****",
  "Data": {
    "OrderId": 21017220559****,
    "HostId": "cn"
  },
  "Code": "Success",
  "Success": true
}

错误码

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