All Products
Search
Document Center

ApsaraDB RDS:DescribeDBInstancesByExpireTime

Last Updated:May 22, 2024

Queries the information about an ApsaraDB RDS instance based on the remaining subscription duration of an instance.

Operation description

Supported database engines

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

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
rds:DescribeDBInstancesByExpireTimeRead
  • All Resources
    *
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
proxyIdstringNo

A deprecated parameter. You do not need to configure this parameter.

None
ExpirePeriodintegerNo

The number of remaining days for which the instances are available. Valid values: 0 to 180.

180
ExpiredbooleanNo

Specifies whether to query instances that have expired. Valid values:

  • True: queries instances that have expired.
  • False: does not query instances that have expired.
True
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 100.

Default value: 30.

30
PageNumberintegerNo

The number of the page to return. Valid values: any non-zero positive integer.

Default value: 1.

1
TagsstringNo

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","key2":"value2"...}.

{"key1":"value1"}
ResourceGroupIdstringNo

The resource group ID. You can call the DescribeDBInstanceAttribute operation to obtain the resource group ID.

rg-acfmy****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumberinteger

The page number of the returned page. Valid values: any non-zero positive integer.

Default value: 1.

1
PageRecordCountinteger

The number of instances returned on the current page.

2
TotalRecordCountinteger

The total number of returned entries.

200
Itemsobject []

The details of the instances.

ExpireTimestring

The expiration time of the instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Note : Pay-as-you-go instances never expire.
2019-03-27T16:00:00Z
PayTypestring

The billing method of the instance. Valid values:

  • Postpaid: pay-as-you-go.
  • Prepaid: subscription.
Prepaid
DBInstanceIdstring

The instance ID.

rm-uf6wjk5xxxxxxx
DBInstanceStatusstring

The status of the instance. For more information, see Instance state table.

Running
DBInstanceDescriptionstring

The description of the instance.

Test database
LockModestring

The lock mode of the instance. Valid values:

  • Unlock: The instance is not locked.
  • ManualLock: The instance is manually locked.
  • LockByExpiration: The instance is automatically locked after it expires.
  • LockByRestoration: The instance is automatically locked before it is rolled back.
  • LockByDiskQuota: The instance is automatically locked after its storage capacity is exhausted.
  • LockReadInstanceByDiskQuota: The instance is a read-only instance and is automatically locked after its storage capacity is exhausted.
Unlock

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 timeSummary of changesOperation
2023-07-25The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId