1. 接口描述
接口请求域名： postgres.tencentcloudapi.com 。
本接口（ModifyDBInstanceDeployment）用于修改节点可用区部署方式，仅支持主实例。
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyDBInstanceDeployment。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DBInstanceId | 是 | String | 实例ID。 示例值：postgres-abcd1234 |
| DBNodeSet.N | 是 | Array of DBNode | 实例节点部署信息，支持多可用区部署时需要指定每个节点的部署可用区信息。 可用区信息可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。 |
| SwitchTag | 是 | Integer | 指定实例配置完成变更后的切换时间。 默认值：0 示例值：1 |
| SwitchStartTime | 否 | String | 切换开始时间，时间格式：HH:MM:SS，例如：01:00:00。当SwitchTag为0或2时，该参数失效。 示例值：12:00:00 |
| SwitchEndTime | 否 | String | 切换截止时间，时间格式：HH:MM:SS，例如：01:30:00。当SwitchTag为0或2时，该参数失效。 示例值：12:30:00 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 实例修改为单可用区
将实例postgres-abcd1234主节点可用区调整广州3区，备节点调整为广州3区。
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceDeployment
<公共请求参数>
{
"SwitchStartTime": "12:00:00",
"DBNodeSet": [
{
"Role": "Standby",
"Zone": "ap-guangzhou-3"
},
{
"Role": "Primary",
"Zone": "ap-guangzhou-3"
}
],
"DBInstanceId": "postgres-abcd1234",
"SwitchTag": "1",
"SwitchEndTime": "12:30:00"
}输出示例
{
"Response": {
"RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
}
}示例2 实例修改为跨可用区
将实例postgres-abcd1234主节点可用区调整广州1区，备节点调整为广州2区。
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceDeployment
<公共请求参数>
{
"SwitchStartTime": "12:00:00",
"DBNodeSet": [
{
"Role": "Standby",
"Zone": "ap-guangzhou-2"
},
{
"Role": "Primary",
"Zone": "ap-guangzhou-1"
}
],
"DBInstanceId": "postgres-abcd1234",
"SwitchTag": "1",
"SwitchEndTime": "12:30:00"
}输出示例
{
"Response": {
"RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.CamSigAndAuthError | 鉴权失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.DatabaseAccessError | 管控元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.FailedOperationError | 操作失败，请稍后重试。 |
| InternalError.InternalHttpServerError | 请求执行异常。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
| InvalidParameterValue.InvalidZoneIdError | 无效的可用区。 |
| OperationDenied.CamDeniedError | 当前操作被限制。 |
| OperationDenied.InstanceStatusLimitError | 实例当前状态限制本次操作。 |
| OperationDenied.InstanceStatusLimitOpError | 实例状态限制当前操作。 |