帮你快速理解、总结文档立即下载
文档中心>API 中心>云数据库独享集群>DB Custom节点相关接口>创建节点

创建节点

最近更新时间：2026-07-29 01:54:33

我的收藏

本页目录：

1. 接口描述

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

该接口（CreateDBCustomNodes）用于创建 DB Custom 节点(需支付)。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateDBCustomNodes。
Version 是 String 公共参数，本接口取值：2020-10-29。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-bangkok, ap-nanjing, ap-shanghai 。
Zone 是 String

产品支持的可用区

枚举值：

  • ap-shanghai-5： 上海五区
  • ap-shanghai-8： 上海八区
  • ap-nanjing-3： 南京三区

示例值：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
NodeType 是 String

节点机型

枚举值：

  • DB.AT5.32XLARGE512： 高IO型服务器：128核心512GB内存，87180GB本地NvME SSDB。
  • DB.AT5.64XLARGE1152： 高IO型服务器：256核心1152GB内存，127180GB本地NvME SSDB。
  • DB.AT5.128XLARGE2304： 高IO型服务器：512核心2304GB内存，247180GB本地NvME SSDB。
  • DB.AT5.16XLARGE256： 高IO型服务器：64核心256GB内存，47180GB本地NvME SSDB。
  • DB.AT5.8XLARGE128： 高IO型服务器：32核心128GB内存，2*7180GB本地NvME SSDB。

示例值：DB.AT5.8XLARGE128
NodeCount 是 Integer

购买的节点数量

取值范围：[1, 20]


示例值：1
LoginSettings 是 LoginSettings

节点登录设置。通过该参数可以设置节点的登录方式密码、密钥或保持镜像的原始登录设置。

入参限制：若选择密钥方式，KeyIds 仅支持单个 ID。三种方式必须且仅可以设置其中一种。
Period 否 Integer

购买时长(月): 1/2/3/4/5/6/7/8/9/10/11/12/24/36

取值范围：[1, 36]

单位：月

默认值：1


示例值：1
AutoRenew 否 Integer

自动续费配置

枚举值：

  • 1： 自动续费
  • 2： 不自动续费

默认值：不自动续费


示例值：2
NodeName 否 String

节点名称

入参限制：最多128个字符


示例值：私有镜像自带SSHKey
AutoVoucher 否 Integer

是否使用代金券自动抵扣

枚举值：

  • 1： 使用
  • 0： 不使用

默认值：0


示例值：1
VoucherIds.N 否 Array of String

代金券ID

入参限制：必须为当前账号下拥有的未抵扣的代金券ID。


示例值：["OZRCGNAVHYEQPQUVPZWIHD"]
Tags.N 否 Array of Tag

标签
ClientToken 否 String

用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。


示例值：b9bcd9d9-a5e8-4f19-acd6-c4e988826140
ChargeType 否 String

计费模式

枚举值：

  • PREPAID： 包年包月
  • POSTPAID： 按量付费

默认值：默认为包年包月(PREPAID)


示例值：POSTPAID
NetworkMode 否 String

访问主机的网络模式

枚举值：

  • privatelink： 四层网络联通，放通SSH 通路
  • cross_tenant_eni： 三层网络联通，双网卡模式

默认值：默认值为：privatelink


示例值：cross_tenant_eni
SystemDisk 否 SystemDisk

系统盘配置

入参限制：仅云盘版机型支持，如DB.SA5机型。本地盘机型DB.AT5机型不支持设置
DataDisks.N 否 Array of DataDisk

数据库盘配置

入参限制：仅云盘版机型支持，如DB.SA5机型。本地盘机型DB.AT5机型不支持设置
HostName 否 String

主机的hostname。

参数格式：字符串或者指定模式串

入参限制：- 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。不允许使用下划线(_)。

  • Windows 节点：主机名名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。
  • 其他类型（Linux 等）节点：主机名字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。
  • 购买多台节点时：
  • 指定模式串 {R:x}：表示生成数字序列 [x, x+n-1]，其中 n为购买节点的数量。例如：输入 server_{R:3}，购买1台时，节点主机名为 server_3；购买2台时，主机名分别为 server_3、server_4。
  • 指定模式串 {R:x,F:y}：y表示固定位数（可选），取值范围为 [0,8]，默认值 0表示不固定位数（等效于 {R:x}）。不足位时自动补零，例如：输入server_{R:3,F:3}，购买2台时，节点主机名为 server_003、server_004。若数字位数超过 y（如 {R:99,F:2}），以实际位数为准，例如：app_{R:99,F:2}，购买2台时，节点主机名为 app_99、app_100。
  • 指定模式串 {IP}：自动替换为节点的内网IP地址。例如：输入 node-{IP}，节点主机名为 node-10.0.12.8；支持与序号模式串混合使用，例如：输入 web-{IP}-{R:1}，购买2台时，节点主机名分别为 web-10.0.12.8-1、web-10.0.12.9-2。
  • 模式串需严格遵循 {R:x,F:y}、{R:x} 或 {IP} 格式，无效格式（如 {}）视为普通文本。支持多个模式串。
  • 未指定模式串：节点主机名添加后缀 1、2...n，其中n表示购买节点的数量，例如 server_购买2台时生成 server_1、server_2。

示例值：from-api-hostname
DryRun 否 Boolean

试运行开关。

枚举值：

  • true： 为 true 时接口只执行参数校验与资源申请检查（库存、配额、网络等），完成后立即返回空响应，不会真正下单，也不会创建节点记录。用于调用方在真正下单前做一次可行性预检。
  • false： 不预检查

默认值：false


示例值：true
SecurityGroupIds.N 否 Array of String

设置节点安全组

参数格式：设置需要与节点绑定的多个安全组ID，以数组形式配置。


示例值：["sg-ibp49iqt"]

3. 输出参数

参数名称 类型 描述
NodeIds Array of String

节点ID列表


示例值：["dbcn-o2q3rj8t"]
TaskId Integer

创建节点的任务ID


示例值：756
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建节点（保持镜像的原始登录方式）

输入示例

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 创建节点（通过密钥登录节点）

输入示例

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。

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation 请求未授权。请参考 CAM 文档对鉴权的说明。
FailedOperation 操作失败。
InvalidParameterValue 参数取值错误。
中国站