Queries the details of a key for an ApsaraDB for MongoDB instance.
Operation Description
Usage
When you call the DescribeDBInstanceEncryptionKey operation, the instance must have transparent data encryption (TDE) enabled in BYOK mode. You can call the ModifyDBInstanceTDE operation to enable TDE.
Authorization information
The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action
Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All resources
is used in the Resource type column of the operation.
- Condition keyword: refers to the condition keyword defined by the cloud product itself.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operate | access level | Resource type | conditional keyword | Association operation |
---|---|---|---|---|
dds:DescribeDBInstanceEncryptionKey | READ |
|
|
without |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes |
The ID of the instance. |
dds-bp2235**** |
EncryptionKey | string | No |
The custom key for the instance. You can call the DescribeUserEncryptionKeyList operation to query the list of custom keys for an ApsaraDB for MongoDB instance. |
2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
Response parameters
Example
Normal return example
JSON
Format
{
"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"
}
Error codes
Http code | Error code | Error message |
---|---|---|
403 | INVALID_INSNAME_REGIONID_EMPTY | The insName and regionId can't be all empty |
403 | NO_ACTIVE_BYOK | This custins no active byok. |
For a list of error codes, visit the API error center.