tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateReadOnlyGroupNetworkAccess

Last updated: 2024-06-17 14:26:11

    1. API Description

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

    This API is used to create a network for 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: CreateReadOnlyGroupNetworkAccess.
    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.
    ReadOnlyGroupId Yes String RO group ID in the format of pgro-4t9c6g7k.
    VpcId Yes String Unified VPC ID.
    SubnetId Yes String Subnet ID.
    IsAssignVip Yes Boolean Whether to manually assign the VIP. Valid values: true (manually assign), false (automatically assign).
    Vip No String Target VIP.

    3. Output Parameters

    Parameter Name Type Description
    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 the network for an RO group

    u200cu200cu200cThis example shows you how to create the network for an RO group.

    Input Example

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

{
    "SubnetId": "subnet-4s9dejli",
    "VpcId": "vpc-gaestjaf",
    "ReadOnlyGroupId": "pgro-4t9c6g7k",
    "IsAssignVip": "false"
}

    Output Example

    {
    "Response": {
        "RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90",
        "FlowId": 912
    }
}

    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 CAM signature/authentication error.
    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.DatabaseAffectedError Data operation failed. 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.GetSubnetError Failed to query VPC subnets.
    FailedOperation.GetVpcInfoError Failed to query VPC information. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.NetworkNumLimitError The number of networks does not meet resource requirements.
    FailedOperation.ROGroupNotFoundError The RO group does not exist.
    FlowError Failed to create the task.
    InternalError.FlowError Failed to create the flow.
    InternalError.InternalHttpServerError An exception occurred while executing the request.
    InternalError.MarshalError Failed to parse background data. Please contact customer service.
    OperationDenied.CamDeniedError This operation cannot be performed.
    OperationDenied.ROGroupStatusError This operation cannot be performed on an RO group in this status.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy