1. 接口描述
接口请求域名： dbdc.tencentcloudapi.com 。
该接口（CreateDBCustomNodes）用于创建 DB Custom 节点(需支付)。
默认接口请求频率限制：20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateDBCustomNodes。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-29。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-nanjing, ap-shanghai 。 |
| Zone | 是 | String | 产品支持的可用区 枚举值：
示例值：ap-shanghai-5 |
| ImageId | 是 | String | 镜像ID 参数格式：img-xxxxxxx 入参限制：必须为当前账号下DB Custom 产品拥有的镜像 取值参考：可通过"DescribeDBCustomImages"接口获取支持的镜像。 示例值：img-2htjru6l |
| VpcId | 是 | String | 为节点打通SSH连接的VPC 网络ID。 参数格式：vpc-b4zgtest 入参限制：必须是当前账号下拥有的VPC 网络ID，且不能跨地域。 取值参考：可通过【查询VPC列表】接口获取：https://cloud.tencent.com/document/product/215/15778 示例值：vpc-3kmj79e2 |
| SubnetId | 是 | String | 为节点打通SSH连接的VPC 子网 ID。 参数格式：subnet-t13dtest 入参限制：必须是VPC之下的子网，子网必须与可用区对应。 取值参考：可通过【查询子网列表】接口获取：https://cloud.tencent.com/document/product/215/15784 示例值：subnet-pqebu78d |
| Period | 是 | Integer | 购买时长(月): 1/2/3/4/5/6/7/8/9/10/11/12/24/36 取值范围：[1, 36] 单位：月 默认值：1 示例值：1 |
| NodeType | 是 | String | 节点机型 枚举值：
示例值：DB.AT5.8XLARGE128 |
| NodeCount | 是 | Integer | 购买的节点数量 取值范围：[1, 20] 示例值：1 |
| LoginSettings | 是 | LoginSettings | 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。 入参限制：若选择密钥方式，KeyIds 仅支持单个 ID。三种方式必须且仅可以设置其中一种。 |
| AutoRenew | 否 | Integer | 自动续费配置 枚举值：
默认值：不自动续费 示例值：2 |
| NodeName | 否 | String | 节点名称 入参限制：最多128个字符 示例值：私有镜像自带SSHKey |
| AutoVoucher | 否 | Integer | 是否使用代金券自动抵扣 枚举值：
默认值：0 示例值：1 |
| VoucherIds.N | 否 | Array of String | 代金券ID 入参限制：必须为当前账号下拥有的未抵扣的代金券ID。 示例值：["OZRCGNAVHYEQPQUVPZWIHD"] |
| Tags.N | 否 | Array of Tag | 标签 |
| ClientToken | 否 | String | 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 示例值：b9bcd9d9-a5e8-4f19-acd6-c4e988826140 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| NodeIds | Array of String | 节点ID列表 示例值：["dbcn-o2q3rj8t"] |
| TaskId | Integer | 创建节点的任务ID 示例值：756 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建 DB Custom 节点（保持镜像的原始登录方式）
输入示例
POST / HTTP/1.1
Host: dbdc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBCustomNodes
<公共请求参数>
{
"Zone": "ap-shanghai-5",
"ImageId": "img-2htjru6l",
"VpcId": "vpc-3kmj79e2",
"SubnetId": "subnet-pqebu78d",
"Period": 1,
"NodeType": "DB.AT5.8XLARGE128",
"NodeCount": 1,
"LoginSettings": {
"KeepImageLogin": "true"
},
"AutoRenew": 2,
"NodeName": "私有镜像自带SSHKey"
}输出示例
{
"Response": {
"NodeIds": [
"dbcn-o2q3rj8t"
],
"TaskId": 756,
"RequestId": "e7026ac1-125f-4e74-ae38-029ad41defe6"
}
}示例2 创建 DB Custom 节点（通过密钥登录节点）
输入示例
POST / HTTP/1.1
Host: dbdc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBCustomNodes
<公共请求参数>
{
"Zone": "ap-shanghai-5",
"ImageId": "img-1tmhysjj",
"VpcId": "vpc-3kmj79e2",
"SubnetId": "subnet-pqebu78d",
"Period": 1,
"NodeType": "DB.AT5.8XLARGE128",
"NodeCount": 1,
"LoginSettings": {
"KeyIds": [
"skey-48hbnu45"
]
},
"AutoRenew": 2,
"NodeName": "5*SSHKeyID+公共镜像"
}输出示例
{
"Response": {
"NodeIds": [
"dbcn-z4z0rbc9"
],
"TaskId": 746,
"RequestId": "7203009a-4d1e-42e1-a394-83f118bbc995"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 请求未授权。请参考 CAM 文档对鉴权的说明。 |
| FailedOperation | 操作失败。 |
| InvalidParameterValue | 参数取值错误。 |
