DescribeInstanceAutoRenewalAttribute - ApsaraDB RDS - Alibaba Cloud Documentation Center

Query the automatic renewal status of an RDS instance.

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
rds:DescribeInstanceAutoRenewalAttribute	READ	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/* RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	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 only contain ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCzxxxxxxx
proxyId	string	No	The ID of the proxy mode.	API
RegionId	string	Yes	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBInstanceId	string	No	The ID of the instance.	rm-bpxxxxxxx
PageSize	integer	No	The number of entries to return on each page. Valid values: 30(Default) 50 100	30
PageNumber	integer	No	The number of the page to return.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	4182309D-CD29-49B1-B4A5-D7CB4D56C31F
PageNumber	integer	The number of the page to return.	1
PageRecordCount	integer	The number of entries returned on the current page.	1
TotalRecordCount	integer	The total number of entries returned.	1
Items	object []	The renewal information of the instance.
Status	string	The status of the instance.	Normal
Duration	integer	The billing cycle of renewal.	1
DBInstanceId	string	The ID of the instance.	rm-bpxxxxxxx
AutoRenew	string	Indicates whether auto-renewal is enabled.	True
RegionId	string	The ID of the region.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RequestId": "4182309D-CD29-49B1-B4A5-D7CB4D56C31F",
  "PageNumber": 1,
  "PageRecordCount": 1,
  "TotalRecordCount": 1,
  "Items": {
    "Item": [
      {
        "Status": "Normal",
        "Duration": 1,
        "DBInstanceId": "rm-bpxxxxxxx",
        "AutoRenew": "True",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

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