All Products
Search

This Product

    PolarDB:DescribeDBClusterServerlessConf

    Document Center

    PolarDB:DescribeDBClusterServerlessConf

    Last Updated:Dec 15, 2025

    Queries the configuration of a serverless cluster.

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

    get

    *DBCluster

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

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    DBClusterId

    string

    Yes

    The ID of the serverless cluster.

    pc-bp10gr51qasnl****

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    5E71541A-6007-4DCC-A38A-F872C31FEB45

    ScaleMin

    string

    The minimum number of PolarDB Capacity Units (PCUs) for a single node. Valid values: 1 to 31.

    1

    ScaleMax

    string

    The maximum number of PCUs for a single node. Valid values: 1 to 32.

    3

    ScaleRoNumMin

    string

    The minimum number of read-only nodes for scaling. Valid values: 0 to 15.

    2

    ScaleRoNumMax

    string

    The maximum number of read-only nodes for scaling. Valid values: 0 to 15.

    4

    AllowShutDown

    string

    Indicates whether No-activity Suspension is enabled. Valid values:

    • true: Enabled

    • false: Disabled (Default)

    true

    SecondsUntilAutoPause

    string

    The period of inactivity in seconds after which the cluster is automatically paused. Valid values: 300 to 86,400. The value must be a multiple of 300.

    10

    DBClusterId

    string

    The ID of the serverless cluster.

    pc-bp10gr51qasnl****

    ScaleApRoNumMin

    string

    The minimum number of read-only column store nodes. Valid values: 0 to 15.

    1

    ScaleApRoNumMax

    string

    The maximum number of read-only column store nodes. Valid values: 0 to 15.

    1

    Switchs

    string

    Indicates whether steady-state is enabled. Valid values:

    1: Enabled

    0: Disabled

    1

    ServerlessRuleMode

    string

    The elasticity sensitivity. Valid values:

    • normal: Standard

    • flexible: Flexible

    normal

    ServerlessRuleCpuEnlargeThreshold

    string

    The CPU utilization threshold for scaling up.

    60

    ServerlessRuleCpuShrinkThreshold

    string

    The CPU utilization threshold for scaling down.

    30

    TraditionalScaleMaxThreshold

    string

    AgileScaleMax

    string

    Examples

    Success response

    JSON format

    {
  "RequestId": "5E71541A-6007-4DCC-A38A-F872C31FEB45",
  "ScaleMin": "1",
  "ScaleMax": "3",
  "ScaleRoNumMin": "2",
  "ScaleRoNumMax": "4",
  "AllowShutDown": "true",
  "SecondsUntilAutoPause": "10",
  "DBClusterId": "pc-bp10gr51qasnl****",
  "ScaleApRoNumMin": "1",
  "ScaleApRoNumMax": "1",
  "Switchs": "1",
  "ServerlessRuleMode": "normal",
  "ServerlessRuleCpuEnlargeThreshold": "60",
  "ServerlessRuleCpuShrinkThreshold": "30",
  "TraditionalScaleMaxThreshold": "",
  "AgileScaleMax": ""
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description

    400

    InvalidDBClusterId.Malformed

    The specified parameter DBClusterId is not valid.

    400

    InvalidEngine.Unsupported

    The specified Engine does not support this feature.

    This feature is not supported by the specified engine.

    403

    OperationDenied.ClusterCategory

    The operation is not permitted due to cluster category.

    This series is not supported by the cluster.

    404

    InvalidDBCluster.NotFound

    The DBClusterId provided does not exist in our records.

    The specified DBClusterId parameter does not exist in the current record.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.