tencent cloud

TencentDB for PostgreSQL

DocumentaçãoTencentDB for PostgreSQL​​API ReferenceInstance APIsSwitchDBInstancePrimary

SwitchDBInstancePrimary

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-05-21 10:43:37

1. API Description

Domain name for API request: postgres.intl.tencentcloudapi.com.

This API is used to switch over primary and replica nodes.

  • This API is used to verify whether the business can correctly handle instance primary/backup switch scenarios by initiating switch proactively.
    • .
  • This API is used to force a primary-secondary switch when the backup node latency fails to satisfy the switch condition by using forced switching.
    • .
  • This API is used to perform this operation on the primary instance only.
    • .

    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: SwitchDBInstancePrimary.
    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. obtain through the api DescribeDBInstances.
    Force No Boolean Whether to force a switch. forced switching initiates a switch as long as the secondary node is accessible, regardless of the primary/secondary delay. only when SwitchTag is 0 can you use switch immediately.
  • Default: false
    • .
    SwitchTag No Integer Specifies the switch time after instance configuration change.
  • 0: switch immediately
    • .
  • 1: switch at specified time
    • .
  • 2: switch during maintenance time window.
    • .
    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
    TaskId Integer Task ID.
    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 Switching Instance Primary-Standby Relationship

    This example shows you how to switch the primary-standby relationship of instance postgres-idabksrn using a non-forced switch and switch immediately.

    Input Example

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

    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.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.
    Anterior: DescribeMaintainTimeWindowPróximo: ModifyDBInstanceName

    Ajuda e Suporte

    Esta página foi útil?

    comentários