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

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

调试

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

调试

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	实例所在的地域ID。可调用DescribeRegions接口获取。	cn-hangzhou
DBInstanceId	string	是	实例ID。可调用DescribeDBInstances接口获取。	rm-uf6wjk5xxxxxxx
EncryptionKey	string	否	自定义密钥ID。	749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx
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-xxxxxxx
Creator	string	密钥的创建者。	1443*****9604
EncryptionKeyList	array	密钥列表。
	object	密钥列表。
KeyType	string	Key的类型。	ALIAS
EncryptionKey	string	密钥ID。	5306d1b6-7fd3-42d9-9511-xxxxxxx
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/xxx
UsedBy	string	RDS实例类型，返回值： master：主实例。 slave：只读实例。	master

示例

正常返回示例

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"
    }
  ]
}

错误码

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

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