All Products
Search
Document Center

AnalyticDB for PostgreSQL:DescribeUserEncryptionKeyList

Last Updated:Mar 03, 2024

Queries a list of Key Management Service (KMS) keys.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
gpdb:DescribeUserEncryptionKeyListRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

ap-southeast-1
PageNumberstringNo

The number of the page to return. Default value: 1.

1
PageSizestringNo

The number of KMS keys to return on each page. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
KmsKeysobject []

Details about the KMS keys.

KeyIdstring

The ID of the KMS key.

0b8b1825-fd99-418f-875e-e4dec1dd8715

Examples

Sample success responses

JSONformat

{
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "KmsKeys": [
    {
      "KeyId": "0b8b1825-fd99-418f-875e-e4dec1dd8715"
    }
  ]
}

Error codes

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