云数据库独享集群 DB Custom 集群上架节点

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-nanjing, ap-shanghai 。
ClusterId	是	String	集群ID 示例值：dbcc-qjv7nng7
NodeIds.N	是	Array of String	需上架的节点 ID 列表示例值：["dbcn-z4z0rbc9"]
ImageId	是	String	节点上架后重设的操作系统镜像ID 取值参考：可通过"DescribeDBCustomImages"接口获取支持的镜像。示例值：img-1tmhysjj
LoginSettings	是	LoginSettings	实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。入参限制：若选择密钥方式，KeyIds 仅支持单个 ID。三种方式必须且仅可以设置其中一种。

3. 输出参数

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

4. 示例

示例1 集群添加已有节点（通过密钥登录节点）

输入示例

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

{
    "ClusterId": "dbcc-qjv7nng7",
    "NodeIds": [
        "dbcn-z4z0rbc9"
    ],
    "ImageId": "img-1tmhysjj",
    "LoginSettings": {
        "KeyIds": [
            "skey-48hbnu45"
        ]
    }
}

输出示例

{
    "Response": {
        "TaskId": 753,
        "RequestId": "96d5fa5c-44f8-48d2-88fe-81f34b71ac07"
    }
}

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	参数取值错误。

DB Custom 集群上架节点

本页目录：