Retrieve a list of KMS keys by using DescribeUserEncryptionKeyList - PolarDB - Alibaba Cloud - PolarDB

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

polardb:DescribeUserEncryptionKeyList

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The page size. Valid values: 10 : 10 entries per page. 30 : 30 entries per page. 50 : 50 entries per page. 100 : 100 entries per page.	30
PageNumber	integer	No	The page number.	1
DBClusterId	string	No	The cluster ID. Note You can call the DescribeDBClusters operation to query information about all clusters in the specified region, including the cluster ID.	pc-************
RegionId	string	No	The region ID. Note You can call the DescribeRegions operation to query the available regions for the current account, including the region ID.	cn-hangzhou
TDERegion	string	No	The region where the TDE key resides.	cn-beijing

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	A7E6A8FD-C50B-46B2-BA85-D8B8D3******
KeyList	array	The list of cluster keys.
	string	The list of keys.	0275bd3f-fdbb-4d8c-846b-71b211******
TotalRecordCount	integer	The total number of records.	1
PageRecordCount	integer	The number of records on the current page.	1
PageNumber	integer	The page number.	1
PageSize	integer	The page size.	30
DBClusterId	string	The cluster ID.	pc-************

Examples

Success response

JSON format

{
  "RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
  "KeyList": [
    "0275bd3f-fdbb-4d8c-846b-71b211******"
  ],
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "PageSize": 30,
  "DBClusterId": "pc-************"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ByokRoleArnNotFound	The roleArn can't be null.
401	ByokNotAuthorizedToRds	This user is not Authorized Rds.	This user is not authorized by ApsaraDB RDS.
403	UnsupportedKmsService.NotEnabled	KMS service is not enabled.	Key Management Service is not enabled.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.