tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateInstanceNew

Last updated: 2024-09-12 11:56:32

1. API Description

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

This API is used to create clusters.

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: CreateInstanceNew.
Version Yes String Common Params. The value used for this API: 2021-12-28.
Region No String Common Params. This parameter is not required for this API.
Zone Yes String Availability zone
FeSpec Yes CreateInstanceSpec FE specifications
BeSpec Yes CreateInstanceSpec BE specifications.
HaFlag Yes Boolean Whether it is highly available.
UserVPCId Yes String User VPCID
UserSubnetId Yes String User subnet ID
ProductVersion Yes String Product version number
ChargeProperties Yes ChargeProperties Payment type
InstanceName Yes String Instance name
DorisUserPwd Yes String Database password
Tags.N No Array of Tag Tag list
HaType No Integer High availability type:
0 indicates non-high availability (only one FE, FeSpec.CreateInstanceSpec.Count=1),
1 indicates read high availability (at least 3 FEs must be deployed, FeSpec.CreateInstanceSpec.Count>=3, and it must be an odd number),
2 indicates read and write high availability (at least 5 FEs must be deployed, FeSpec.CreateInstanceSpec.Count>=5, and it must be an odd number).
CaseSensitive No Integer Whether the table name is case sensitive, 0 refers to sensitive, 1 refers to insensitive, compared in lowercase; 2 refers to insensitive, and the table name is changed to lowercase for storage.
EnableMultiZones No Boolean Whether to enable multi-availability zone.
UserMultiZoneInfos No NetworkInfo After the Multi-AZ is enabled, all user's Availability Zones and Subnets information are shown.

3. Output Parameters

Parameter Name Type Description
FlowId String Process ID
InstanceId String Instance ID
ErrorMsg String Error message
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 An Example of Creating Clusters

This example shows you how to create a cluster.

Input Example

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

{
    "InstanceName": "test-by-quantity-hazk2 node",
    "Zone": "ap-beijing-2",
    "FeSpec": {
        "SpecName": "S_4_16_H",
        "Count": 3,
        "DiskSize": 200
    },
    "BeSpec": {
        "SpecName": "S_4_16_H",
        "Count": 3,
        "DiskSize": 1000
    },
    "HaFlag": true,
    "UserVPCId": "vpc-8visjoh9",
    "UserSubnetId": "subnet-03ij1dki",
    "ProductVersion": "1.2",
    "DorisUserPwd": "ujA7xa2*1",
    "ChargeProperties": {
        "ChargeType": "POSTPAID_BY_HOUR"
    }
}

Output Example

{
    "Response": {
        "InstanceId": "cdwdoris-aijqera",
        "FlowId": "1231",
        "RequestId": "lweinasd-28kamasd-xasdas",
        "ErrorMsg": ""
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy