调用DescribeDBInstanceEncryptionKey接口查询MongoDB实例的某个密钥详情。

使用说明

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBInstanceEncryptionKey

系统规定参数。取值:DescribeDBInstanceEncryptionKey

RegionId String cn-hangzhou

实例所属的地域ID。您可以通过调用DescribeDBInstanceAttribute接口查询。

DBInstanceId String dds-bp2235****

实例ID。

TargetRegionId String cn-hangzhou-h

可用区ID。您可以通过调用DescribeDBInstanceAttribute接口查询。

EncryptionKey String 2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

可以输入一个实例自定义密钥。您可以调用DescribeUserEncryptionKeyList查询实例的自定义密钥列表。

返回数据

名称 类型 示例值 描述
Origin String Aliyun_KMS

实例密钥的来源。

Description String key description example

实例密钥的描述。

RequestId String 783C2062-A2D3-4EA8-88AD-E43F990C23BB

请求ID。

EncryptionKeyStatus String Enabled

实例密钥状态。

  • Enabled:实例密钥可用。
  • Disabled:实例密钥不可用。
MaterialExpireTime String 2020-07-06T18:22:03Z

密钥的过期时间(UTC)。当该值为空时,表示密钥不会过期。

KeyUsage String ENCRYPT/DECRYPT

实例密钥的用途。

EncryptionKey String 2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

实例密钥。

Creator String 123456

密钥创建者UID。

DeleteDate String 2020-07-06T18:22:03Z

实例密钥的预计删除时间。当该值为空时,表示密钥不会被自动删除。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=DescribeDBInstanceEncryptionKey
&DBInstanceId=dds-bp2235****
&EncryptionKey=2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstanceEncryptionKeyResponse>
    <Origin>Aliyun_KMS</Origin>
    <Description>key description example</Description>
    <RequestId>783C2062-A2D3-4EA8-88AD-E43F990C23BB</RequestId>
    <EncryptionKeyStatus>Enabled</EncryptionKeyStatus>
    <MaterialExpireTime>2020-07-06T18:22:03Z</MaterialExpireTime>
    <KeyUsage>ENCRYPT/DECRYPT</KeyUsage>
    <EncryptionKey>2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</EncryptionKey>
    <Creator>123456</Creator>
    <DeleteDate>2020-07-06T18:22:03Z</DeleteDate>
</DescribeDBInstanceEncryptionKeyResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Origin" : "Aliyun_KMS",
  "Description" : "key description example",
  "RequestId" : "783C2062-A2D3-4EA8-88AD-E43F990C23BB",
  "EncryptionKeyStatus" : "Enabled",
  "MaterialExpireTime" : "2020-07-06T18:22:03Z",
  "KeyUsage" : "ENCRYPT/DECRYPT",
  "EncryptionKey" : "2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "Creator" : "123456",
  "DeleteDate" : "2020-07-06T18:22:03Z"
}

错误码

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