tencent cloud

APIs

AddInstances

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-10-28 10:18:42

1. API Description

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

This API is used to add instances to 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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ClusterId Yes String

Cluster ID.

Cpu Yes Integer

Number of Cpu cores.

Memory Yes Integer

Memory in GB

ReadOnlyCount Yes Integer

Number of newly-added read-only instances, value range (0,15]

DeviceType No String

Instance Machine Type. Supported values are as follows:

  • common: universal type
  • exclusive: dedicated
VpcId No String

ID of the VPC network it belongs to.

SubnetId No String

Subnet ID. If VpcId is set up, SubnetId is required.

Port No Integer

Port used when adding new RO groups, value range [0,65535)

InstanceName No String

Instance name, string length range [0,64), value range uppercase and lowercase letters, digits 0-9, '_', '-', '.'

AutoVoucher No Integer

Whether to automatically select a voucher. 1: Yes; 0: No. Default is 0.

DbType No String

Database type. Value range:

  • MYSQL
  • OrderSource No String

    Order source, string length range [0,64)

    DealMode No Integer

    Transaction mode 0-Place order and pay 1-Place order

    ParamTemplateId No Integer

    Parameter template ID.

    InstanceParams.N No Array of ModifyParamItem

    Parameter list. InstanceParams is valid only when ParamTemplateId is passed in.

    SecurityGroupIds.N No Array of String

    Security group ID. You can specify security groups when creating a read-only instance.

    UpgradeProxy No UpgradeProxy

    Upgrade proxy synchronously

    3. Output Parameters

    Parameter Name Type Description
    TranId String

    Freeze transaction. One frozen flow is activated at a time.

    DealNames Array of String

    Order number of the payment. Description: We recommend you use the DescribeResourcesByDealName API to query the instances associated with the order.

    BigDealIds Array of String

    Large order number

    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 Add an instance

    Add a read-only instance

    Input Example

    POST / HTTP/1.1
    Host: cynosdb.intl.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,
        "UpgradeProxy": {
            "Cpu": 4,
            "Mem": 8000,
            "ReloadBalance": "auto",
            "ProxyZones": [
                {
                    "ProxyNodeZone": "ap-guangzhou-3",
                    "ProxyNodeCount": 1
                }
            ]
        }
    }

    Output Example

    {
        "Response": {
            "TranId": "myTranId",
            "DealNames": [
                "182711111"
            ],
            "ResourceIds": [
                "cynosdbmysql-mwg712mm"
            ],
            "BigDealIds": [
                "137895"
            ],
            "RequestId": "48fa5cf5-77db-4e32-90ef-22c71ed95f51"
        }
    }

    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 Database access failed. Try again later. If the issue persists, contact customer service.
    FailedOperation.OperationFailedError Operation failed. Try again later. If the issue persists, contact customer service.
    FailedOperation.TradeCreateOrderError Failed to create and pay for the order. Try again later. If the issue persists, contact customer service.
    InternalError.DbOperationFailed Query database failed.
    InternalError.GetSubnetFailed Failed to obtain 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 requirements.
    InvalidParameterValue.InvalidParameterValueError Parameter value is invalid.
    InvalidParameterValue.InvalidSpec Invalid instance specification.
    InvalidParameterValue.ParamError Parameter error.
    InvalidParameterValue.RegionZoneUnavailable The selected region and availability zone are unavailable.
    InvalidParameterValue.SubnetNotFound Subnet not found.
    InvalidParameterValue.VpcNotFound The selected VPC network is not found.
    LimitExceeded.UserInstanceLimit Number of user instances exceeds the limit.
    OperationDenied.ClusterOpNotAllowedError Operation forbidden. The current cluster does not allow this operation.
    OperationDenied.ClusterStatusDeniedError Operation not allowed in the current status of the cluster.
    OperationDenied.InsufficientBalanceError Insufficient account balance.
    OperationDenied.UserNotAuthenticatedError User not verified with real-name authentication. Please proceed with real-name authentication before purchase.
    ResourceNotFound.ClusterNotFoundError The cluster does not exist.
    UnauthorizedOperation.PermissionDenied CAM authentication failed.

    Ajuda e Suporte

    Esta página foi útil?

    comentários