文档

DescribeDBInstanceEncryptionKey - 查询云盘加密状态及密钥详情

更新时间:

查询RDS实例是否开启了云盘加密,以及密钥详情。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeDBInstanceEncryptionKeyRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
DBInstanceIdstring

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

rm-uf6wjk5****
EncryptionKeystring

自定义密钥 ID。

749c1df7-****-****-****-****
TargetRegionIdstring

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

cn-qingdao

返回参数

名称类型描述示例值
object

返回参数详情。

DeleteDatestring

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

2022-05-08T08:14:16Z
RequestIdstring

请求 ID。

3BC2768E-DEDA-40FC-BBE9-6B884F3626AF
Descriptionstring

密钥描述。

Description of the key
Originstring

密钥的来源。

Aliyun_KMS
MaterialExpireTimestring

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

2021-10-18T08:14:16Z
EncryptionKeyStatusstring

密钥的状态。返回值:

  • Enabled:启用。
  • Disabled:未启用。
Enabled
KeyUsagestring

密钥用途。

ENCRYPT/DECRYPT
EncryptionKeystring

密钥 ID。

5306d1b6-7fd3-42d9-9511-****
Creatorstring

密钥的创建者。

1443****9604
EncryptionKeyListobject []

密钥列表。

KeyTypestring

Key 的类型。返回值说明:

  • CMK:用户自定义密钥
  • ServiceKey:服务密钥
ServiceKey
EncryptionKeystring

密钥 ID。

5306d1b6-7fd3-42d9-9511-****
Descriptionstring

密钥描述。

Description of the key
KeyUsagestring

密钥用途。

ENCRYPT/DECRYPT
DeleteDatestring

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

2022-05-08T08:14:16Z
Creatorstring

密钥的创建者。

1443****9604
EncryptionKeyStatusstring

密钥的状态。返回值:

  • Enabled:启用。
  • Disabled:未启用。
Enabled
Originstring

密钥的来源。

Aliyun_KMS
MaterialExpireTimestring

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

2021-10-18T08:14:16Z
AliasNamestring

密钥别名。

alias/****
UsedBystring

密钥的使用途径:

  • TDE:透明数据加密。
  • DiskEncryption:云盘加密。
TDE

示例

正常返回示例

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-****",
  "Creator": "1443****9604",
  "EncryptionKeyList": [
    {
      "KeyType": "ServiceKey",
      "EncryptionKey": "5306d1b6-7fd3-42d9-9511-****",
      "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/****",
      "UsedBy": "TDE"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403NoActiveBYOKThis custins no active byok.实例暂未开通云盘加密功能。
403ByokInsnameAndRegionAllEmptyThe insName and targetRegionId can't be all empty.实例名称和地域不能都为空。

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

变更历史

变更时间变更内容概要操作
2023-07-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
  • 本页导读 (1)
文档反馈