调用DescribeDBInstanceEncryptionKey查询MongoDB实例的某个密钥的详情。
调用本接口时,实例必须以BYOK的方式开启了透明数据加密TDE。您可以调用ModifyDBInstanceTDE来开启TDE。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | DescribeDBInstanceEncryptionKey |
要执行的操作,取值:DescribeDBInstanceEncryptionKey。 |
DBInstanceId | String | 是 | dds-bpxxxxxxxx |
实例ID。 |
EncryptionKey | String | 否 | 2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
可以输入一个实例自定义密钥。您可以调用DescribeUserEncryptionKeyList查询实例的自定义密钥列表。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 783C2062-A2D3-4EA8-88AD-E43F990C23BB |
请求ID。 |
EncryptionKey | String | 2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
实例密钥。 |
Description | String | key description example |
实例密钥的描述。 |
KeyUsage | String | ENCRYPT/DECRYPT |
实例密钥的用途。 |
DeleteDate | String | 2020-07-06T18:22:03Z |
实例密钥的预计删除时间。当该值为空时,表示密钥不会被自动删除。 |
Creator | String | 123456 |
密钥创建者UID。 |
EncryptionKeyStatus | String | Enabled |
实例密钥状态。
|
Origin | String | Aliyun_KMS |
实例密钥的来源。 |
MaterialExpireTime | String | 2020-07-06T18:22:03Z |
密钥的过期时间(UTC)。当该值为空时,表示密钥不会过期。 |
示例
请求示例
http(s)://mongodb.aliyuncs.com/?Action=DescribeDBInstanceEncryptionKey
&DBInstanceId=dds-bpxxxxxxxx
&<公共请求参数>
正常返回示例
XML
格式
<EncryptionKey>2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</EncryptionKey>
<Description/>
<DeleteDate/>
<Creator>123456</Creator>
<RequestId>783C2062-A2D3-4EA8-88AD-E43F990C23BB</RequestId>
<MaterialExpireTime/>
<EncryptionKeyStatus>Enabled</EncryptionKeyStatus>
<Origin>Aliyun_KMS</Origin>
<KeyUsage>ENCRYPT/DECRYPT</KeyUsage>
JSON
格式
{
"EncryptionKey": "2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"Description": "",
"DeleteDate": "",
"Creator": "123456",
"RequestId": "783C2062-A2D3-4EA8-88AD-E43F990C23BB",
"MaterialExpireTime": "",
"EncryptionKeyStatus": "Enabled",
"Origin": "Aliyun_KMS",
"KeyUsage": "ENCRYPT/DECRYPT"
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交