Release Notes
Product Announcements
Domain name for API request: postgres.intl.tencentcloudapi.com.
This API is used to modify the AZs where the nodes of a source instance reside.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ModifyDBInstanceDeployment. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| DBInstanceId | Yes | String | Instance ID. |
| DBNodeSet.N | Yes | Array of DBNode | Deployment information of the instance node, which will display the information of each AZ when the instance node is deployed across multiple AZs. The information of AZ can be obtained from the Zone field in the returned value of the DescribeZones API. |
| SwitchTag | Yes | Integer | Switch time after instance configurations are modified. Default value: 0 |
| SwitchStartTime | No | String | Switch start time in the format of HH:MM:SS, such as 01:00:00. When SwitchTag is 0 or 2, this parameter becomes invalid. |
| SwitchEndTime | No | String | Switch end time in the format of HH:MM:SS, such as 01:30:00. When SwitchTag is 0 or 2, this parameter becomes invalid. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to modify the node deployment of instance "postgres-abcd1234" so that both primary and standby nodes reside in Guangzhou Zone 3.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceDeployment
<Common request parameters>
{
"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"
}
}
This example shows you how to modify the node deployment of instance "postgres-abcd1234" so that the primary node resides in Guangzhou Zone 1 and the standby node in Guangzhou Zone 7.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceDeployment
<Common request parameters>
{
"SwitchStartTime": "12:00:00",
"DBNodeSet": [
{
"Role": "Standby",
"Zone": "ap-guangzhou-7"
},
{
"Role": "Primary",
"Zone": "ap-guangzhou-1"
}
],
"DBInstanceId": "postgres-abcd1234",
"SwitchTag": "1",
"SwitchEndTime": "12:30:00"
}
{
"Response": {
"RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.CamSigAndAuthError | Authentication failed. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.DatabaseAccessError | Failed to access database management service. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.FailedOperationError | Operation failed. Please try again later. |
| InternalError.InternalHttpServerError | An exception occurred while executing the request. |
| InvalidParameterValue.InvalidParameterValueError | Incorrect parameter value |
| InvalidParameterValue.InvalidZoneIdError | Invalid availability zone. |
| OperationDenied.CamDeniedError | This operation cannot be performed. |
| OperationDenied.InstanceStatusLimitError | This operation cannot be performed on an instance in this status. |
| OperationDenied.InstanceStatusLimitOpError | This operation cannot be performed on an instance in this status. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback