切换全球数据库网络(GDN)中的主从集群。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
 - 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
 - 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
 - 对于不支持资源级授权的操作,用
全部资源表示。 
 - 条件关键字:是指云产品自身定义的条件关键字。
 - 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
 
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
|---|---|---|---|---|
| polardb:SwitchOverGlobalDatabaseNetwork | update | *GlobalDatabaseNetwork acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId} | 
  | 无 | 
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
|---|---|---|---|---|
| RegionId | string | 否 | 地域 ID。  | cn-qingdao | 
| DBClusterId | string | 否 | GDN 中需要切换为主集群的集群 ID。 您可以调用 DescribeGlobalDatabaseNetwork 接口查看 GDN 中的集群 ID。  | pc-wz9fb5nn44u1d**** | 
| GDNId | string | 是 | GDN ID。  | gdn-bp1fttxsrmv***** | 
| Forced | boolean | 否 | 是否强制切换 GDN 的主从集群。取值范围: 
  | false | 
| ResourceGroupId | string | 否 | 资源组 ID。  | rg-************ | 
返回参数
示例
正常返回示例
JSON格式
{
  "RequestId": "67F2E75F-AE67-4FB2-821F-A81237EACD15"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 | 
|---|---|---|---|
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 | 
| 404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 | 
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | 
|---|---|---|
| 2023-09-12 | OpenAPI 错误码发生变更 | 查看变更详情 | 
| 2022-11-17 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 | 
| 2022-07-15 | 新增 OpenAPI | 查看变更详情 | 
