Renews the subscription of a specified instance.

Request parameters

Parameter Type Required Example Description
Action String Yes RenewInstance

The operation that you want to perform. Set the value to RenewInstance.

InstanceId String Yes amqp-cn-zvp2ajsj****

The ID of the instance.

ProductCode String Yes ons

The code of the service. Set the value to ons.

RenewPeriod Integer Yes 6

The period of the subscription renewal. Unit: month. Valid values:

  • 1~3
  • 6
  • 12
  • 24
  • 36
ClientToken String No ASKJHKLASJHAFSLKJH

The client token that is used to ensure the idempotence of the request.

ProductType String No ons_onsproxy_public_intl The type of the service. Set the value to ons_onsproxy_public_intl.

Response parameters

Parameter Type Example Description
Code String Success

The HTTP status code.

Data Struct

The returned data.

OrderId String 21016588106****

The ID of the order.

Message String Successful!

The prompt message.

RequestId String 60CE9D3C5A-4346-52B5-AC15-83CFEF73****

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://business.aliyuncs.com/?Action=RenewInstance
&ProductCode=ons
&InstanceId=amqp-cn-zvp2ajsj****
&RenewPeriod=6
&ProductType=ons_onsproxy_public_intl
&<Common request parameters>

Sample success responses

XML format

<RenewInstanceResponse>
      <Message>Successful!</Message>
      <RequestId>CE9D3C5A-4346-52B5-AC15-83CFEF73****</RequestId>
      <Data>
            <OrderId>21016588106****</OrderId>
      </Data>      
      <Code>Success</Code>
      <Success>true</Success>
</RenewInstanceResponse>

JSON format

{
  "Message": "Successful!",
  "RequestId": "CE9D3C5A-4346-52B5-AC15-83CFEF73****",
  "Data": {
    "OrderId": 21016588106****
  },
  "Code": "Success",
  "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.