DescribeInstanceAutoRenewalAttribute - Tair (Redis® OSS-Compatible)

Queries whether auto-renewal is enabled for an ApsaraDB for Redis 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:DescribeInstanceAutoRenewalAttribute	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	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****
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
DBInstanceId	string	No	The ID of the instance. Note By default, the system checks whether auto-renewal is enabled for all instances.	r-bp1zxszhcgatnx****
PageSize	integer	No	The number of entries to return on each page. Valid values: 30, 50, and 100. Note The default value is 30.	30
PageNumber	integer	No	The number of the page to return. The value must be an integer greater than 0. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	2B17D708-1D6D-49F3-B6D7-478371DD****
PageNumber	integer	The page number of the returned page.	1
PageRecordCount	integer	The number of entries returned on the current page.	30
TotalRecordCount	integer	The total number of returned entries.	1
Items	array<object>	Details of the auto-renewal information for the instance.
Item	object
Duration	integer	The auto-renewal period. Unit: months.	1
DBInstanceId	string	The ID of the instance.	r-bp1zxszhcgatnx****
AutoRenew	string	Indicates whether auto-renewal is enabled. Valid values: true: Auto-renewal is enabled. false: Auto-renewal is disabled.	true
RegionId	string	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 code	Error code	Error message
400	IllegalParameter	Specified parameter exceeds range.

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