DescribeDBInstancesByExpireTime操作を呼び出して、特定の有効期限に基づいてApsaraDB RDSインスタンスを照会できます。

説明 この操作は、サブスクリプションインスタンスでのみ使用できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目データ型必須／任意例:説明　
操作String必須DescribeDBInstancesByExpireTime

実行する操作です。 値をDescribeDBInstancesByExpireTimeに設定します。

RegionIdString任意cn-hangzhou

インスタンスのリージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

proxyIdString任意N/A

非推奨のパラメーター。

ExpirePeriodIntegerいいえ180

インスタンスが利用可能な残りの日数。 有効値: 0 ~ 180

期限切れBooleanいいえ正しい

期限切れのインスタンスを照会するかどうかを指定します。 有効な値：

  • True: 期限切れのインスタンスを照会します。
  • False: 期限切れでないインスタンスを照会します。
PageSizeIntegerいいえ30

各ページで返されるエントリ数。 有効な値: 1 ~ 100

既定値： 30.

PageNumberIntegerいいえ1

返されるページ数。 有効値: 非ゼロの正の整数。

既定値：1

タグString任意null

インスタンスに追加されるタグ。 各タグは、TagKeyとTagValueの2つの部分で構成されるキーと値のペアです。 リクエストごとに、{"key1":"value1","key2":"value2"...} の形式で最大5つのタグを指定できます。

レスポンスパラメーター

項目データ型例:説明　
RequestIdString1AD222E9-E606-4A42-BF6D-8A4442913CEF

リクエストの ID です。

PageNumberInteger1

返されたページ数。 有効値: 非ゼロの正の整数。

既定値：1

PageRecordCountInteger2

現在のページで返されたインスタンスの数。

TotalRecordCountInteger200

エントリの総数。

項目DBInstanceExpireTimeの配列

返されるインスタンスに関する情報で構成される配列。

DBInstanceExpireTime
ExpireTimeString2019-03-27T16:00:00Z

インスタンスの有効期限。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。

説明 従量課金インスタンスの有効期限はありません。
PayTypeStringPrepaid

インスタンスの課金方法です。 有効な値：

  • 後払い: 従量課金
  • プリペイド: サブスクリプション
DBInstanceIdStringrm-uf6wjk5xxxxxxx

インスタンスの ID です。

DBInstanceStatusStringRunning

インスタンスのステータス。 詳細は、「インスタンス状態テーブル」をご参照ください。

DBInstanceDescriptionStringTest database

インスタンスの説明。

LockModeStringUnlock

インスタンスのロックモード。 有効な値：

  • Unlock: インスタンスはロックされていません。
  • ManualLock: インスタンスは手動でロックされています。
  • LockByExpiration: インスタンスは有効期限が切れると自動的にロックされます。
  • LockByRestoration: インスタンスはロールバックされる前に自動的にロックされます。
  • LockByDiskQuota: ストレージ容量がなくなると、インスタンスは自動的にロックされます。
  • LockReadInstanceByDiskQuota: インスタンスは読み取り専用インスタンスであり、ストレージ容量が使い果たされると自動的にロックされます。

例

リクエストの例

http(s):// rds.aliyuncs.com/?Action=DescribeDBInstancesByExpireTime
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstancesByExpireTimeResponse>
    <TotalRecordCount>200</TotalRecordCount>
    <PageRecordCount>2</PageRecordCount>
    <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
    <ページ番号> 1 </ PAGENUMBER>
    <Items>
        <DBInstanceExpireTime>
            <DBInstanceStatus>Running</DBInstanceStatus>
            <DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId>
            <PayType>Prepaid</PayType>
            <LockMode>Unlock</LockMode>
            <ExpireTime>2019-03-27T16:00:00Z</ExpireTime>
            <DBInstanceDescription>Test database</DBInstanceDescription>
        </DBInstanceExpireTime>
    </アイテム>
</DescribeDBInstancesByExpireTimeResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecordCount" : "200" 、
  "PageRecordCount" : "2" 、
  "RequestId" : "1AD222E9-E606-4A42-BF6D-8A4442913CEF" 、
  "PageNumber" : "1" 、
  "アイテム" : {
    "DBInstanceExpireTime" : [ {
      "DBInstanceStatus" : "Running" 、
      "DBInstanceId" : "rm-uf6wjk5xxxxxxx" 、
      "PayType" : "プリペイド" 、
      "LockMode" : "ロック解除" 、
      "ExpireTime" : "2019-03-27T16:00:00Z" 、
      "DBInstanceDescription": "データベースのテスト"
    } ]
  }
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。