Queries the information about an ApsaraDB RDS instance based on the remaining subscription duration of an instance.
Operation description
Debugging
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 Resourcesis 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:DescribeDBInstancesByExpireTime | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | No | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| proxyId | string | No | A deprecated parameter. You do not need to configure this parameter. | None |
| ExpirePeriod | integer | No | The number of remaining days for which the instances are available. Valid values: 0 to 180. | 180 |
| Expired | boolean | No | Specifies whether to query instances that have expired. Valid values:
| True |
| PageSize | integer | No | The number of entries to return on each page. Valid values: 1 to 100. Default value: 30. | 30 |
| PageNumber | integer | No | The number of the page to return. Valid values: any non-zero positive integer. Default value: 1. | 1 |
| Tags | string | No | The tag that is added to the instance. Each tag is a key-value pair that consists of two parts: TagKey and TagValue. You can specify a maximum of five tags in the following format for each request: | {"key1":"value1"} |
| ResourceGroupId | string | No | The resource group ID. You can call the DescribeDBInstanceAttribute operation to obtain the resource group ID. | rg-acfmy**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"PageNumber": 1,
"PageRecordCount": 2,
"TotalRecordCount": 200,
"Items": {
"DBInstanceExpireTime": [
{
"ExpireTime": "2019-03-27T16:00:00Z",
"PayType": "Prepaid",
"DBInstanceId": "rm-uf6wjk5xxxxxxx",
"DBInstanceStatus": "Running",
"DBInstanceDescription": "Test database\n",
"LockMode": "Unlock"
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-11-20 | API Description Update. The Error code has changed | View Change Details |
| 2023-07-25 | The request parameters of the API has changed | View Change Details |