tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateReadOnlyGroup

Last updated: 2024-06-17 14:25:56

    1. API Description

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

    This API is used to create an RO group.

    A maximum of 100 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: CreateReadOnlyGroup.
    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.
    MasterDBInstanceId Yes String Primary instance ID
    Name Yes String RO group name
    ProjectId No Integer Project ID
    VpcId No String VPC ID
    SubnetId No String Subnet ID
    ReplayLagEliminate No Integer Whether to remove a read-only replica from an RO group if the delay between the read-only replica and the primary instance exceeds the threshold. Valid values: 0 (no), 1 (yes).
    ReplayLatencyEliminate No Integer Whether to remove a read-only replica from an RO group if the sync log size difference between the read-only replica and the primary instance exceeds the threshold. Valid values: 0 (no), 1 (yes).
    MaxReplayLag No Integer Delay threshold in ms
    MaxReplayLatency No Integer Delayed log size threshold in MB
    MinDelayEliminateReserve No Integer The minimum number of read-only replicas that must be retained in an RO group
    SecurityGroupIds.N No Array of String Security group ID

    3. Output Parameters

    Parameter Name Type Description
    ReadOnlyGroupId String RO group ID
    FlowId Integer Task ID
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Creating RO group

    Input Example

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

{
    "MaxReplayLag": "0",
    "VpcId": "\"vpc-e0tfm161\"",
    "Name": "\"test\"",
    "ProjectId": "0",
    "MasterDBInstanceId": "\"postgres-k95qzetn\"",
    "MinDelayEliminateReserve": "0",
    "ReplayLagEliminate": "0",
    "SubnetId": "\"subnet-443a3lv6\""
}

    Output Example

    {
    "Response": {
        "RequestId": "d43b2a9f-070c-480b-a0bb-7c210428cfe8",
        "FlowId": 912,
        "ReadOnlyGroupId": "pgrogrp-dh6873gz"
    }
}

    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
    AuthFailure.UnauthorizedOperation Authentication failed.
    FailedOperation.AllocateQuotasError Failed to request a quota for resource tags.
    FailedOperation.CamSigAndAuthError Authentication failed. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.CreateBasicNetworkDeniedError Classic network creation is unsupported.
    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.GetVpcInfoError Failed to query VPC information. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.IllegalROInstanceNum Invalid number of read-only replicas.
    FailedOperation.MasterInstanceQueryError Failed to query the primary instance information.
    FailedOperation.ROGroupNumExceedError The maximum number of RO groups has been reached.
    InternalError.InternalHttpServerError An exception occurred while executing the request.
    InternalError.SystemError System error. When this error occurs, please contact customer service for assistance.
    InvalidParameter Parameter error.
    InvalidParameter.ParameterCheckError Failed to check the parameter.
    InvalidParameter.VpcNotFoundError Failed to query VPC information.
    InvalidParameterValue.InterfaceNameNotFound Incorrect ACTION.
    InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
    InvalidParameterValue.ParameterCharacterError Invalid parameter. The parameter can contain only letters, digits, underscores, and hyphens.
    InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
    InvalidParameterValue.ParameterLengthLimitError The length of parameter exceeds the limit.
    InvalidParameterValue.RegionNotSupported The current region is not supported.
    OperationDenied.CamDeniedError This operation cannot be performed.
    OperationDenied.InstanceStatusLimitOpError This operation cannot be performed on an instance in this status.
    ResourceNotFound.InstanceNotFoundError The instance does not exist.
    StructParseFailed An error occurred while parsing parameters.
    UnknownError Unknown error. When this error occurs, please contact customer service for assistance.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy