Queries the information about an ApsaraDB RDS instance based on the remaining subscription duration of an instance.
Operation description
Debugging
Authorization information
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
JSON
format
{
"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 |
---|---|---|
2023-07-25 | The request parameters of the API has changed | View Change Details |