变更PolarDB集群节点规格。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 集群 ID。 | pc-************* |
ModifyType | string | 是 | 变更类型,取值范围如下:
| Upgrade |
DBNodeTargetClass | string | 是 | 所有节点的目标规格,请参见计算节点规格。 | polar.mysql.x4.large |
ClientToken | string | 否 | 用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,保证在不同请求间唯一,大小写敏感、不超过 64 个 ASCII 字符。 | 6000170000591aed949d0f54a343f1a4233c1e7d1c5c****** |
PlannedStartTime | string | 否 | 开始执行定时(即在目标时间段内执行)升降级配置任务的最早时间。格式为 说明
ModifyType 取值为Upgrade 或Downgrade 时,该参数生效。2021-01-14T09:00:00Z ,此处允许填入的开始时间范围为2021-01-14T09:00:00Z ~2021-01-15T09:00:00Z 。 | 2021-01-14T09:00:00Z |
PlannedEndTime | string | 否 | 开始执行目标定时任务的最晚时间。格式为 说明
PlannedStartTime 但未指定该参数,执行目标任务的最晚时间默认为开始时间+30 分钟 。例如当设置PlannedStartTime 为2021-01-14T09:00:00Z 且该参数留空时,目标任务最晚将于2021-01-14T09:30:00Z 开始执行。 | 2021-01-14T09:30:00Z |
SubCategory | string | 否 | 集群子系列。取值范围如下:
若独享共享之间规格相互变配,subcategory 这个字段为必填项 | normal_general |
DBNodeType | string | 否 | 节点类型。固定取值为 DLNode。 枚举值:
| DLNode |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "685F028C-4FCD-407D-A559-072D63******",
"DBClusterId": "pc-*************",
"OrderId": "2035629******"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ORDER.ARREARAGE | 您有欠费账单,不符合购买条件,请先结清账单后再购买 | 您有欠费账单,不符合购买条件,请先结清账单后再购买 |
400 | InsufficientResourceCapacity | The resource is insufficient. | 资源不足。 |
400 | InvalidModifyType.Malformed | The specified parameter ModifyType is not valid. | 指定的参数ModifyType无效。 |
403 | OperationDenied.RoEqualSpec | must exist at least ro class equal with rw | 必须至少存在与rw相等的ro类 |
403 | OperationDenied.DBClusterStatus | The operation is not permitted due to status of cluster. | PolarDB集群当前状态下不允许执行该操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-09-13 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-09-12 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-06-12 | OpenAPI 错误码发生变更 | 查看变更详情 |