全部产品
Search
文档中心

云数据库 MongoDB:DescribeDBInstanceEncryptionKey - 查询MongoDB实例的某个密钥的详情

更新时间:Jan 17, 2023

查询MongoDB实例的某个密钥的详情。

接口说明

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 访问级别 资源类型 条件关键字 关联操作
dds:DescribeDBInstanceEncryptionKey READ
  • MongoDB
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称 类型 必填 描述 示例值
DBInstanceId string

实例ID。

dds-bp2235****
EncryptionKey string

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

2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

返回参数

名称 类型 描述 示例值
object

返回数据。

Origin string

实例密钥的来源。

Aliyun_KMS
Description string

实例密钥的描述。

key description example
RequestId string

请求ID。

783C2062-A2D3-4EA8-88AD-E43F990C23BB
EncryptionKeyStatus string

实例密钥状态。

  • Enabled:实例密钥可用。
  • Disabled:实例密钥不可用。
Enabled
MaterialExpireTime string

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

2020-07-06T18:22:03Z
KeyUsage string

实例密钥的用途。

ENCRYPT/DECRYPT
EncryptionKey string

实例密钥。

2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Creator string

密钥创建者UID。

123456
DeleteDate string

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

2020-07-06T18:22:03Z

示例

正常返回示例

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

错误码

Http code 错误码 错误信息
403 INVALID_INSNAME_REGIONID_EMPTY The insName and regionId can't be all empty
403 NO_ACTIVE_BYOK This custins no active byok.

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