开启或关闭集群热备节点。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| polardb:ModifyDBNodeHotReplicaMode | update | *DBCluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 集群 ID。 说明
您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息，包括集群 ID。
| pc-***************** |
| DBNodeId | string | 是 | 数据库集群节点 ID。 | pi-***************** |
| HotReplicaMode | string | 是 | 是否开启热备。取值范围：
| ON |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "9F4DDFBF-205C-5A3E-8DC2-C6**********",
"DBClusterId": "pc-*****************",
"OrderId": "2148126708*****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidDBNodeId.Malformed | The specified parameter DBNodeId is not valid. | 指定的参数DBNodeId无效。 |
| 404 | InvalidDBInstanceClass.NotFound | rw class code must be equal with hot replica | 热备节点规格必须保持与RW节点规格一致. |
| 404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定的参数DBClusterId无效 |
| 404 | InvalidDBNodeId.NotFound | The DBNodeId provided does not exist in our records. | 当前的记录中不存在提供的DBNodeId。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-09-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2022-01-13 | 新增 OpenAPI | 查看变更详情 |