All Products
Search
Document Center

PolarDB:DescribeDBClusterServerlessConf

Last Updated:Dec 19, 2024
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query serverless configuration.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DescribeDBClusterServerlessConfget
*DBCluster
acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

Serverless cluster ID.

pc-bp10gr51qasnl****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Request ID.

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

Minimum scaling limit for a single node. Range: 1 PCU~31 PCU.

1
ScaleMaxstring

Maximum scaling limit for a single node. Range: 1 PCU~32 PCU.

3
ScaleRoNumMinstring

Minimum scaling limit for the number of read-only nodes. Range: 0~15.

2
ScaleRoNumMaxstring

Maximum scaling limit for the number of read-only nodes. Range: 0~15.

4
AllowShutDownstring

Whether to enable idle shutdown. Values:

  • true: Enable

  • false: Disable (default)

true
SecondsUntilAutoPausestring

Detection duration for idle shutdown. Range: 300~86,400. Unit: seconds. The detection duration must be a multiple of 300 seconds.

10
DBClusterIdstring

Serverless cluster ID.

pc-bp10gr51qasnl****
ScaleApRoNumMinstring

Minimum limit for the number of read-only column storage nodes. Range: 0~7.

1
ScaleApRoNumMaxstring

Maximum limit for the number of read-only column storage nodes. Range: 0~7.

1
Switchsstring

Whether steady state is enabled. Values:

1: Enabled

0: Disabled

1
ServerlessRuleModestring

Elasticity sensitivity. Values:

  • normal: Standard

  • flexible: Sensitive

normal
ServerlessRuleCpuEnlargeThresholdstring

CPU upscale threshold.

60
ServerlessRuleCpuShrinkThresholdstring

CPU downscale threshold.

30

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****",
  "ScaleApRoNumMin": "1",
  "ScaleApRoNumMax": "1",
  "Switchs": "1",
  "ServerlessRuleMode": "normal",
  "ServerlessRuleCpuEnlargeThreshold": "60",
  "ServerlessRuleCpuShrinkThreshold": "30",
  "TraditionalScaleMaxThreshold": "",
  "AgileScaleMax": ""
}

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
2024-07-30The Error code has changed. The response structure of the API has changedView Change Details
2024-05-17The Error code has changed. The response structure of the API has changedView Change Details
2023-09-25The Error code has changed. The response structure of the API has changedView Change Details
2023-09-12The Error code has changedView Change Details
2023-04-24The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
2023-03-30The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details