All Products
Search
Document Center

BSS OpenAPI:SetRenewal

Last Updated:Jul 18, 2024

Enables auto-renewal for an instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RenewalPeriodintegerNo

The auto-renewal period. Valid values:

  • 1
  • 2
  • 3
  • 6
  • 12
Note This parameter is required if the RenewalStatus parameter is set to AutoRenewal.
1
InstanceIDsstringYes

The ID of the instance. You can enable auto-renewal for up to 100 subscription instances at a time. Separate multiple instance IDs with commas (,).

rm-askjdhaskfjh
ProductCodestringYes

The code of the service.

rds
ProductTypestringNo

The type of the service.

rds
SubscriptionTypestringNo

The billing method. Valid values:

  • Subscription: subscription
  • PayAsYouGo: pay-as-you-go
PayAsYouGo
RenewalPeriodUnitstringNo

The unit of the auto-renewal period. Valid values:

  • M: months
  • Y: years
Note This parameter is required if the RenewalStatus parameter is set to AutoRenewal.
M
RenewalStatusstringYes

The status of renewal. Valid values:

  • AutoRenewal: The instance is automatically renewed.
  • ManualRenewal: The instance is manually renewed.
  • NotRenewal: The instance is not renewed.
AutoRenewal

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The status code.

Success
Messagestring

The error message returned.

Successful
RequestIdstring

The ID of the request.

6000EE23-274B-4E07-A697-FF2E999520A4
Successboolean

Indicates whether the request was successful.

true

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "Successful",
  "RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-25The internal configuration of the API is changed, but the call is not affectedView Change Details