Domain name for API request: postgres.tencentcloudapi.com.
This API is used to modify the AZs where the nodes of a source instance reside.
A maximum of 20 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. |
DBInstanceId | Yes | String | Instance ID. |
DBNodeSet.N | Yes | Array of DBNode | Instance node information. |
SwitchTag | Yes | Integer | Switch time. Valid values: 0 (switch immediately), 1 (switch at a specified time). Default value: 0 . |
SwitchStartTime | No | String | The earliest time to start a switch in the format of "HH:MM:SS", such as "01:00:00". |
SwitchEndTime | No | String | The latest time to start a switch in the format of "HH:MM:SS", such as "01:30:00". |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to modify the node deployment of the "postgres-abcd1234" instance so that the primary node resides in Guangzhou Zone 1 and the standby node in Guangzhou Zone 2.
https://postgres.tencentcloudapi.com/?Action=ModifyDBInstanceDeployment
&DBInstanceId=postgres-abcd1234
&DBNodeSet.0.Role=Primary
&DBNodeSet.0.Zone=ap-guangzhou-1
&DBNodeSet.1.Role=Standby
&DBNodeSet.1.Zone=ap-guangzhou-2
&SwitchTag=1
&SwitchStartTime=12:00:00
&SwitchEndTime=12:30:00
&<Common request parameters>
{
"Response": {
"RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
}
}
This example shows you how to modify the node deployment of the "postgres-abcd1234" instance so that both primary and standby nodes reside in Guangzhou Zone 3.
https://postgres.tencentcloudapi.com/?Action=ModifyDBInstanceDeployment
&DBInstanceId=postgres-abcd1234
&DBNodeSet.0.Role=Primary
&DBNodeSet.0.Zone=ap-guangzhou-3
&DBNodeSet.1.Role=Standby
&DBNodeSet.1.Zone=ap-guangzhou-3
&SwitchTag=1
&SwitchStartTime=12:00:00
&SwitchEndTime=12:30:00
&<Common request parameters>
{
"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. |
InvalidParameterValue.InvalidParameterValueError | Incorrect parameter value |
InvalidParameterValue.InvalidZoneIdError | Invalid availability zone. |
OperationDenied.CamDeniedError | This operation cannot be performed. |
OperationDenied.InstanceStatusLimitOpError | This operation cannot be performed on an instance in this status. |
Was this page helpful?