All Products
Search
Document Center

PolarDB:DescribeDBClusterServerlessConf

Last Updated:Apr 25, 2024

Queries the configurations of a serverless cluster.

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
polardb:DescribeDBClusterServerlessConfRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the serverless cluster.

pc-bp10gr51qasnl****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

5E71541A-6007-4DCC-A38A-F872C31FEB45
ScaleMinstring

The minimum number of PCUs per node for scaling. Valid values: 1 PCU to 31 PCUs.

1
ScaleMaxstring

The maximum number of PCUs per node for scaling. Valid values: 1 PCU to 32 PCUs.

3
ScaleRoNumMinstring

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

2
ScaleRoNumMaxstring

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

4
AllowShutDownstring

Indicates whether the no-activity suspension feature is enabled. Default value: false. Valid values:

  • true
  • false
true
SecondsUntilAutoPausestring

The detection period for no-activity suspension. Valid values: 300 to 86400. Unit: seconds. The value must be a multiple of 300.

10
DBClusterIdstring

The ID of the serverless cluster.

pc-bp10gr51qasnl****

Examples

Sample success responses

JSONformat

{
  "RequestId": "5E71541A-6007-4DCC-A38A-F872C31FEB45",
  "ScaleMin": "1",
  "ScaleMax": "3",
  "ScaleRoNumMin": "2",
  "ScaleRoNumMax": "4",
  "AllowShutDown": "true",
  "SecondsUntilAutoPause": "10",
  "DBClusterId": "pc-bp10gr51qasnl****"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.
400InvalidEngine.UnsupportedThe specified Engine does not support this feature.This feature is not supported by the specified engine.
403OperationDenied.ClusterCategoryThe operation is not permitted due to cluster category.This series is not supported by the cluster.
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.

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

Change history

Change timeSummary of changesOperation
2023-09-25The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.
2023-09-12The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 404
    Added Error Codes: 403
2023-04-24The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: RequestType
Output ParametersThe response structure of the API has changed.
2023-03-30The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: RequestType
Output ParametersThe response structure of the API has changed.