SwitchDBInstancePrimary

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: SwitchDBInstancePrimary.
Version	Yes	String	Common Params. The value used for this API: 2017-03-12.
Region	No	String	Common Params. This parameter is not required for this API.
DBInstanceId	Yes	String	Instance ID
Force	No	Boolean	Whether to perform forced switch. As long as the standby node can be accessed, the switch will be performed regardless of the primary-standby sync delay. You can switch immediately only when `SwitchTag` is `0.<br/><li>Default:` false`.
SwitchTag	No	Integer	Switch time for the specified instance after configuration modification. `0`: Switch now. `1`: Switch at the specified time. `2`: Switch in the maintenance 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". This parameter is invalid when `SwitchTag` is `0` or `2`.
SwitchEndTime	No	String	The latest time to start a switch in the format of "HH:MM:SS", such as "01:30:00". This parameter is invalid when `SwitchTag` is `0` or `2`. The difference between `SwitchStartTime` and `SwitchEndTime` cannot be less than 30 minutes.

3. Output Parameters

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.

4. Example

Example1 Enabling the primary-standby switch of an instance

This example shows you how to enable primary-standby switch for the instance postgres-idabksrn non-forcibly now.

Input Example

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

{
    "DBInstanceId": "postgres-idabksrn"
}

Output Example

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

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

Tencent Cloud CLI 3.0

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.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.
FailedOperation.FlowCreateError	Failed to create a task. Please try again later. If the problem persists, please contact customer service.
FailedOperation.NoAvailableStandby	The instance has no available standby server.
InvalidParameter.ParameterCheckError	Failed to check the parameter.
InvalidParameterValue.InvalidParameterValueError	Incorrect parameter value
OperationDenied.CamDeniedError	This operation cannot be performed.
OperationDenied.InstanceStatusLimitError	This operation cannot be performed on an instance in this status.
OperationDenied.InstanceTypeDenied	Invalid instance type
ResourceNotFound.InstanceNotFoundError	The instance does not exist.

联系我们

联系我们，为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持

tencent cloud

Recent Pages