tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

AddInstances

Last updated: 2023-08-23 14:23:04

1. API Description

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

This API is used to add an instance in a 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: AddInstances.
Version Yes String Common Params. The value used for this API: 2019-01-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterId Yes String Cluster ID
Cpu Yes Integer Number of CPU cores
Memory Yes Integer Memory in GB
ReadOnlyCount Yes Integer Number of added read-only instances. Value range: (0,16].
InstanceGrpId No String Instance group ID, which will be used when you add an instance in an existing RO group. If this parameter is left empty, an RO group will be created. But it is not recommended to pass in this parameter for the current version, as this version has been disused.
VpcId No String VPC ID
SubnetId No String Subnet ID. If VpcId is set, SubnetId is required.
Port No Integer The port used when adding an RO group. Value range: [0,65535).
InstanceName No String Instance name. String length range: [0,64).
AutoVoucher No Integer Whether to automatically select a voucher. 1: yes; 0: no. Default value: 0
DbType No String Database type. Valid values:
  • MYSQL
    • OrderSource No String Order source. String length range: [0,64).
    DealMode No Integer Transaction mode. Valid values: 0 (place and pay for an order), 1 (place an order)
    ParamTemplateId No Integer Parameter template ID
    InstanceParams.N No Array of ModifyParamItem Parameter list, which is valid only if InstanceParams is passed in to ParamTemplateId.
    SecurityGroupIds.N No Array of String Security group ID. You can specify an security group when creating a read-only instance.

    3. Output Parameters

    Parameter Name Type Description
    TranId String Freezing transaction. One freezing transaction ID is generated each time an instance is added.
    Note: this field may return null, indicating that no valid values can be obtained.
    DealNames Array of String Pay-as-You-Go order ID.
    Note: this field may return null, indicating that no valid values can be obtained.
    ResourceIds Array of String List of IDs of delivered resources
    Note: this field may return null, indicating that no valid values can be obtained.
    BigDealIds Array of String Big order ID.
    Note: this field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Adding an instance

    This example shows you how to add a read-only instance.

    Input Example

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

{
    "ReadOnlyCount": "1",
    "VpcId": "vpc-1ptuei0b",
    "ClusterId": "cynosdbmysql-6gtlgm5l",
    "Memory": "4",
    "SubnetId": "subnet-1tmw9t4o",
    "Cpu": "2"
}

    Output Example

    {
    "Response": {
        "TranId": "abc",
        "DealNames": [
            "abc"
        ],
        "ResourceIds": [
            "abc"
        ],
        "BigDealIds": [
            "abc"
        ],
        "RequestId": "abc"
    }
}

    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 the database. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
    FailedOperation.TradeCreateOrderError Failed to create the order and make a payment. Please try again later. If the problem persists, please contact customer service.
    InternalError.DbOperationFailed Failed to query the database.
    InternalError.GetSubnetFailed Failed to get the subnet.
    InternalError.GetVpcFailed Failed to get the VPC.
    InternalError.UnknownError Unknown internal error.
    InvalidParameterValue.DBTypeNotFound Unsupported instance type.
    InvalidParameterValue.IllegalPassword The password does not meet the requirement.
    InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
    InvalidParameterValue.InvalidSpec Invalid instance specification.
    InvalidParameterValue.ParamError Incorrect parameter.
    InvalidParameterValue.RegionZoneUnavailable The selected region and AZ are unavailable.
    InvalidParameterValue.SubnetNotFound The selected subnet could not be found.
    InvalidParameterValue.VpcNotFound The selected VPC could not be found.
    LimitExceeded.UserInstanceLimit The number of instances exceeds the limit.
    OperationDenied.ClusterOpNotAllowedError The current cluster does not allow the operation.
    OperationDenied.ClusterStatusDeniedError For the cluster in this status, the operation is not allowed.
    OperationDenied.InsufficientBalanceError Insufficient account balance.
    OperationDenied.UserNotAuthenticatedError You need to verify your identity to make a purchase.
    ResourceNotFound.ClusterNotFoundError The cluster does not exist.
    UnauthorizedOperation.PermissionDenied CAM authentication failed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy