云数据库独享集群添加节点到集群

1. 接口描述

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

该接口（AddNodesToDBCustomCluster）用于为 DB Custom 集群添加已存在的节点。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：AddNodesToDBCustomCluster。
Version	是	String	公共参数，本接口取值：2020-10-29。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-bangkok, ap-nanjing, ap-shanghai 。
ClusterId	是	String	集群ID 示例值：dbcc-sizxd0hi
NodeIds.N	是	Array of String	需上架的节点 ID 列表示例值：["dbcn-7d59rhi5"]
ImageId	是	String	节点上架后重设的操作系统镜像ID 取值参考：可通过"DescribeDBCustomImages"接口获取支持的镜像。示例值：img-7rqxtnh9
LoginSettings	是	LoginSettings	实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。入参限制：若选择密钥方式，KeyIds 仅支持单个 ID。三种方式必须且仅可以设置其中一种。
Labels.N	否	Array of Label	节点上架成功后初始化新增的自定义 Label 入参限制：单次 ≤ 20 对
Taints.N	否	Array of Taint	节点上架成功后初始化下发的Taint 入参限制：单次 ≤ 5 对
HostName	否	String	主机hostname ，仅 HostNameType=1 时必填，其余情况忽略；不支持大写字母入参限制：- 点号（.）和短横线（-）不能作为 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。示例值：dbcustom.khaos.worker-{IP}
HostNameType	否	Integer	HostName 来源类型枚举值： 0：复用节点创建时设置的 hostname，为空则报错 1：重新指定 HostName，需同时传 HostName 字段（支持模式串 {R:x}、{R:x,F:y}、{IP}） 2：系统自动分配，用 NodeId 作为 HostName 示例值：1
DryRun	否	Boolean	试运行开关，true 时只执行参数校验，不发起上架流程默认值：false 示例值：false

3. 输出参数

参数名称	类型	描述
TaskId	Integer	上架节点的任务ID 示例值：1495
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 添加节点到集群

将节点添加到DB Custom集群中

输入示例

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

{
    "ClusterId": "dbcc-sizxd0hi",
    "NodeIds": [
        "dbcn-7d59rhi5"
    ],
    "ImageId": "img-7rqxtnh9",
    "LoginSettings": {
        "Password": "mimaTest@1234"
    },
    "HostName": "dbcustom.khaos.worker-{IP}",
    "HostNameType": 1,
    "DryRun": false
}

输出示例

{
    "Response": {
        "TaskId": 1495,
        "RequestId": "72c2aefd-3093-449c-9a28-5d52ce20217c"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

添加节点到集群

本页目录：