DescribeDBInstanceEncryptionKey_云数据库 MongoDB 版_API文档-阿里云OpenAPI开发者门户

接口说明

调用 DescribeDBInstanceEncryptionKey 接口时，实例必须以 BYOK 的方式开启了透明数据加密 TDE。您可以调用 ModifyDBInstanceTDE 来开启 TDE。

请求速率为200/1(s)。更多流控信息，请前往配额中心查看

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

dds:DescribeDBInstanceEncryptionKey	Get	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	无	无

字段名称	字段详情
DBInstanceIdstring	实例 ID。示例值:dds-bp2235****参考取值来源: CreateDBInstance DescribeDBInstances
EncryptionKeystring	可以输入一个实例自定义密钥。您可以调用 DescribeUserEncryptionKeyList 查询实例的自定义密钥列表。示例值:2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

字段名称	字段详情
Originstring	实例密钥的来源。示例值:Aliyun_KMS
Descriptionstring	实例密钥的描述。示例值:key description example
RequestIdstring	请求 ID。示例值:783C2062-A2D3-4EA8-88AD-E43F990C23BB
EncryptionKeyStatusstring	实例密钥状态。展开详情示例值:Enabled
MaterialExpireTimestring	密钥的过期时间（UTC）。当该值为空时，表示密钥不会过期。示例值:2020-07-06T18:22:03Z
KeyUsagestring	实例密钥的用途。示例值:ENCRYPT/DECRYPT
EncryptionKeystring	实例密钥。示例值:2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Creatorstring	密钥创建者 UID。示例值:123456
DeleteDatestring	实例密钥的预计删除时间。当该值为空时，表示密钥不会被自动删除。示例值:2020-07-06T18:22:03Z

没有我想要的错误码, 点击反馈

HTTP 状态码	错误码	错误信息	操作

403	INVALID_INSNAME_REGIONID_EMPTY	The insName and regionId can't be all empty	诊断
403	NO_ACTIVE_BYOK	This custins no active byok.	诊断

暂无变更历史