DescribeKmsKeys - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Operation description

Queried keys are available only for disk encryption.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:DescribeKmsKeys

get

*All Resource

*

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

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.