All Products
Search

This Product

    ApsaraDB for ClickHouse:DescribeUserEncryptionKeyList

    Document Center

    ApsaraDB for ClickHouse:DescribeUserEncryptionKeyList

    Last Updated:Dec 10, 2025

    Retrieves a list of your KMS keys.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID.

    cn-hangzhou
    PageNumber

    string

    No

    The page number.

    1
    PageSize

    string

    No

    The number of entries per page. Valid values:

    • 30 (default)

    • 50

    • 100

    30

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC
    KmsKeys

    array<object>

    The list of KMS keys.

    object

    The list of KMS keys.

    KeyId

    string

    The key ID.

    0275bd3f-fdbb-4d8c-846b-71b211******

    Examples

    Success response

    JSON format

    {
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC",
  "KmsKeys": [
    {
      "KeyId": "0275bd3f-fdbb-4d8c-846b-71b211******\n"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.