1. 接口描述
接口请求域名: thpc.tencentcloudapi.com 。
本接口(AddNodes)用于添加一个或者多个计算节点或者登录节点到指定集群。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AddNodes。 |
Version | 是 | String | 公共参数,本接口取值:2023-03-21。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Placement | 是 | Placement | 集群中实例所在的位置。 |
ClusterId | 是 | String | 集群ID。 |
VirtualPrivateCloud | 是 | VirtualPrivateCloud | 私有网络相关信息配置。 |
Count | 是 | Integer | 添加节点数量。 |
ImageId | 否 | String | 指定有效的镜像ID,格式形如img-xxx 。目前仅支持公有镜像和特定自定义镜像。 |
InstanceChargeType | 否 | String | 节点计费类型。 |
InstanceChargePrepaid | 否 | InstanceChargePrepaid | 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 |
InstanceType | 否 | String | 节点机型。不同实例机型指定了不同的资源规格。 |
SystemDisk | 否 | SystemDisk | 节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。 |
DataDisks.N | 否 | Array of DataDisk | 节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。 |
InternetAccessible | 否 | InternetAccessible | 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。 |
InstanceName | 否 | String | 节点显示名称。 不指定节点显示名称则默认显示‘未命名’。 最多支持60个字符。 |
LoginSettings | 否 | LoginSettings | 集群登录设置。 |
SecurityGroupIds.N | 否 | Array of String | 集群中实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。 |
ClientToken | 否 | String | 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 |
QueueName | 否 | String | 队列名称。不指定则为默认队列。 |
NodeRole | 否 | String | 添加节点角色。默认值:Compute |
DryRun | 否 | Boolean | 是否只预检此次请求。 true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和云服务器库存。 如果检查不通过,则返回对应错误码; 如果检查通过,则返回RequestId. false(默认):发送正常请求,通过检查后直接创建实例 |
NodeType | 否 | String | 添加节点类型。默认取值:STATIC。 |
ProjectId | 否 | Integer | 实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。 |
ResourceType | 否 | String | 要新增节点的资源类型。 示例值:CVM |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加节点
往集群ID为hpc-52nkfau6的集群的compute队列增加一个计算节点。
输入示例
POST / HTTP/1.1
Host: thpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddNodes
<公共请求参数>
{
"Count": "1",
"VirtualPrivateCloud": {
"SubnetId": "subnet-r0zpktaa",
"VpcId": "vpc-r9jw2jzr"
},
"Placement": {
"Zone": "ap-guangzhou-2"
},
"ClusterId": "hpc-52nkfau6",
"ImageId": "img-3la7wgnt",
"InstanceChargeType": "SPOTPAID",
"InstanceType": "S2.SMALL2",
"NodeRole": "Compute",
"QueueName": "compute"
}
输出示例
{
"Response": {
"RequestId": "b2ac2379-6453-4eab-8f63-7ade00cb67b0"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
InternalError.CallCvm | cvm调用失败。 |
InvalidParameter.Malformed | 参数格式有误。 |
InvalidParameterValue.NotSupported | 不支持该参数值。 |
InvalidParameterValue.ParametersNotSupported | 字段不支持此值。 |
InvalidParameterValue.TooLarge | 参数值过大。 |
InvalidParameterValue.TooLong | 参数长度过长。 |
InvalidParameterValue.TooSmall | 参数值过小。 |
MissingParameter | 缺少参数错误。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound.ClusterId | 集群不存在。 |
ResourceNotFound.ImageId | 无法找到镜像ID。 |
ResourceNotFound.Queue | 无法找到指定队列。 |
UnsupportedOperation.ClusterStatusNotSupport | 该集群当前状态不支持该操作。 |
UnsupportedOperation.VpcIdConflict | vpc冲突,不支持当前操作。 |