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

调试

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

请求参数

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

系统规定参数。取值:DescribeDBInstanceEncryptionKey

RegionId String cn-hangzhou

实例所在的地域ID。可调用DescribeRegions接口获取。

DBInstanceId String rm-uf6wjk5xxxxxxx

实例ID。可调用DescribeDBInstances接口获取。

EncryptionKey String 749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx

自定义密钥ID。

TargetRegionId String cn-qingdao

目标地域ID。可调用DescribeRegions接口获取。

返回数据

名称 类型 示例值 描述
DeleteDate String 2022-05-08T08:14:16Z

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

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

请求ID。

Description String Description of the key

密钥描述。

Origin String Aliyun_KMS

密钥的来源。

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

密钥过期时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

EncryptionKeyStatus String Enabled

密钥的状态。返回值:

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

密钥用途。

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

密钥ID。

Creator String 1443*****9604

密钥的创建者。

EncryptionKeyList Array of EncryptionKeyInfo

密钥列表。

KeyType String ALIAS

Key的类型。

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

密钥ID。

Description String Description of the key

密钥描述。

KeyUsage String ENCRYPT/DECRYPT

密钥用途。

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

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

Creator String 1443*****9604

密钥的创建者。

EncryptionKeyStatus String Enabled

密钥的状态。返回值:

  • Enabled:启用。
  • Disabled:未启用。
Origin String Aliyun_KMS

密钥的来源。

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

密钥过期时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

AliasName String alias/xxx

密钥别名。

UsedBy String master

RDS实例类型,返回值:

  • master:主实例。
  • slave:只读实例。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceEncryptionKey
&RegionId=cn-hangzhou
&DBInstanceId=rm-uf6wjk5xxxxxxx
&EncryptionKey=749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx
&TargetRegionId=cn-qingdao
&公共请求参数

正常返回示例

XML格式

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

<DescribeDBInstanceEncryptionKeyResponse>
    <DeleteDate>2022-05-08T08:14:16Z</DeleteDate>
    <RequestId>3BC2768E-DEDA-40FC-BBE9-6B884F3626AF</RequestId>
    <Description>Description of the key</Description>
    <Origin>Aliyun_KMS</Origin>
    <MaterialExpireTime>2021-10-18T08:14:16Z</MaterialExpireTime>
    <EncryptionKeyStatus>Enabled</EncryptionKeyStatus>
    <KeyUsage>ENCRYPT/DECRYPT</KeyUsage>
    <EncryptionKey>5306d1b6-7fd3-42d9-9511-xxxxxxx</EncryptionKey>
    <Creator>1443*****9604</Creator>
    <EncryptionKeyList>
        <KeyType>ALIAS</KeyType>
        <EncryptionKey>5306d1b6-7fd3-42d9-9511-xxxxxxx</EncryptionKey>
        <Description>Description of the key</Description>
        <KeyUsage>ENCRYPT/DECRYPT</KeyUsage>
        <DeleteDate>2022-05-08T08:14:16Z</DeleteDate>
        <Creator>1443*****9604</Creator>
        <EncryptionKeyStatus>Enabled</EncryptionKeyStatus>
        <Origin>Aliyun_KMS</Origin>
        <MaterialExpireTime>2021-10-18T08:14:16Z</MaterialExpireTime>
        <AliasName>alias/xxx</AliasName>
        <UsedBy>master</UsedBy>
    </EncryptionKeyList>
</DescribeDBInstanceEncryptionKeyResponse>

JSON格式

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

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

错误码

HttpCode 错误码 错误信息 描述
403 NoActiveBYOK This custins no active byok. 客户实例没有开通 byok

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