FailoverDBCluster_云数据库 PolarDB_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为200/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
polardb:FailoverDBCluster
Update
dbcluster
acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

请求参数

字段名称字段详情
DBClusterIdstring

数据库集群 ID。

示例值:pc-**************参考取值来源:
    ModifyDBCluster
    CreateDBCluster
    DescribeDBClusters
    TransformDBClusterPayType
    EnableDBClusterServerless
    RestartDBLink
    DisableDBClusterServerless
TargetDBNodeIdstring

将要切换为主节点的节点 ID,如果不填,则系统自动选举。您可以通过接口 DescribeDBClusters 查询节点 ID 等信息。展开详情

示例值:pi-***********
RollBackForDisasterboolean

是否是故障切换后的回切至原主可用区,取值范围如下:展开详情

示例值:false
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,保证在不同请求间唯一,大小写敏感、不超过 64 个 ASCII 字符。

示例值:6000170000591aed949d0f54a343f1a4233c1e7d1c5******
TargetZoneTypestring

是否是主可用区内主备切换,取值如下:展开详情

示例值:Primary枚举值:PrimaryStandby

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:D0CEC6AC-7760-409A-A0D5-E6CD86******

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
HaStatusNotSupport
Current DB instance HA status does not support this operation.诊断
400
InvalidDBNodeId.Malformed
The specified parameter DBNodeId is not valid.诊断
400
InvalidDBType.Malformed
The Specified DBType is not valid.诊断
400
UnsupportHighFrequenceSwitchOver
The instance has switch over too frequent within ten minutes.诊断
400
UnsupportWitchUnhealthyReplication
The action is unsupported with unhealthy replication.诊断
403
OperationDenied.DBNodeType
The operation is not permitted due to type of node.诊断
403
OperationDenied.ClusterCategory
The operation is not permitted due to cluster category.诊断
404
InvalidDBCluster.NotFound
The DBClusterId provided does not exist in our records.诊断
404
InvalidDBClusterId.Malformed
The specified parameter DBClusterId is not valid.诊断

变更历史

变更时间变更内容概要操作
2024-08-20
变更错误码400
2024-08-08
新增请求参数TargetZoneType
2023-12-07
新增请求参数RollBackForDisaster
2023-09-12
变更错误码400
变更错误码403
变更错误码404
2023-06-12
新增错误码403
2022-06-10
新增错误码400