You can call this operation to manually renew the subscription RenewDBInstance of an apsaradb for MongoDB instance.
Make sure that you fully understand the billing methods and Pricing of ApsaraDB for MongoDB before using this API. .
This parameter is only applicable to Subscription instances.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | RenewDBInstance |
The operation that you want to perform. Set the value to RenewDBInstance. |
DBInstanceId | String | Yes | dds-bpxxxxxxxx |
The ID of the instance. |
Period | Integer | Yes. | 1 |
The period you set for the instance to implement payment renewal. Unit: months. Valid values: 1-9, 12, 24, and 36. |
CouponNo | String | No | 1111111111111111 |
The coupon code. The default value is: youhuiquan_promotion_option_id_for_blank. |
AutoPay | Boolean | No. | true |
Indicates whether automatic payment is enabled for the instance. Valid values:
Default value: true. |
BusinessInfo | String | No | {"ActivityId":"000000000"} |
The business information. |
ClientToken | String | No | ETnLKlblzczshOTUbOCzxxxxxxxxxx |
The client token that is used to ensure idempotence of the request. You can use the client to generate this value, but you must ensure that it is unique among different requests. The token can contain only ASCII characters, and cannot exceed 64 characters in length. |
Region ID | String | No | cn-hangzhou |
The region ID of the instance. You can call the operation DescribeDBInstanceAttribute to query. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
OrderId | String | 203317xxxxxxxx |
The ID generated for the order. |
RequestId | String | B118EF45-9633-4EE3-8405-42ED4373721B |
The ID of the request. |
Examples
Sample requests
http(s)://mongodb.aliyuncs.com/? Action=RenewDBInstance
&DBInstanceId=dds-bpxxxxxxxx
&Period=1
&<Common request parameters>
Sample success responses
XML
format
<RenewDBInstanceResponse>
<OrderId>2033xxxxxxxx</OrderId>
<RequestId>B118EF45-9633-4EE3-8405-42ED4373721B</RequestId>
</RenewDBInstanceResponse>
JSON
format
{
"OrderId": "2033xxxxxxxx",
"RequestId": "B118EF45-9633-4EE3-8405-42ED4373721B"
}
Error codes
For a list of error codes, visit the API Error Center.