All Products
Search
Document Center

Tair:DescribeInstanceAutoRenewalAttribute

Last Updated:Feb 20, 2024

Queries whether auto-renewal is enabled for an ApsaraDB for Redis instance.

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:DescribeInstanceAutoRenewalAttributeREAD
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/*
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the 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.

ETnLKlblzczshOTUbOCz****
RegionIdstringYes

The region ID of the instance.

cn-hangzhou
DBInstanceIdstringNo

The ID of the instance.

Note By default, the system checks whether auto-renewal is enabled for all instances.
r-bp1zxszhcgatnx****
PageSizeintegerNo

The number of entries to return on each page. Valid values: 30, 50, and 100.

Note The default value is 30.
30
PageNumberintegerNo

The number of the page to return. The value must be an integer greater than 0. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

2B17D708-1D6D-49F3-B6D7-478371DD****
PageNumberinteger

The page number of the returned page.

1
PageRecordCountinteger

The number of entries returned on the current page.

30
TotalRecordCountinteger

The total number of returned entries.

1
Itemsobject []

Details of the auto-renewal information for the instance.

Durationinteger

The auto-renewal period. Unit: months.

1
DBInstanceIdstring

The ID of the instance.

r-bp1zxszhcgatnx****
AutoRenewstring

Indicates whether auto-renewal is enabled. Valid values:

  • true: Auto-renewal is enabled.
  • false: Auto-renewal is disabled.
true
RegionIdstring

The region ID of the instance.

cn-shanghai

Examples

Sample success responses

JSONformat

{
  "RequestId": "2B17D708-1D6D-49F3-B6D7-478371DD****",
  "PageNumber": 1,
  "PageRecordCount": 30,
  "TotalRecordCount": 1,
  "Items": {
    "Item": [
      {
        "Duration": 1,
        "DBInstanceId": "r-bp1zxszhcgatnx****",
        "AutoRenew": "true",
        "RegionId": "cn-shanghai"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
400IllegalParameterSpecified parameter exceeds range.

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