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

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

接口说明

适用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
rds:DescribeDBInstanceEncryptionKey	Read	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	实例所在的地域 ID。可调用 DescribeRegions 接口获取。	cn-hangzhou
DBInstanceId	string	是	实例 ID。可调用 DescribeDBInstances 接口获取。	rm-uf6wjk5****
EncryptionKey	string	否	自定义密钥 ID。	749c1df7-**---**
TargetRegionId	string	否	目标地域 ID。可调用 DescribeRegions 接口获取。	cn-qingdao

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
DeleteDate	string	预计删除密钥时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2022-05-08T08:14:16Z
RequestId	string	请求 ID。	3BC2768E-DEDA-40FC-BBE9-6B884F3626AF
Description	string	密钥描述。	Description of the key
Origin	string	密钥的来源。	Aliyun_KMS
MaterialExpireTime	string	密钥过期时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2021-10-18T08:14:16Z
EncryptionKeyStatus	string	密钥的状态。返回值： Enabled：启用。 Disabled：未启用。	Enabled
KeyUsage	string	密钥用途。	ENCRYPT/DECRYPT
EncryptionKey	string	密钥 ID。	5306d1b6-7fd3-42d9-9511-****
Creator	string	密钥的创建者。	1443****9604
EncryptionKeyList	object []	密钥列表。
KeyType	string	Key 的类型。返回值说明： CMK：用户自定义密钥 ServiceKey：服务密钥	ServiceKey
EncryptionKey	string	密钥 ID。	5306d1b6-7fd3-42d9-9511-****
Description	string	密钥描述。	Description of the key
KeyUsage	string	密钥用途。	ENCRYPT/DECRYPT
DeleteDate	string	预计删除密钥时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2022-05-08T08:14:16Z
Creator	string	密钥的创建者。	1443****9604
EncryptionKeyStatus	string	密钥的状态。返回值： Enabled：启用。 Disabled：未启用。	Enabled
Origin	string	密钥的来源。	Aliyun_KMS
MaterialExpireTime	string	密钥过期时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2021-10-18T08:14:16Z
AliasName	string	密钥别名。	alias/****
UsedBy	string	密钥的使用途径： 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	错误码	错误信息	描述
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	套餐实例不允许单独操作。
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	定价计划价格结果没有找到。
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	您还未通过实名认证，不符合购买条件，请登录用户中心进行实名认证。
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	您的账户可用额度小于0，请先充值后再尝试购买。
400	CommodityServiceCalling.Exception	Failed to call commodity service.	调用商品服务返回失败。
403	NoActiveBYOK	This custins no active byok.	实例暂未开通云盘加密功能。
403	ByokInsnameAndRegionAllEmpty	The insName and targetRegionId can't be all empty.	实例名称和地域不能都为空。

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

变更历史

变更时间

变更内容概要

操作

2023-07-12

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	错误码 403 变更