调用DescribeDBInstanceEncryptionKey查询RDS实例是否开启了云盘加密,以及密钥详情,支持MySQL、SQLServer、PostgreSQL。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBInstanceEncryptionKey

系统规定参数,取值:DescribeDBInstanceEncryptionKey

DBInstanceId String rm-uf6wjk5xxxxxxx

实例ID。

RegionId String cn-hangzhou

实例所在的地域。

说明 可以通过DescribeRegions接口查看地域ID。
TargetRegionId String cn-qingdao

目标地域ID。

说明 可以通过DescribeRegions接口查看地域ID。
EncryptionKey String 749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx

自定义密钥ID。

返回数据

名称 类型 示例值 描述
Creator String 1443*****9604

密钥的创建者。

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

预计删除时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Description String Description of the key

密钥描述。

EncryptionKey String 5306d1b6-7fd3-42d9-9511-xxxxxxx

密钥ID。

EncryptionKeyStatus String Enabled

密钥的状态。取值:

  • Enabled:启用
  • Disabled:未启用
KeyUsage String ENCRYPT/DECRYPT

密钥用途。

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

密钥过期时间。格式: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
&<公共请求参数>

正常返回示例

XML格式

<Origin>Aliyun_KMS</Origin>
<Description>Description of the key</Description>
<EncryptionKeyStatus>Enabled</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>

JSON格式

{
    "Origin": "Aliyun_KMS",
    "Description": "Description of the key",
    "EncryptionKeyStatus": "Enabled",
    "RequestId": "3BC2768E-DEDA-40FC-BBE9-6B884F3626AF",
    "MaterialExpireTime": "2021-10-18T08:14:16Z",
    "KeyUsage": "ENCRYPT/DECRYPT",
    "EncryptionKey": "5306d1b6-7fd3-42d9-9511-xxxxxxx",
    "Creator": "1443*****9604",
    "DeleteDate": "2022-05-08T08:14:16Z"
}

错误码

访问错误中心查看更多错误码。