全部产品
Search
文档中心

云原生数据库 PolarDB:DescribeDBClusterServerlessConf - 查询Serverless集群的配置

更新时间:Oct 28, 2024

查询serverless配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
polardb:DescribeDBClusterServerlessConfget
  • DBCluster
    acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}

请求参数

名称类型必填描述示例值
DBClusterIdstring

Serverless 集群 ID。

pc-bp10gr51qasnl****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

单节点伸缩下限。取值范围:1 PCU~31 PCU。

1
ScaleMaxstring

单节点伸缩上限。取值范围:1 PCU~32 PCU。

3
ScaleRoNumMinstring

只读节点个数伸缩下限。取值范围:0~15。

2
ScaleRoNumMaxstring

只读节点个数伸缩上限。取值范围:0~15。

4
AllowShutDownstring

是否开启无活动暂停。取值:

  • true:开启

  • false:关闭(默认)

true
SecondsUntilAutoPausestring

无活动暂停的检测时长。取值范围:300~86,400。单位秒。检测时长必须是 300 秒的倍数。

10
DBClusterIdstring

Serverless 集群 ID。

pc-bp10gr51qasnl****
ScaleApRoNumMinstring

只读列存节点个数下限。取值范围:0~7。

1
ScaleApRoNumMaxstring

只读列存节点个数上限。取值范围:0~7。

1
Switchsstring

稳态是否开启。取值:

1:开启

0:关闭

1
ServerlessRuleModestring

弹性灵敏度。取值:

  • normal:标准
  • flexible:灵敏
normal
ServerlessRuleCpuEnlargeThresholdstring

cpu 弹升阈值。

60
ServerlessRuleCpuShrinkThresholdstring

cpu 弹降阈值。

30

示例

正常返回示例

JSON格式

{
  "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": ""
}

错误码

HTTP status code错误码错误信息描述
400InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效
400InvalidEngine.UnsupportedThe specified Engine does not support this feature.指定的引擎不支持此功能
403OperationDenied.ClusterCategoryThe operation is not permitted due to cluster category.该集群不支持此产品系列。
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-07-30OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-05-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-09-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-09-12OpenAPI 错误码发生变更查看变更详情
2023-04-24OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-03-30OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情