tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateCluster

Last updated: 2024-07-24 10:20:59

    1. API Description

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

    This API is used to create a TcaplusDB cluster.

    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: CreateCluster.
    Version Yes String Common Params. The value used for this API: 2019-08-23.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    IdlType Yes String Cluster data description language type, such as PROTO, TDR, or MIX
    ClusterName Yes String Cluster name, which can contain up to 32 letters and digits
    VpcId Yes String ID of the VPC instance bound to a cluster in the format of vpc-f49l6u0z
    SubnetId Yes String ID of the subnet instance bound to a cluster in the format of subnet-pxir56ns
    Password Yes String Cluster access password, which must contain lowercase letters (a-z), uppercase letters (A-Z), and digits (0-9).
    ResourceTags.N No Array of TagInfoUnit Cluster tag list
    Ipv6Enable No Integer Whether to enable IPv6 address access for clusters
    ServerList.N No Array of MachineInfo Information of the machine at the storage layer (tcapsvr) in a dedicated cluster
    ProxyList.N No Array of MachineInfo Information of the machine at the access layer (tcaproxy) in a dedicated cluster
    ClusterType No Integer Cluster type. Valid values: 1 (standard), 2 (dedicated)
    AuthType No Integer Authentication type. Valid values: 0 (static password), 1 (signature)

    3. Output Parameters

    Parameter Name Type Description
    ClusterId String Cluster 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 Creating a TcaplusDB cluster

    This example shows you how to create a TcaplusDB cluster.

    Input Example

    https://tcaplusdb.tencentcloudapi.com/?Action=CreateCluster
&IdlType=TDR
&ClusterName=gz test TDR
&VpcId=vpc-kppg4pm1
&SubnetId=subnet-3sww53pa
&Password=84ea4cbf06573ED
&<Common request parameters>

    Output Example

    {
    "Response": {
        "ClusterId": "6179109757",
        "RequestId": "8f1cc454-4a80-4ed3-a6c3-b7df2b0e8ec7"
    }
}

    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 Operation failed.
    InternalError Internal error.
    InvalidParameterValue.InvalidClusterName Invalid cluster name.
    InvalidParameterValue.UnsupportIdlType Unsupported application data description type.
    ResourceInsufficient.BalanceError Insufficient balance.
    ResourceInsufficient.NoAvailableCluster No cluster resources available.
    ResourceInsufficient.NoEnoughVipInVPC There are no VIP resources available in the VPC.
    ResourceUnavailable The resource is unavailable.
    ResourceUnavailable.DuplicateClusterName The cluster name already exists.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy