云数据库 PostgreSQL 切换实例主备关系-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： postgres.tencentcloudapi.com 。

本接口（SwitchDBInstancePrimary）用于切换实例主备关系。

通过主动发起切换，可以验证业务能否正确处理实例主备切换的场景

通过使用强制切换，可以在备节点延迟不满足切换条件时，强制发起主从切换

只有主实例可以执行该操作

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：SwitchDBInstancePrimary。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
DBInstanceId	是	String	实例ID 示例值：postgres-aser1j2o
Force	否	Boolean	是否强制切换。强制切换时只要备节点可访问，无论主备延迟多大都会发起切换。只有SwitchTag为0时，才可使用立即切换。默认：false 示例值：true
SwitchTag	否	Integer	指定实例配置完成变更后的切换时间。 0：立即切换 1：指定时间切换 2：维护时间窗口内切换默认值：0 示例值：1
SwitchStartTime	否	String	切换开始时间，时间格式：HH:MM:SS，例如：01:00:00。当SwitchTag为0或2时，该参数失效。示例值：01:00:00
SwitchEndTime	否	String	切换截止时间，时间格式：HH:MM:SS，例如：01:30:00。当SwitchTag为0或2时，该参数失效。SwitchStartTime和SwitchEndTime时间窗口不能小于30分钟。示例值：01:30:00

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 切换实例主备关系

切换实例postgres-idabksrn的主备关系，采用非强制切换，并立即切换

输入示例

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SwitchDBInstancePrimary
<公共请求参数>

{
    "DBInstanceId": "postgres-idabksrn"
}

输出示例

{
    "Response": {
        "RequestId": "54eeac1a-1d21-43d9-8293-1352d5874860"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.DatabaseAccessError	管控元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.FailedOperationError	操作失败，请稍后重试。
FailedOperation.FlowCreateError	创建流程失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.NoAvailableStandby	实例无可用备机
InvalidParameter.ParameterCheckError	参数检查失败。
InvalidParameterValue.InvalidParameterValueError	参数值有误。
OperationDenied.CamDeniedError	当前操作被限制。
OperationDenied.InstanceStatusLimitError	实例当前状态限制本次操作。
OperationDenied.InstanceTypeDenied	实例类型错误
ResourceNotFound.InstanceNotFoundError	实例不存在。

切换实例主备关系

本页目录：