All Products
Search

This Product

    :DescribeEncryptionDBSecret

    Document Center

    :DescribeEncryptionDBSecret

    Last Updated:Nov 20, 2025

    Queries encryption key information.

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

    none

    *DBCluster

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

    None

    None

    Request syntax

    POST  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    DBClusterId

    string

    No

    The cluster ID.

    pc-wz9fb5nn44u1d****

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    944CED46-A6F7-40C6-B6DC-C6E5CC******

    EncryptionKeyStatus

    string

    The status of the key. Valid values:

    • Enabled

    • Disabled

    Disabled

    EncryptionKey

    string

    The custom key ID.

    2a4f4ac2-****-****-****-************

    EncryptionDBStatus

    string

    Indicates whether encryption is enabled. Valid values:

    Enabled: Encryption is enabled. Disabled: Encryption is disabled.

    cn-beijing

    DBClusterId

    string

    The cluster ID.

    pc-*************

    EncryptionDBRegion

    string

    The region where the encryption key is located.

    Enabled

    Examples

    Success response

    JSON format

    {
  "RequestId": "944CED46-A6F7-40C6-B6DC-C6E5CC******",
  "EncryptionKeyStatus": "Disabled",
  "EncryptionKey": "2a4f4ac2-****-****-****-************",
  "EncryptionDBStatus": "cn-beijing",
  "DBClusterId": "pc-*************",
  "EncryptionDBRegion": "Enabled"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.