tencent cloud

Feedback

AddInstances

Last updated: 2022-04-07 11:38:16

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: AddInstances.
Version Yes String Common parameter. The value used for this API: 2019-01-07.
Region Yes String Common parameter. 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
ReadOnlyCount Yes Integer Number of added read-only instances
InstanceGrpId No String Instance group ID, which is used when you add an instance in an existing RO group. If this parameter is left empty, an RO group will be created.
VpcId No String VPC ID
SubnetId No String Subnet ID
Port No Integer Port used when adding RO group
InstanceName No String Instance name
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
    DealMode No Integer Transaction mode. Valid values: 0 (place and pay for an order), 1 (place an order)

    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

    Input Example

    https://cynosdb.tencentcloudapi.com/?Action=AddInstances
    &VpcId=vpc-1ptuei0b
    &SubnetId=subnet-1tmw9t4o
    &Cpu=2
    &Memory=4
    &ClusterId=cynosdbmysql-6gtlgm5l
    &ReadOnlyCount=1
    &<Common request parameters>
    

    Output Example

    {
      "Response": {
        "BigDealIds": [
          "xx"
        ],
        "ResourceIds": [
          "cynosdbpg-ins-n8497zx8"
        ],
        "RequestId": "ed1bf4b2-4917-4f4f-9f7d-1562e34c9eeb",
        "TranId": "xx",
        "DealNames": [
          "xx"
        ]
      }
    }
    

    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 ({{1}}). Please try again later. If the problem persists, please 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.
    InvalidParameterValue.DBTypeNotFound Unsupported instance type.
    InvalidParameterValue.IllegalPassword The password does not meet the requirement.
    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 This operation is not allowed for the current cluster. Reason: {{1}}.
    OperationDenied.ClusterStatusDeniedError For the cluster ({{1}}) 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 ({{1}}) does not exist.
    UnauthorizedOperation.PermissionDenied CAM authentication failed.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support