1. 接口描述
接口请求域名: thpc.tencentcloudapi.com 。
本接口 (CreateCluster) 用于创建并启动集群。
- 本接口为异步接口, 当创建集群请求下发成功后会返回一个集群
ID
和一个RequestId
,此时创建集群操作并未立即完成。在此期间集群的状态将会处于“PENDING”或者“INITING”,集群创建结果可以通过调用 DescribeClusters 接口查询,如果集群状态(ClusterStatus)变为“RUNNING(运行中)”,则代表集群创建成功,“ INIT_FAILED”代表集群创建失败。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateCluster。 |
Version | 是 | String | 公共参数,本接口取值:2022-04-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Placement | 是 | Placement | 集群中实例所在的位置。 示例值:{ "Zone": "ap-guangzhou-6" } |
ManagerNode | 否 | ManagerNode | 指定管理节点。 示例值:{"InstanceType": "S2.SMALL2"} |
ManagerNodeCount | 否 | Integer | 指定管理节点的数量。默认取值:1。取值范围:1~2。 示例值:1 |
ComputeNode | 否 | ComputeNode | 指定计算节点。 示例值:{"InstanceType": "S2.SMALL2"} |
ComputeNodeCount | 否 | Integer | 指定计算节点的数量。默认取值:0。 示例值:1 |
SchedulerType | 否 | String | 调度器类型。默认取值:SLURM。 示例值:SGE |
ImageId | 否 | String | 指定有效的镜像ID,格式形如img-xxx 。目前支持部分公有镜像和自定义镜像。示例值:img-xxx |
VirtualPrivateCloud | 否 | VirtualPrivateCloud | 私有网络相关信息配置。 示例值:{ "VpcId": "vpc-rhfaxx31", "SubnetId": "subnet-x7vxgqe" } |
LoginSettings | 否 | LoginSettings | 集群登录设置。 示例值:{ "KeyIds": [ "skey-9tzxxb4j" ] } |
SecurityGroupIds.N | 否 | Array of String | 集群中实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。 示例值:["sg-ajhn9qtq"] |
ClientToken | 否 | String | 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 示例值:system-f3827db9-c58a-49cc-bf10-33fc1923a34a |
DryRun | 否 | Boolean | 是否只预检此次请求。 true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和云服务器库存。 如果检查不通过,则返回对应错误码; 如果检查通过,则返回RequestId. false(默认):发送正常请求,通过检查后直接创建实例 示例值:False |
AccountType | 否 | String | 域名字服务类型。默认取值:NIS。 示例值:NIS |
ClusterName | 否 | String | 集群显示名称。 示例值:cluster-test |
StorageOption | 否 | StorageOption | 集群存储选项 示例值:{"CFSOptions":[{"LocalPath":"/mnt/","RemotePath":"127.0.0.1@tcp0:/test/cfs/","Protocol":"TURBO","StorageType":"TP"}]} |
LoginNode | 否 | LoginNode | 指定登录节点。 示例值:{"InstanceType": "S2.SMALL2"} |
LoginNodeCount | 否 | Integer | 指定登录节点的数量。默认取值:0。取值范围:0~10。 示例值:1 |
Tags.N | 否 | Array of Tag | 创建集群时同时绑定的标签对说明。 示例值:[{"Key": "test", "Value": "test"}] |
AutoScalingType | 否 | String | 弹性伸缩类型。 示例值:THPC_AS |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ClusterId | String | 集群ID。 示例值:hpc-5lyv94lq |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建集群
创建一个管控节点和两个计算节点的集群。调度器为:SLURM。
输入示例
输出示例
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.CallCvm | cvm调用失败。 |
InvalidParameter.Malformed | 参数格式有误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.NotSupported | 不支持该参数值。 |
InvalidParameterValue.ParametersNotSupported | 字段不支持此值。 |
InvalidParameterValue.TooLarge | 参数值过大。 |
InvalidParameterValue.TooLong | 参数长度过长。 |
InvalidParameterValue.TooShort | 无效参数值。参数值太短。 |
InvalidParameterValue.TooSmall | 参数值过小。 |
ResourceNotFound.ImageId | 无法找到镜像ID。 |
UnsupportedOperation | 操作不支持。 |