TDSQL-C MySQL 版集群添加实例-实例相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： cynosdb.tencentcloudapi.com 。

本接口（AddInstances）用于集群添加实例。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：AddInstances。
Version	是	String	公共参数，本接口取值：2019-01-07。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。
ClusterId	是	String	集群ID 示例值：cynosdbmysql-6gtlgm5l
Cpu	是	Integer	Cpu核数示例值：2
Memory	是	Integer	内存，单位为GB 示例值：4
ReadOnlyCount	是	Integer	新增只读实例数，取值范围为(0,15] 示例值：1
DeviceType	否	String	实例机器类型
VpcId	否	String	所属VPC网络ID。示例值：vpc-1ptuei0b
SubnetId	否	String	所属子网ID，如果设置了VpcId，则SubnetId必填。示例值：subnet-1tmw9t4o
Port	否	Integer	新增RO组时使用的Port，取值范围为[0,65535) 示例值：2000
InstanceName	否	String	实例名称，字符串长度范围为[0,64)，取值范围为大小写字母，0-9数字，'_','-','.' 示例值：cynosmysql-xxxxxxxx
AutoVoucher	否	Integer	是否自动选择代金券 1是 0否默认为0 示例值：0
DbType	否	String	数据库类型，取值范围: MYSQL 示例值：MYSQL
OrderSource	否	String	订单来源，字符串长度范围为[0,64) 示例值：api
DealMode	否	Integer	交易模式 0-下单并支付 1-下单示例值：0
ParamTemplateId	否	Integer	参数模板ID 示例值：0
InstanceParams.N	否	Array of ModifyParamItem	参数列表，ParamTemplateId 传入时InstanceParams才有效
SecurityGroupIds.N	否	Array of String	安全组ID，新建只读实例时可以指定安全组。示例值：sg-rgf3qgld
UpgradeProxy	否	UpgradeProxy	proxy同步升级

3. 输出参数

参数名称	类型	描述
TranId	String	冻结流水，一次开通一个冻结流水。注意：此字段可能返回 null，表示取不到有效值。示例值：myTranId
DealNames	Array of String	后付费订单号。注意：此字段可能返回 null，表示取不到有效值。示例值：[123]
ResourceIds	Array of String	发货资源id列表。注意：此字段可能返回 null，表示取不到有效值。示例值：[cynosmysql-xxxxxxxx]
BigDealIds	Array of String	大订单号注意：此字段可能返回 null，表示取不到有效值。示例值：[234]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 新增实例

新增只读实例

输入示例

POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddInstances
<公共请求参数>

{
    "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
            }
        ]
    }
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.DatabaseAccessError	数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.OperationFailedError	操作失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.TradeCreateOrderError	创建并支付订单失败，请稍后重试。如果持续不成功，请联系客服进行处理。
InternalError.DbOperationFailed	查询数据库失败。
InternalError.GetSubnetFailed	获取子网失败。
InternalError.GetVpcFailed	获取VPC失败。
InternalError.UnknownError	未知的内部错误。
InvalidParameterValue.DBTypeNotFound	不支持的实例类型。
InvalidParameterValue.IllegalPassword	密码不符合要求。
InvalidParameterValue.InvalidParameterValueError	参数值无效。
InvalidParameterValue.InvalidSpec	实例规格非法。
InvalidParameterValue.ParamError	参数错误。
InvalidParameterValue.RegionZoneUnavailable	所选地域和可用区不可用。
InvalidParameterValue.SubnetNotFound	找不到所选子网。
InvalidParameterValue.VpcNotFound	找不到所选VPC网络。
LimitExceeded.UserInstanceLimit	用户实例个数超出限制。
OperationDenied.ClusterOpNotAllowedError	由于操作禁止，当前集群不允许该操作。
OperationDenied.ClusterStatusDeniedError	集群当前状态不允许该操作。
OperationDenied.InsufficientBalanceError	账号余额不足。
OperationDenied.UserNotAuthenticatedError	用户未进行实名认证，请先进行实名认证才可购买。
ResourceNotFound.ClusterNotFoundError	集群不存在。
UnauthorizedOperation.PermissionDenied	CAM鉴权不通过。

集群添加实例

本页目录：