tencent cloud

Feedback

ModifyDBInstanceDeployment

Last updated: 2022-07-08 10:18:46

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 now), 1 (switch at a specified time), 2 (switch during maintenance time). 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.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Changing instance deployment mode to multi-AZ deployment

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 2.

Input Example

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceDeployment
<Common request parameters>

{
    "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"
}

Output Example

{
  "Response": {
    "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
  }
}

Example2 Changing instance deployment mode to single-AZ deployment

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.

Input Example

POST / HTTP/1.1
Host: postgres.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"
}

Output Example

{
  "Response": {
    "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.InstanceStatusLimitOpError This operation cannot be performed on an instance in this status.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support