DescribeKmsKeys - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries Key Management Service (KMS) keys that are available for disk encryption.

Operation description

Queried keys are available only for disk encryption.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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 Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
dds:DescribeKmsKeys	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	60EEBD77-227C-5B39-86EA-D89163C5****
KmsKeys	array<object>	The KMS keys.
	object
KeyAlias	string	The alias of the key.	key-shh656820f4mh9qxxxxx alias/test1
KeyId	string	The key ID.	37291352-xxxx-xxxx-adbf-fd0630a95583

Examples

Sample success responses

JSONformat

{
  "RequestId": "60EEBD77-227C-5B39-86EA-D89163C5****",
  "KmsKeys": [
    {
      "KeyAlias": "key-shh656820f4mh9qxxxxx     alias/test1",
      "KeyId": "37291352-xxxx-xxxx-adbf-fd0630a95583"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
404	EntityNotExistUser	The User does not exist.
404	EntityNotExistService	The Service mongodb.aliyuncs.com does not exist.
404	NoPermissionService	The Account NoPermission Error! Please Authorize The Account! Service Name: mongodb.aliyuncs.com, SLR Role:AliyunServiceRoleForMongoDB.
409	EntityAlreadyExistsRole	The Role already exists:AliyunServiceRoleForMongoDB.

For a list of error codes, visit the Service error codes.