All Products
Search
Document Center

:ModifyInstanceAutoRenewalAttribute

Last Updated:Dec 09, 2024

Enables or disables auto-renewal for a Tair (Redis OSS-compatible) instance.

Operation description

Note Auto-renewal is triggered seven days before the expiration date of the instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance. Separate multiple instance IDs with commas (,).

Note You can specify up to 30 instance IDs.
r-bp1zxszhcgatnx****
DurationstringNo

The auto-renewal period. Valid values: 1 to 12. Unit: months. When the instance is about to expire, the instance is automatically renewed based on the number of months specified by this parameter.

Note This parameter is available and required only if the AutoRenew parameter is set to true.
3
AutoRenewstringNo

Specifies whether to enable auto-renewal. Valid values:

  • true: enables auto-renewal.
  • false: disables auto-renewal.
Note The default value is false.
true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

52D901ED-E0A5-42FB-B9DB-39C295C3****

Examples

Sample success responses

JSONformat

{
  "RequestId": "52D901ED-E0A5-42FB-B9DB-39C295C3****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-03-02The internal configuration of the API is changed, but the call is not affectedView Change Details