DescribeDBInstanceEncryptionKey操作を呼び出して、ApsaraDB RDSインスタンスでディスク暗号化が有効になっているかどうか、およびディスク暗号化に使用されるキーの詳細を照会できます。 この操作は、MySQL、SQL Server、またはPostgreSQLを実行するApsaraDB RDSインスタンスでサポートされています。

デバッグ

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

リクエストパラメーター

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

実行したい操作。 値をDescribeDBInstanceEncryptionKeyに設定します。

DBInstanceId String 必須 rm-uf6wjk5xxxxxxx

インスタンスの ID。 DescribeDBInstancesを呼び出して、インスタンスのIDを照会できます。

RegionId String 任意 cn-hangzhou

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

TargetRegionId String 任意 cn-qingdao

ターゲットリージョンのID。 DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。

暗号化キー String 任意 749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx

ディスクの暗号化に使用されるカスタムキーのID。

レスポンスパラメーター

項目 データ型 例: 説明　
Creator String 1443 ***** 9604

キーを作成したユーザー。

DeleteDate String 2022-05-08T08:14:16Z

キーが削除される予定時刻。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。

説明　 String キーの説明

キーの説明を入力します。

暗号化キー String 5306d1b6-7fd3-42d9-9511-xxxxxxx

キーのID。

EncryptionKeyStatus String 有効

キーのステータス。 有効な値：

  • 有効
  • 無効
KeyUsage String ENCRYPT/DECRYPT

キーの目的。

MaterialExpireTime String 2021-10-18T08:14:16Z

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

Origin String Aliyun_KMS

キーのソース。

RequestId String 3BC2768E-DEDA-40FC-BBE9-6B884F3626AF

リクエストの ID です。

例

リクエストの例

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

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

XML 形式

<DescribeDBInstanceEncryptionKeyResponse>
      <Origin>Aliyun_KMS</Origin>
      <説明> キーの説明 </Description>
      <EncryptionKeyStatus> 有効 </EncryptionKeyStatus>
      <RequestId>3BC2768E-DEDA-40FC-BBE9-6B884F3626AF</RequestId>
      <MaterialExpireTime>2021-10-18T08:14:16Z</MaterialExpireTime>
      <KeyUsage>ENCRYPT/DECRYPT</KeyUsage>
      <EncryptionKey>5306d1b6-7fd3-42d9-9511-xxxxxxx</EncryptionKey>
      <Creator>1443 ***** 9604</Creator>
      <DeleteDate>2022-05-08T08:14:16Z</DeleteDate>
</DescribeDBInstanceEncryptionKeyResponse>

JSON 形式

{
    "Origin": "Aliyun_KMS",
    "Description": "キーの説明" 、
    "EncryptionKeyStatus": "Enabled" 、
    "RequestId": "3BC2768E-DEDA-40FC-BBE9-6B884F3626AF" 、
    "MaterialExpireTime": "2021-10-18T08:14:16Z" 、
    "KeyUsage": "ENCRYPT/DECRYPT",
    "EncryptionKey": "5306d1b6-7fd3-42d9-9511-xxxxxxx" 、
    "クリエーター": "1443 ***** 9604" 、
    "DeleteDate": "2022-05-08T08:14:16Z"
}

エラーコード

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