{ "name": "thpc", "display_name": "高性能计算平台", "description": "THPC一期可实现固定集群的创建，暂不支持弹性扩容。", "domain": "compute", "api_version": "2023-03-21", "endpoint": "thpc.tencentcloudapi.com", "actions": [ { "name": "AddClusterStorageOption", "description": "本接口（AddClusterStorageOption）用于添加集群存储选项信息。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID。", "example": "hpc-5lyv94lq" }, { "name": "StorageOption", "type": "object", "required": true, "description": "集群存储选项；集群已存在的节点和新增节点都会挂载此存储。", "example": "无", "children": [ { "name": "CFSOptions", "type": "array", "required": false, "description": "集群挂载CFS文件系统选项。", "example": "无", "item_type": "object", "children": [ { "name": "LocalPath", "type": "string", "required": true, "description": "文件系统本地挂载路径。", "example": "/data/" }, { "name": "RemotePath", "type": "string", "required": false, "description": "文件系统远程挂载ip及路径。", "example": "172.0.0.1:/" }, { "name": "Protocol", "type": "string", "required": false, "description": "文件系统协议类型。 NFS 3.0 NFS 4.0 TURBO", "example": "NFS 4.0" }, { "name": "StorageType", "type": "string", "required": false, "description": "文件系统存储类型，默认值SD；其中 SD 为通用标准型标准型存储， HP为通用性能型存储， TB为turbo标准型， TP 为turbo性能型。", "example": "SD" }, { "name": "MountOption", "type": "string", "required": false, "description": "文件系统挂载挂载命令参数选项。 - NFS 3.0默认值：vers=3,nolock,proto=tcp,noresvport - NFS 4.0默认值：vers=4.0,noresvport - TURBO默认值：user_xattr", "example": "vers=4.0,noresvport" }, { "name": "FileSystemId", "type": "string", "required": false, "description": "文件系统ID 文件系统ID通过调用接口[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)获取。", "example": "cfs-7641x0zh" } ] }, { "name": "GooseFSOptions", "type": "array", "required": false, "description": "集群挂载GooseFS文件系统选项。", "example": "无", "item_type": "object", "children": [ { "name": "LocalPath", "type": "string", "required": true, "description": "文件系统本地挂载路径。", "example": "/data" }, { "name": "RemotePath", "type": "string", "required": true, "description": "文件系统远程挂载路径。", "example": "/data/goosefs-fuse" }, { "name": "Masters", "type": "array", "required": true, "description": "文件系统master的ip和端口。", "example": "[\"172.16.0.2:55533\",\"172.16.0.3:55533\",\"172.16.0.4:55533\"]", "item_type": "string" } ] }, { "name": "GooseFSxOptions", "type": "array", "required": false, "description": "集群挂载GooseFSx文件系统选项。", "example": "无", "item_type": "object", "children": [ { "name": "Masters", "type": "array", "required": false, "description": "文件系统master的ip和端口列表。", "example": "[\"172.16.0.2:55533\",\"172.16.0.3:55533\",\"172.16.0.4:55533\"]", "item_type": "string" }, { "name": "LocalPath", "type": "string", "required": false, "description": "文件系统的本地挂载路径。GooseFSx目前只支持挂载在/goosefsx/{文件系统ID}_proxy/目录下。", "example": "/goosefsx/x_c60_54oi5id3_proxy/" }, { "name": "FileSystemId", "type": "string", "required": false, "description": "GooseFSx文件系统ID 文件系统ID通过调用接口[DescribeFileSystems](https://cloud.tencent.com/document/api/1424/95789)获取。", "example": "x-c60-fc9373xp" } ] } ] } ], "required": [ "ClusterId", "StorageOption" ] }, { "name": "AddNodes", "description": "本接口(AddNodes)用于添加一个或者多个计算节点或者登录节点到指定集群。", "status": "online", "parameters": [ { "name": "Placement", "type": "object", "required": true, "description": "集群中实例所在的位置。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区名称。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou-1" } ] }, { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID。", "example": "hpc-xxx" }, { "name": "VirtualPrivateCloud", "type": "object", "required": true, "description": "私有网络相关信息配置。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询；也可以调用接口 [DescribeVpcEx](/document/api/215/1372) ，从接口返回中的`unVpcId`字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`，则强制使用默认vpc网络。 注意：此字段可能返回 null，表示取不到有效值。", "example": "vpc-jfkanfen" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询；也可以调用接口 [DescribeSubnets](/document/api/215/15784) ，从接口返回中的`unSubnetId`字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`，则强制使用默认vpc网络。 注意：此字段可能返回 null，表示取不到有效值。", "example": "subnet-jfnakenf" } ] }, { "name": "Count", "type": "integer", "required": true, "description": "添加节点数量。", "example": "1" }, { "name": "ImageId", "type": "string", "required": false, "description": "指定有效的镜像ID，格式形如img-xxx。目前支持部分公有镜像和自定义镜像。公共镜像请参考镜像限制", "example": "img-xxx" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "节点计费类型。PREPAID：预付费，即包年包月POSTPAID_BY_HOUR：按小时后付费SPOTPAID：竞价付费默认值：POSTPAID_BY_HOUR。", "example": "PREPAID" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NOTIFY_AND_AUTO_RENEW" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "节点机型。不同实例机型指定了不同的资源规格。具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表或参见实例规格描述。", "example": "S5.LARGE4" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见存储概述。取值范围： CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 默认取值：当前有库存的硬盘类型。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CLOUD_BASIC" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GB。默认值为 50 注意：此字段可能返回 null，表示取不到有效值。", "example": "50" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。", "example": "无", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小，单位：GB。最小调整步长为10G，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定CLOUD_BASIC：普通云硬盘CLOUD_PREMIUM：高性能云硬盘CLOUD_SSD：SSD云硬盘CLOUD_HSSD：增强型SSD云硬盘CLOUD_TSSD：极速型SSD云硬盘CLOUD_BSSD：通用型SSD云硬盘 注意：此字段可能返回 nul...", "example": "CLOUD_BASIC" } ] }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型。取值范围： BANDWIDTH_PREPAID：预付费按带宽结算 TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费 BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费 BANDWIDTH_PACKAGE：带宽包用户 默认取值：非带宽包用户默认与子机付费类型保持一致。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见购买网络带宽。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "InstanceName", "type": "string", "required": false, "description": "节点显示名称。不指定节点显示名称则默认显示‘未命名’。最多支持60个字符。", "example": "server_{R:3}" }, { "name": "LoginSettings", "type": "object", "required": false, "description": "集群登录设置。", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到\ufffd...", "example": "test@123456" }, { "name": "KeyIds", "type": "array", "required": false, "description": "实例登录密钥", "example": "sky-xxx", "item_type": "string" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "集群中实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。", "example": "[\"sg-ajhn9qtq\"]", "item_type": "string" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "system-f3827db9-c58a-49cc-bf10-33fc1923a34a" }, { "name": "QueueName", "type": "string", "required": false, "description": "队列名称。不指定则为默认队列。SLURM默认队列为：compute。", "example": "compute" }, { "name": "NodeRole", "type": "string", "required": false, "description": "添加节点角色。默认值：ComputeCompute：计算节点。Login：登录节点。", "example": "Compute" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否只预检此次请求。true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和云服务器库存。如果检查不通过，则返回对应错误码；如果检查通过，则返回RequestId.false（默认）：发送正常请求，通过检查后直接创建实例", "example": "false" }, { "name": "NodeType", "type": "string", "required": false, "description": "添加节点类型。默认取值：STATIC。STATIC：静态节点，不会参与弹性伸缩流程。DYNAMIC：弹性节点，会被弹性缩容的节点。管控节点和登录节点不支持此参数。", "example": "STATIC" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "0" }, { "name": "ResourceType", "type": "string", "required": false, "description": "要新增节点的资源类型。CVM：CVM实例类型资源WORKSPACE：工作空间类型实例资源默认值：CVM。", "example": "CVM" } ], "required": [ "Placement", "ClusterId", "VirtualPrivateCloud", "Count" ] }, { "name": "AddQueue", "description": "本接口(AddQueue)用于添加队列到指定集群。 * 本接口为目前只支持SchedulerType为SLURM的集群。 * 单个集群中队列数量上限为10个。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID。", "example": "hpc-prkxbd7c" }, { "name": "QueueName", "type": "string", "required": true, "description": "队列名称。最多支持32个字符。", "example": "compute" } ], "required": [ "ClusterId", "QueueName" ] }, { "name": "AttachNodes", "description": "本接口 (AttachNodes) 用于绑定一个或者多个计算节点指定资源到指定集群中。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "hpc-cy4pnyp9" }, { "name": "ResourceSet", "type": "array", "required": true, "description": "节点的实例id列表", "example": "[\"ins-a437qz3d\"]", "item_type": "string" }, { "name": "QueueName", "type": "string", "required": false, "description": "队列名称。不指定则为默认队列：SLURM默认队列为：compute。", "example": "compute" }, { "name": "ImageId", "type": "string", "required": false, "description": "指定有效的镜像ID，格式形如img-xxx。目前仅支持公有镜像和特定自定义镜像。如不指定，则该字段是默认镜像。", "example": "img-n7nyt2d7" }, { "name": "ResourceType", "type": "string", "required": false, "description": "要新增节点的资源类型。CVM：CVM实例类型资源WORKSPACE：工作空间类型实例资源默认值：CVM。", "example": "CVM" }, { "name": "UserData", "type": "string", "required": false, "description": "提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16KB。关于获取此参数的详细介绍，请参阅Windows和Linux启动时运行命令。", "example": "IyEvYmluL2Jhc2gKZWNobyAiSGVsbG8gV29ybGQuIFRoZSB0aW1lIGlzIG5vdyAkKGRhdGUgLVIpISIgPiAgL3RtcC91c3JfZGF0YS50eHQ=" }, { "name": "SkipResetInstance", "type": "boolean", "required": false, "description": "控制实例加入集群是否跳过重装系统默认值：False", "example": "false" } ], "required": [ "ClusterId", "ResourceSet" ] }, { "name": "CreateCluster", "description": "本接口 (CreateCluster) 用于创建并启动集群。 * 本接口为异步接口， 当创建集群请求下发成功后会返回一个集群`ID`和一个`RequestId`，此时创建集群操作并未立即完成。在此期间集群的状态将会处于“PENDING”或者“INITING”，集群创建结果可以通过调用 [DescribeClusters](https://cloud.tencent.com/document/product/1527/72100) 接口查询，如果集群状态(ClusterStatus)变为“RUNNING(运行中)”，则代表集群创...", "status": "online", "parameters": [ { "name": "Placement", "type": "object", "required": false, "description": "集群中实例所在的位置。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区名称。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou-1" } ] }, { "name": "ManagerNode", "type": "object", "required": false, "description": "指定管理节点。", "example": "无", "children": [ { "name": "InstanceChargeType", "type": "string", "required": false, "description": "节点计费类型。枚举值： PREPAID： 预付费，即包年包月 POSTPAID_BY_HOUR： 按小时后付费", "example": "POSTPAID_BY_HOUR" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NOTIFY_AND_AUTO_RENEW" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "节点机型。不同实例机型指定了不同的资源规格。 具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表或参见实例规格描述。", "example": "S2.SMALL2" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见存储概述。取值范围： CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 默认取值：当前有库存的硬盘类型。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CLOUD_BASIC" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GB。默认值为 50 注意：此字段可能返回 null，表示取不到有效值。", "example": "50" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。", "example": "无", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小，单位：GB。最小调整步长为10G，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定CLOUD_BASIC：普通云硬盘CLOUD_PREMIUM：高性能云硬盘CLOUD_SSD：SSD云硬盘CLOUD_HSSD：增强型SSD云硬盘CLOUD_TSSD：极速型SSD云硬盘CLOUD_BSSD：通用型SSD云硬盘 注意：此字段可能返回 nul...", "example": "CLOUD_BASIC" } ] }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型。取值范围： BANDWIDTH_PREPAID：预付费按带宽结算 TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费 BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费 BANDWIDTH_PACKAGE：带宽包用户 默认取值：非带宽包用户默认与子机付费类型保持一致。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见购买网络带宽。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "InstanceName", "type": "string", "required": false, "description": "节点显示名称。 不指定节点显示名称则默认显示‘未命名’。 购买多个节点，如果指定模式串{R:x}，表示生成数字[[x, x+n-1]，其中n表示购买节点的数量，例如server_{R:3}，购买1个时，节点显示名称为server_3；购买2个时，节点显示名称分别为server_3，server_4。支持指定多个模式串{R:x}。 购买多个节点，如果不指定模式串，则在节点显示名称添加后缀1、2...n，其中n表示购买节点的数\ufffd...", "example": "未命名" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "0" }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务。通过该参数可以指定是否开启云安全、腾讯云可观测平台等服务。若不指定该参数，则默认开启腾讯云可观测平台、云安全服务、自动化助手服务。", "example": "无", "children": [ { "name": "SecurityService", "type": "object", "required": false, "description": "开启云安全服务。若不指定该参数，则默认开启云安全服务。", "example": "TRUE", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云安全](/document/product/296)服务。取值范围：TRUE：表示开启云安全服务FALSE：表示不开启云安全服务默认取值：TRUE。", "example": "true" } ] }, { "name": "MonitorService", "type": "object", "required": false, "description": "开启腾讯云可观测平台服务。若不指定该参数，则默认开启腾讯云可观测平台服务。", "example": "TRUE", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[腾讯云可观测平台](/document/product/248)服务。取值范围：TRUE：表示开启腾讯云可观测平台服务FALSE：表示不开启腾讯云可观测平台服务默认取值：TRUE。", "example": "true" } ] }, { "name": "AutomationService", "type": "object", "required": false, "description": "开启云自动化助手服务（TencentCloud Automation Tools，TAT）。若不指定该参数，默认开启云自动化助手服务。", "example": "TRUE", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启云自动化助手。取值范围：TRUE：表示开启云自动化助手服务FALSE：表示不开启云自动化助手服务默认取值：TRUE。", "example": "true" } ] } ] } ] }, { "name": "ManagerNodeCount", "type": "integer", "required": false, "description": "指定管理节点的数量。默认取值：1。取值范围：1～2。", "example": "1" }, { "name": "ComputeNode", "type": "object", "required": false, "description": "指定计算节点。", "example": "无", "children": [ { "name": "InstanceChargeType", "type": "string", "required": false, "description": "节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID：预付费，即包年包月POSTPAID_BY_HOUR：按小时后付费SPOTPAID：竞价付费默认值：POSTPAID_BY_HOUR。", "example": "POSTPAID_BY_HOUR" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。", "example": "{\"Period\":1,\"RenewFlag\":\"NOTIFY_AND_AUTO_RENEW\"}\t", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NOTIFY_AND_AUTO_RENEW" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "节点机型。不同实例机型指定了不同的资源规格。具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。", "example": "S2.SMALL2" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。", "example": "{\"DiskSize\":50,\"DiskType\":\"CLOUD_PREMIUM\",\"DiskBackupQuota\":1}\t", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见存储概述。取值范围： CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 默认取值：当前有库存的硬盘类型。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CLOUD_BASIC" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GB。默认值为 50 注意：此字段可能返回 null，表示取不到有效值。", "example": "50" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。", "example": "[{\"DiskSize\":50,\"DiskType\":\"CLOUD_PREMIUM\",\"DiskBackupQuota\":1}]\t", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小，单位：GB。最小调整步长为10G，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定CLOUD_BASIC：普通云硬盘CLOUD_PREMIUM：高性能云硬盘CLOUD_SSD：SSD云硬盘CLOUD_HSSD：增强型SSD云硬盘CLOUD_TSSD：极速型SSD云硬盘CLOUD_BSSD：通用型SSD云硬盘 注意：此字段可能返回 nul...", "example": "CLOUD_BASIC" } ] }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。", "example": "{\"PublicIpAssigned\":true,\"InternetMaxBandwidthOut\":5}\t", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型。取值范围： BANDWIDTH_PREPAID：预付费按带宽结算 TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费 BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费 BANDWIDTH_PACKAGE：带宽包用户 默认取值：非带宽包用户默认与子机付费类型保持一致。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见购买网络带宽。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "InstanceName", "type": "string", "required": false, "description": "节点显示名称。不指定节点显示名称则默认显示‘未命名’。 最多支持60个字符。", "example": "未命名" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "0" }, { "name": "ResourceType", "type": "string", "required": false, "description": "实例资源类型，默认是CVM资源", "example": "CVM" } ] }, { "name": "ComputeNodeCount", "type": "integer", "required": false, "description": "指定计算节点的数量。默认取值：0。", "example": "1" }, { "name": "SchedulerType", "type": "string", "required": false, "description": "调度器类型。默认取值：SLURM。SLURM：SLURM调度器。", "example": "SLURM" }, { "name": "SchedulerVersion", "type": "string", "required": false, "description": "创建调度器的版本号，可填写版本号为“latest” 和 各调度器支持的版本号；如果是\u0026quot;latest\u0026quot;, 则代表创建的是平台当前支持的该类型调度器最新版本。如果不填写，默认创建的是“latest”版本调度器各调度器支持的集群版本：SLURM：21.08.8、23.11.7", "example": "23.11.7" }, { "name": "ImageId", "type": "string", "required": false, "description": "指定有效的镜像ID，格式形如img-xxx。目前支持部分公有镜像和自定义镜像。公共镜像请参考镜像限制", "example": "img-xxx" }, { "name": "VirtualPrivateCloud", "type": "object", "required": false, "description": "私有网络相关信息配置。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询；也可以调用接口 [DescribeVpcEx](/document/api/215/1372) ，从接口返回中的`unVpcId`字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`，则强制使用默认vpc网络。 注意：此字段可能返回 null，表示取不到有效值。", "example": "vpc-jfkanfen" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询；也可以调用接口 [DescribeSubnets](/document/api/215/15784) ，从接口返回中的`unSubnetId`字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`，则强制使用默认vpc网络。 注意：此字段可能返回 null，表示取不到有效值。", "example": "subnet-jfnakenf" } ] }, { "name": "LoginSettings", "type": "object", "required": false, "description": "集群登录设置。", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到\ufffd...", "example": "test@123456" }, { "name": "KeyIds", "type": "array", "required": false, "description": "实例登录密钥", "example": "sky-xxx", "item_type": "string" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "集群中实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。", "example": "[\"sg-ajhn9qtq\"]", "item_type": "string" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "system-f3827db9-c58a-49cc-bf10-33fc1923a34a" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否只预检此次请求。true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和云服务器库存。如果检查不通过，则返回对应错误码；如果检查通过，则返回RequestId.false（默认）：发送正常请求，通过检查后直接创建实例", "example": "false" }, { "name": "AccountType", "type": "string", "required": false, "description": "域名字服务类型。默认取值：NIS。NIS：NIS域名字服务。", "example": "NIS" }, { "name": "ClusterName", "type": "string", "required": false, "description": "集群显示名称。", "example": "cluster-test" }, { "name": "StorageOption", "type": "object", "required": false, "description": "集群存储选项", "example": "无", "children": [ { "name": "CFSOptions", "type": "array", "required": false, "description": "集群挂载CFS文件系统选项。", "example": "无", "item_type": "object", "children": [ { "name": "LocalPath", "type": "string", "required": true, "description": "文件系统本地挂载路径。", "example": "/data/" }, { "name": "RemotePath", "type": "string", "required": false, "description": "文件系统远程挂载ip及路径。", "example": "172.0.0.1:/" }, { "name": "Protocol", "type": "string", "required": false, "description": "文件系统协议类型。 NFS 3.0 NFS 4.0 TURBO", "example": "NFS 4.0" }, { "name": "StorageType", "type": "string", "required": false, "description": "文件系统存储类型，默认值SD；其中 SD 为通用标准型标准型存储， HP为通用性能型存储， TB为turbo标准型， TP 为turbo性能型。", "example": "SD" }, { "name": "MountOption", "type": "string", "required": false, "description": "文件系统挂载挂载命令参数选项。 - NFS 3.0默认值：vers=3,nolock,proto=tcp,noresvport - NFS 4.0默认值：vers=4.0,noresvport - TURBO默认值：user_xattr", "example": "vers=4.0,noresvport" }, { "name": "FileSystemId", "type": "string", "required": false, "description": "文件系统ID 文件系统ID通过调用接口[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)获取。", "example": "cfs-7641x0zh" } ] }, { "name": "GooseFSOptions", "type": "array", "required": false, "description": "集群挂载GooseFS文件系统选项。", "example": "无", "item_type": "object", "children": [ { "name": "LocalPath", "type": "string", "required": true, "description": "文件系统本地挂载路径。", "example": "/data" }, { "name": "RemotePath", "type": "string", "required": true, "description": "文件系统远程挂载路径。", "example": "/data/goosefs-fuse" }, { "name": "Masters", "type": "array", "required": true, "description": "文件系统master的ip和端口。", "example": "[\"172.16.0.2:55533\",\"172.16.0.3:55533\",\"172.16.0.4:55533\"]", "item_type": "string" } ] }, { "name": "GooseFSxOptions", "type": "array", "required": false, "description": "集群挂载GooseFSx文件系统选项。", "example": "无", "item_type": "object", "children": [ { "name": "Masters", "type": "array", "required": false, "description": "文件系统master的ip和端口列表。", "example": "[\"172.16.0.2:55533\",\"172.16.0.3:55533\",\"172.16.0.4:55533\"]", "item_type": "string" }, { "name": "LocalPath", "type": "string", "required": false, "description": "文件系统的本地挂载路径。GooseFSx目前只支持挂载在/goosefsx/{文件系统ID}_proxy/目录下。", "example": "/goosefsx/x_c60_54oi5id3_proxy/" }, { "name": "FileSystemId", "type": "string", "required": false, "description": "GooseFSx文件系统ID 文件系统ID通过调用接口[DescribeFileSystems](https://cloud.tencent.com/document/api/1424/95789)获取。", "example": "x-c60-fc9373xp" } ] } ] }, { "name": "LoginNode", "type": "object", "required": false, "description": "指定登录节点。", "example": "无", "children": [ { "name": "InstanceChargeType", "type": "string", "required": false, "description": "节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID：预付费，即包年包月POSTPAID_BY_HOUR：按小时后付费SPOTPAID：竞价付费默认值：POSTPAID_BY_HOUR。", "example": "POSTPAID_BY_HOUR" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。", "example": "{\"Period\":1,\"RenewFlag\":\"NOTIFY_AND_AUTO_RENEW\"}\t", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NOTIFY_AND_AUTO_RENEW" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "节点机型。不同实例机型指定了不同的资源规格。 具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。", "example": "S2.SMALL2" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。", "example": "{\"DiskSize\":50,\"DiskType\":\"CLOUD_PREMIUM\",\"DiskBackupQuota\":1}\t", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见存储概述。取值范围： CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 默认取值：当前有库存的硬盘类型。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CLOUD_BASIC" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GB。默认值为 50 注意：此字段可能返回 null，表示取不到有效值。", "example": "50" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。", "example": "[{\"DiskSize\":50,\"DiskType\":\"CLOUD_PREMIUM\",\"DiskBackupQuota\":1}]\t", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小，单位：GB。最小调整步长为10G，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定CLOUD_BASIC：普通云硬盘CLOUD_PREMIUM：高性能云硬盘CLOUD_SSD：SSD云硬盘CLOUD_HSSD：增强型SSD云硬盘CLOUD_TSSD：极速型SSD云硬盘CLOUD_BSSD：通用型SSD云硬盘 注意：此字段可能返回 nul...", "example": "CLOUD_BASIC" } ] }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。", "example": "{\"PublicIpAssigned\":true,\"InternetMaxBandwidthOut\":5}\t", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型。取值范围： BANDWIDTH_PREPAID：预付费按带宽结算 TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费 BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费 BANDWIDTH_PACKAGE：带宽包用户 默认取值：非带宽包用户默认与子机付费类型保持一致。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见购买网络带宽。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "InstanceName", "type": "string", "required": false, "description": "节点显示名称。 不指定节点显示名称则默认显示‘未命名’。 最多支持60个字符。", "example": "未命名" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "0" } ] }, { "name": "LoginNodeCount", "type": "integer", "required": false, "description": "指定登录节点的数量。默认取值：0。取值范围：0～10。", "example": "1" }, { "name": "Tags", "type": "array", "required": false, "description": "创建集群时同时绑定的标签对说明。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "env" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "product" } ] }, { "name": "AutoScalingType", "type": "string", "required": false, "description": "弹性伸缩类型。默认值：THPC_AS", "example": "THPC_AS" }, { "name": "InitNodeScripts", "type": "array", "required": false, "description": "节点初始化脚本信息列表。", "example": "无", "item_type": "object", "children": [ { "name": "ScriptPath", "type": "string", "required": true, "description": "节点执行脚本获取地址。 目前仅支持cos地址。地址最大长度：255。", "example": "cos://demo-xxxxxxxx.cos.ap-guangzhou.myqcloud.com/test/echo.sh" }, { "name": "Timeout", "type": "integer", "required": false, "description": "脚本执行超时时间（包含拉取脚本的时间）。单位秒，默认值：30。取值范围：10～1200。", "example": "30" } ] }, { "name": "HpcClusterId", "type": "string", "required": false, "description": "高性能计算集群ID。若创建的实例为高性能计算实例，需指定实例放置的集群，否则不可指定。", "example": "hpc-xxx" } ], "required": [] }, { "name": "CreateWorkspaces", "description": "本接口 (CreateWorkspaces) 用于创建工作空间。", "status": "online", "parameters": [ { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "system-f3827db9-c58a-49cc-bf10-33fc1923a34a" }, { "name": "Placement", "type": "object", "required": false, "description": "实例所在的位置。通过该参数可以指定实例所属可用区，所属项目，所属宿主机（在专用宿主机上创建子机时指定）等属性。 注：如果您不指定LaunchTemplate参数，则Placement为必选参数。若同时传递Placement和LaunchTemplate，则默认覆盖LaunchTemplate中对应的Placement的值。", "example": "{ \"Zone\": \"ap-guangzhou-6\" }\t", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区", "example": "ap-guangzhou-1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目，默认是0", "example": "0" } ] }, { "name": "SpaceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "{\"Period\":1,\"RenewFlag\":\"NOTIFY_AND_AUTO_RENEW\"}", "children": [ { "name": "Period", "type": "integer", "required": false, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 12, 24, 36。默认取值为1。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NOTIFY_AND_AUTO_RENEW" } ] }, { "name": "SpaceChargeType", "type": "string", "required": false, "description": "工作空间计费类型，包括：PREPAID，UNDERWRITE。工作空间计费类型，包括：PREPAID，UNDERWRITE。", "example": "PREPAID" }, { "name": "SpaceType", "type": "string", "required": false, "description": "工作空间规格", "example": "96A.96XLARGE2304" }, { "name": "ImageId", "type": "string", "required": false, "description": "镜像ID", "example": "img-irmer45l" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "工作空间系统盘信息", "example": "{\"DiskSize\":50,\"DiskType\":\"CLOUD_PREMIUM\",\"DiskBackupQuota\":1}", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_BASIC：本地硬盘LOCAL_SSD：本地SSD硬盘CLOUD_BASIC：普通云硬盘CLOUD_SSD：SSD云硬盘CLOUD_PREMIUM：高性能云硬盘CLOUD_BSSD：通用性SSD云硬盘CLOUD_HSSD：增强型SSD云硬盘CLOUD_TSSD：极速型SSD云硬盘默认取值：当前有库存的硬盘类型。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CLOUD_HSSD" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GB。默认值为 50 注意：此字段可能返回 null，表示取不到有效值。", "example": "50" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "工作空间数据盘信息", "example": "[{\"DiskSize\":50,\"DiskType\":\"CLOUD_PREMIUM\",\"DiskBackupQuota\":1}]", "item_type": "object", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定 LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定 CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 CLOUD_...", "example": "CLOUD_SSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "数据盘 注意：此字段可能返回 null，表示取不到有效值。", "example": "disk-ciezoimt" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "数据盘大小，单位：GB。最小调整步长为10G，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。", "example": "50" }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "数据盘是否随子机销毁。取值范围： TRUE：子机销毁时，销毁数据盘，只支持按小时后付费云盘 FALSE：子机销毁时，保留数据盘 默认取值：TRUE 该参数目前仅用于 `RunInstances` 接口。 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "SnapshotId", "type": "string", "required": false, "description": "数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。 注意：此字段可能返回 null，表示取不到有效值。", "example": "snap-6yczrj8x\t" }, { "name": "Encrypt", "type": "boolean", "required": false, "description": "数据盘是加密。取值范围： true：加密 false：不加密 默认取值：false 该参数目前仅用于 `RunInstances` 接口。 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "KmsKeyId", "type": "string", "required": false, "description": "自定义CMK对应的ID，取值为UUID或者类似kms-abcd1234。用于加密云盘。 该参数目前仅用于 `CreateWorkspaces` 接口。 注意：此字段可能返回 null，表示取不到有效值。", "example": "kms-abcd1234\t" }, { "name": "ThroughputPerformance", "type": "integer", "required": false, "description": "云硬盘性能，单位：MB/s 注意：此字段可能返回 null，表示取不到有效值。", "example": "20" }, { "name": "BurstPerformance", "type": "boolean", "required": false, "description": "突发性能 注：内测中。 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" } ] }, { "name": "VirtualPrivateCloud", "type": "object", "required": false, "description": "私有网络相关信息", "example": "{\"VpcId\":\"vpc-nrqwfyzv\",\"SubnetId\":\"subnet-0tmm4ywk\"}", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID", "example": "vpc-2ij" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网ID", "example": "subnet-2ks" }, { "name": "AsVpcGateway", "type": "boolean", "required": false, "description": "是否用作公网网关", "example": "false" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "私有网络子网 IP 数组", "example": "[\"10.0.0.1\"]", "item_type": "string" }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "为弹性网卡指定随机生成", "example": "1" } ] }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置", "example": "{\"PublicIpAssigned\":true,\"InternetMaxBandwidthOut\":5}", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "BANDWIDTH_PREPAID\t" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，默认为0 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "PublicIpAssigned", "type": "boolean", "required": false, "description": "是否分配公网IP 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "bwp-h1ro\t" } ] }, { "name": "SpaceCount", "type": "integer", "required": false, "description": "购买工作空间实例的数量", "example": "1" }, { "name": "SpaceName", "type": "string", "required": false, "description": "工作空间显示名称", "example": "workspace" }, { "name": "LoginSettings", "type": "object", "required": false, "description": "工作空间登录设置", "example": "{ \"KeyIds\": [ \"skey-9tzxxb4j\" ] }", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到\ufffd...", "example": "test@123456" }, { "name": "KeyIds", "type": "array", "required": false, "description": "实例登录密钥", "example": "sky-xxx", "item_type": "string" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "工作空间所属安全组", "example": "[\"sg-ajhn9qtq\"]", "item_type": "string" }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务", "example": "{\"SecurityService\":{\"Enabled\":true},\"MonitorService\":{\"Enabled\":true},\"AutomationService\":{\"Enabled\":true}}", "children": [ { "name": "SecurityService", "type": "object", "required": false, "description": "开启云安全服务。若不指定该参数，则默认开启云安全服务。", "example": "TRUE", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云安全](/document/product/296)服务。取值范围：TRUE：表示开启云安全服务FALSE：表示不开启云安全服务默认取值：TRUE。", "example": "true" } ] }, { "name": "MonitorService", "type": "object", "required": false, "description": "开启腾讯云可观测平台服务。若不指定该参数，则默认开启腾讯云可观测平台服务。", "example": "TRUE", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[腾讯云可观测平台](/document/product/248)服务。取值范围：TRUE：表示开启腾讯云可观测平台服务FALSE：表示不开启腾讯云可观测平台服务默认取值：TRUE。", "example": "true" } ] }, { "name": "AutomationService", "type": "object", "required": false, "description": "开启云自动化助手服务（TencentCloud Automation Tools，TAT）。若不指定该参数，默认开启云自动化助手服务。", "example": "TRUE", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启云自动化助手。取值范围：TRUE：表示开启云自动化助手服务FALSE：表示不开启云自动化助手服务默认取值：TRUE。", "example": "true" } ] } ] }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否只预检此次请求", "example": "false" }, { "name": "UserData", "type": "string", "required": false, "description": "提供给工作空间使用的用户数据", "example": "TXlVc2VyRGF0YQo=" }, { "name": "DisasterRecoverGroupIds", "type": "array", "required": false, "description": "置放群组id", "example": "['ps-3p88qhfo']", "item_type": "string" }, { "name": "TagSpecification", "type": "array", "required": false, "description": "标签描述列表", "example": "[{\"Tags\":[{\"Key\":\"ENV\",\"Value\":\"product\"}]}]", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "标签绑定的资源类型", "example": "workspace" }, { "name": "Tags", "type": "array", "required": true, "description": "标签对列表", "example": "[{\"Name\": \"env\", \"Value\": \"test\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "env" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "product" } ] } ] }, { "name": "HpcClusterId", "type": "string", "required": false, "description": "高性能计算集群ID", "example": "hpc-a5n666lo" }, { "name": "CamRoleName", "type": "string", "required": false, "description": "CAM角色名称", "example": "testroleName001" }, { "name": "HostName", "type": "string", "required": false, "description": "实例主机名。点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。Windows 实例：主机名名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。其他类型（Linux 等）实例：主机名字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。购买多台实例\ufffd...", "example": "MyHostName" } ], "required": [] }, { "name": "DeleteCluster", "description": "本接口（DeleteCluster）用于删除一个指定的集群。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID。", "example": "hpc-5lyv94lq" } ], "required": [ "ClusterId" ] }, { "name": "DeleteClusterStorageOption", "description": "本接口 (DeleteClusterStorageOption) 用于删除集群存储选项信息。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID。", "example": "hpc-5lyv94lq" }, { "name": "LocalPath", "type": "string", "required": true, "description": "本地挂载路径。", "example": "/data/" } ], "required": [ "ClusterId", "LocalPath" ] }, { "name": "DeleteJob", "description": "本接口 (DeleteJob) 用于删除一个作业任务。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "作业任务ID", "example": "job-xxx" } ], "required": [ "JobId" ] }, { "name": "DeleteNodes", "description": "本接口(DeleteNodes)用于删除指定集群中一个或者多个计算节点或者登录节点。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID。", "example": "hpc-5lyv94lq" }, { "name": "NodeIds", "type": "array", "required": true, "description": "节点ID。", "example": "[\"node-xxx\"]", "item_type": "string" } ], "required": [ "ClusterId", "NodeIds" ] }, { "name": "DeleteQueue", "description": "本接口(DeleteQueue)用于从指定集群删除队列。 * 本接口为目前只支持SchedulerType为SLURM的集群。 * 删除队列时，需要保证队列内不存在节点。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID。", "example": "hpc-prkxbd7c" }, { "name": "QueueName", "type": "string", "required": true, "description": "队列名称。最多支持32个字符。", "example": "compute" } ], "required": [ "ClusterId", "QueueName" ] }, { "name": "DescribeAutoScalingConfiguration", "description": "本接口(DescribeAutoScalingConfiguration)用于查询集群弹性伸缩配置信息。本接口仅适用于弹性伸缩类型为THPC_AS的集群。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID。", "example": "hpc-5lyv94lq" }, { "name": "QueueName", "type": "string", "required": false, "description": "队列名称", "example": "compute" } ], "required": [ "ClusterId" ] }, { "name": "DescribeClusterActivities", "description": "本接口（DescribeClusterActivities）用于查询集群活动历史记录列表。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID。通过该参数指定需要查询活动历史记录的集群。", "example": "hpc-myd8fgsc" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。", "example": "20" } ], "required": [ "ClusterId" ] }, { "name": "DescribeClusterStorageOption", "description": "本接口 (DescribeClusterStorageOption) 用于查询集群存储选项信息。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID。", "example": "hpc-5lyv94lq" } ], "required": [ "ClusterId" ] }, { "name": "DescribeClusters", "description": "本接口（DescribeClusters）用于查询集群列表。", "status": "online", "parameters": [ { "name": "ClusterIds", "type": "array", "required": false, "description": "集群ID列表。通过该参数可以指定需要查询信息的集群列表。如果您不指定该参数，则返回Limit数量以内的集群信息。", "example": "[\"hpc-xxx\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "cluster-type 按照【集群类型】进行过滤 类型：String 必选：否 每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "fiter-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "fiter-value", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeInitNodeScripts", "description": "本接口 (DescribeInitNodeScripts) 用于查询节点初始化脚本列表。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID。", "example": "hpc-5lyv94lq" } ], "required": [ "ClusterId" ] }, { "name": "DescribeJobSubmitInfo", "description": "本接口用于查询作业的提交信息。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "作业ID", "example": "job-mudowi62" } ], "required": [ "JobId" ] }, { "name": "DescribeJobs", "description": "本接口 (DescribeJobs) 用于查询作业任务列表信息。", "status": "online", "parameters": [ { "name": "JobIds", "type": "array", "required": false, "description": "作业任务ID列表", "example": "[\"job-xxx\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤列表", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "fiter-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "fiter-value", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。 关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "20" } ], "required": [] }, { "name": "DescribeJobsOverview", "description": "本接口 (DescribeJobs) 用于查询作业任务列表信息。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID", "example": "hpc-xxx" } ], "required": [ "ClusterId" ] }, { "name": "DescribeNodes", "description": "本接口 (DescribeNodes) 用于查询指定集群节点概览信息列表。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": false, "description": "集群ID。", "example": "hpc-5lyv94lq" }, { "name": "Filters", "type": "array", "required": false, "description": "queue-name 按照【队列名称】进行过滤。队列名称形如：compute。 类型：String 必选：否 node-role 按照【节点角色】进行过滤。节点角色形如：Manager。（Manager：管控节点。Compute：计算节点。Login：登录节点。ManagerBackup：备用管控节点。） 类型：String 必选：否 node-type 按照【节点类型】进行过滤。节点类型形如：STATIC。(STATIC：静态节点。DYNAMIC：弹性节点。) 类型：String 必选：否 ins...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "fiter-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "fiter-value", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "20" } ], "required": [] }, { "name": "DescribeQueues", "description": "本接口(DescribeQueues)用于查询指定集群队列概览信息列表。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID。", "example": "hpc-5lyv94lq" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "20" } ], "required": [ "ClusterId" ] }, { "name": "DescribeWorkspaces", "description": "本接口（DescribeWorkspaces）用于查询工作空间列表。", "status": "online", "parameters": [ { "name": "SpaceIds", "type": "array", "required": false, "description": "集群ID列表。通过该参数可以指定需要查询信息的集群列表。如果您不指定该参数，则返回Limit数量以内的集群信息。", "example": "[\"wks-xxx\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "zone 按照【可用区】进行过滤 类型：String 必选：否 space-id 按照【工作空间实例ID】进行过滤 类型：String 必选：否 cvm-instance-id 按照【CVM实例ID】进行过滤 类型：String 必选：否 space-state 按照【工作空间状态】进行过滤 类型：String 必选：否 space-name 按照【工作空间别名】进行过滤 类型：String 必选：否 space-charge-type 按照【工作空间实例付费模式】进行过滤 类型：String 必选：否...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "fiter-name" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "fiter-value", "item_type": "string" } ] } ], "required": [] }, { "name": "DetachNodes", "description": "本接口 (DetachNodes) 用于将一个或者多个计算节点从集群中移除，但是不销毁指定计算资源。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "hpc-2j8ntf9l" }, { "name": "NodeIds", "type": "array", "required": true, "description": "集群中的节点id", "example": "[\"node-9workmoi\"]", "item_type": "string" } ], "required": [ "ClusterId", "NodeIds" ] }, { "name": "ModifyClusterDeletionProtection", "description": "修改集群删除保护状态", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID。", "example": "hpc-cjaqo2i7" }, { "name": "DeletionProtection", "type": "string", "required": true, "description": "集群删除保护开关。 可选值：OFF：关闭集群删除保护。ON：打开集群删除保护。", "example": "OFF" } ], "required": [ "ClusterId", "DeletionProtection" ] }, { "name": "ModifyInitNodeScripts", "description": "本接口 (ModifyInitNodeScripts) 用于修改节点初始化脚本。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID。", "example": "hpc-5lyv94lq" }, { "name": "InitNodeScripts", "type": "array", "required": false, "description": "节点初始化脚本信息列表。", "example": "无", "item_type": "object", "children": [ { "name": "ScriptPath", "type": "string", "required": true, "description": "节点执行脚本获取地址。 目前仅支持cos地址。地址最大长度：255。", "example": "cos://demo-xxxxxxxx.cos.ap-guangzhou.myqcloud.com/test/echo.sh" }, { "name": "Timeout", "type": "integer", "required": false, "description": "脚本执行超时时间（包含拉取脚本的时间）。单位秒，默认值：30。取值范围：10～1200。", "example": "30" } ] } ], "required": [ "ClusterId" ] }, { "name": "ModifyNodeAttribute", "description": "本接口用于修改节点属性", "status": "online", "parameters": [ { "name": "NodeId", "type": "string", "required": true, "description": "节点ID，节点ID通过调用接口 DescribeNodes获取。", "example": "node-xxx" }, { "name": "NodeName", "type": "string", "required": false, "description": "节点别名", "example": "node_1" }, { "name": "NodeAllocateState", "type": "string", "required": false, "description": "资源的分配状态: - IDLE: 资源空闲 - ISOLATE: 资源隔离", "example": "IDLE" }, { "name": "QueueName", "type": "string", "required": false, "description": "目标队列名", "example": "usr_queue" } ], "required": [ "NodeId" ] }, { "name": "ModifyWorkspacesAttribute", "description": "本接口 (ModifyWorkspacesAttribute) 用于修改工作空间的属性（目前只支持修改工作空间的名称）。", "status": "online", "parameters": [ { "name": "SpaceIds", "type": "array", "required": true, "description": "工作空间列表", "example": "[\"wks-rf6ogz49\"]", "item_type": "string" }, { "name": "SpaceName", "type": "string", "required": false, "description": "修改后的工作空间名称。可任意命名，但不得超过60个字符。", "example": "MySpaceName" } ], "required": [ "SpaceIds" ] }, { "name": "ModifyWorkspacesRenewFlag", "description": "本接口 (ModifyWorkspacesAttribute) 用于修改工作空间的属性（目前只支持修改工作空间的名称）。", "status": "online", "parameters": [ { "name": "SpaceIds", "type": "array", "required": true, "description": "工作空间列表", "example": "[\"wks-rf6ogz49\"]", "item_type": "string" }, { "name": "RenewFlag", "type": "string", "required": true, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" } ], "required": [ "SpaceIds", "RenewFlag" ] }, { "name": "SetAutoScalingConfiguration", "description": "本接口(SetAutoScalingConfiguration)用于为集群设置集群弹性伸缩配置信息。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群ID。", "example": "hpc-5lyv94lq" }, { "name": "ExpansionBusyTime", "type": "integer", "required": false, "description": "任务连续等待时间，队列的任务处于连续等待的时间。单位秒。默认值120。", "example": "120" }, { "name": "ShrinkIdleTime", "type": "integer", "required": false, "description": "节点连续空闲（未运行作业）时间，一个节点连续处于空闲状态时间。单位秒。默认值300。", "example": "300" }, { "name": "QueueConfigs", "type": "array", "required": false, "description": "扩容队列配置列表。", "example": "无", "item_type": "object", "children": [ { "name": "QueueName", "type": "string", "required": true, "description": "队列名称。", "example": "compute" }, { "name": "MinSize", "type": "integer", "required": false, "description": "队列中弹性节点数量最小值。默认值：0。取值范围：0～200。", "example": "0" }, { "name": "MaxSize", "type": "integer", "required": false, "description": "队列中弹性节点数量最大值。默认值：10。取值范围：0～200。", "example": "10" }, { "name": "EnableAutoExpansion", "type": "boolean", "required": false, "description": "是否开启自动扩容。", "example": "false" }, { "name": "EnableAutoShrink", "type": "boolean", "required": false, "description": "是否开启自动缩容。", "example": "false" }, { "name": "ImageId", "type": "string", "required": false, "description": "指定有效的镜像ID，格式形如img-xxx。目前仅支持公有镜和特定自定义镜像。", "example": "ins-jfhc307q" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见存储概述。取值范围： CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 默认取值：当前有库存的硬盘类型。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CLOUD_BASIC" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GB。默认值为 50 注意：此字段可能返回 null，表示取不到有效值。", "example": "50" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。", "example": "无", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小，单位：GB。最小调整步长为10G，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定CLOUD_BASIC：普通云硬盘CLOUD_PREMIUM：高性能云硬盘CLOUD_SSD：SSD云硬盘CLOUD_HSSD：增强型SSD云硬盘CLOUD_TSSD：极速型SSD云硬盘CLOUD_BSSD：通用型SSD云硬盘 注意：此字段可能返回 nul...", "example": "CLOUD_BASIC" } ] }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型。取值范围： BANDWIDTH_PREPAID：预付费按带宽结算 TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费 BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费 BANDWIDTH_PACKAGE：带宽包用户 默认取值：非带宽包用户默认与子机付费类型保持一致。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见购买网络带宽。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "ExpansionNodeConfigs", "type": "array", "required": false, "description": "扩容节点配置信息。", "example": "无", "item_type": "object", "children": [ { "name": "Placement", "type": "object", "required": true, "description": "扩容实例所在的位置。", "example": "{\"Zone\": \"ap-guangzhou-1\"}", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区名称。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou-1" } ] }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID：预付费，即包年包月POSTPAID_BY_HOUR：按小时后付费SPOTPAID：竞价付费默认值：POSTPAID_BY_HOUR。", "example": "POSTPAID_BY_HOUR" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。", "example": "{\"Period\":1,\"RenewFlag\":\"NOTIFY_AND_AUTO_RENEW\"}\t", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NOTIFY_AND_AUTO_RENEW" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "节点机型。不同实例机型指定了不同的资源规格。 具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。", "example": "S2.SMALL2" }, { "name": "VirtualPrivateCloud", "type": "object", "required": false, "description": "私有网络相关信息配置。", "example": "{\"VpcId\": \"vpc-xxx\", \"SubnetId\": \"subnet-xxx\"}", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询；也可以调用接口 [DescribeVpcEx](/document/api/215/1372) ，从接口返回中的`unVpcId`字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`，则强制使用默认vpc网络。 注意：此字段可能返回 null，表示取不到有效值。", "example": "vpc-jfkanfen" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询；也可以调用接口 [DescribeSubnets](/document/api/215/15784) ，从接口返回中的`unSubnetId`字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`，则强制使用默认vpc网络。 注意：此字段可能返回 null，表示取不到有效值。", "example": "subnet-jfnakenf" } ] }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "0" } ] }, { "name": "DesiredIdleNodeCapacity", "type": "integer", "required": false, "description": "队列中期望的空闲节点数量（包含弹性节点和静态节点）。默认值：0。队列中，处于空闲状态的节点小于此值，集群会扩容弹性节点；处于空闲状态的节点大于此值，集群会缩容弹性节点。", "example": "5" }, { "name": "DesiredNodeCount", "type": "integer", "required": false, "description": "队列中期望的总节点数。", "example": "1" }, { "name": "ScaleOutRatio", "type": "integer", "required": false, "description": "扩容比例。默认值：100。取值范围：1～100。如果扩容比例为50，那么每轮只会扩容当前作业负载所需的50%数量的节点。", "example": "50" }, { "name": "ScaleOutNodeThreshold", "type": "integer", "required": false, "description": "比例扩容阈值。默认值：0。取值范围：0～200。当作业负载需要扩容节点数量大于此值，当前扩容轮次按照ScaleOutRatio配置的比例进行扩容。当作业负载需要扩容节点数量小于此值，当前扩容轮次扩容当前作业负载所需数量的节点。此参数配合ScaleOutRatio参数进行使用，用于比例扩容场景下，在作业负载所需节点数量较小时，加快收敛速度。", "example": "0" }, { "name": "MaxNodesPerCycle", "type": "integer", "required": false, "description": "每轮扩容最大节点个数。默认值：100。取值范围：1～100。", "example": "10" }, { "name": "ScaleUpMemRatio", "type": "integer", "required": false, "description": "扩容过程中，作业的内存在匹配实例机型时增大比例（不会影响作业提交的内存大小，只影响匹配计算过程）。针对场景：由于实例机型的总内存会大于实例内部的可用内存，16GB内存规格的实例，实例操作系统内的可用内存只有约14.9GB内存。假设此时提交一个需要15GB内存的作业，当ScaleUpMemRatio=0时，会匹配到16GB内存规格的实例,但是由于操作系统内的可用内存为14.9GB小于作业\ufffd\ufffd...", "example": "0" }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务。通过该参数可以指定是否开启云安全、腾讯云可观测平台等服务。若不指定该参数，则默认开启腾讯云可观测平台、云安全服务、自动化助手服务。", "example": "无", "children": [ { "name": "SecurityService", "type": "object", "required": false, "description": "开启云安全服务。若不指定该参数，则默认开启云安全服务。", "example": "TRUE", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云安全](/document/product/296)服务。取值范围：TRUE：表示开启云安全服务FALSE：表示不开启云安全服务默认取值：TRUE。", "example": "true" } ] }, { "name": "MonitorService", "type": "object", "required": false, "description": "开启腾讯云可观测平台服务。若不指定该参数，则默认开启腾讯云可观测平台服务。", "example": "TRUE", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[腾讯云可观测平台](/document/product/248)服务。取值范围：TRUE：表示开启腾讯云可观测平台服务FALSE：表示不开启腾讯云可观测平台服务默认取值：TRUE。", "example": "true" } ] }, { "name": "AutomationService", "type": "object", "required": false, "description": "开启云自动化助手服务（TencentCloud Automation Tools，TAT）。若不指定该参数，默认开启云自动化助手服务。", "example": "TRUE", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启云自动化助手。取值范围：TRUE：表示开启云自动化助手服务FALSE：表示不开启云自动化助手服务默认取值：TRUE。", "example": "true" } ] } ] }, { "name": "LaunchTemplateIds", "type": "array", "required": false, "description": "扩容实例模板，可以在cvm侧进行设置", "example": "[\"lt-q2vxeiesdfl\", \"It-sadfasfsa\"]", "item_type": "string" } ] }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否只预检此次请求。true：发送检查请求，不会绑定弹性伸缩组。检查项包括是否填写了必需参数，请求格式，业务限制。如果检查不通过，则返回对应错误码；如果检查通过，则返回RequestId。false（默认）：发送正常请求，通过检查后直接绑定弹性伸缩组。", "example": "false" } ], "required": [ "ClusterId" ] }, { "name": "SubmitJob", "description": "本接口 (SubmitJob) 用于提交一个作业任务。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "集群id", "example": "hpc-cy4pnyp9" }, { "name": "Job", "type": "object", "required": true, "description": "作业任务参数配置", "example": "无", "children": [ { "name": "Tasks", "type": "array", "required": true, "description": "任务配置信息。", "example": "无", "item_type": "object", "children": [ { "name": "Application", "type": "object", "required": true, "description": "作业任务的应用环境配置信息。", "example": "无", "children": [ { "name": "Commands", "type": "array", "required": true, "description": "待执行脚本命令。", "example": "无", "item_type": "string" }, { "name": "StorageMounts", "type": "array", "required": false, "description": "存储目录挂载配置。", "example": "无", "item_type": "string" }, { "name": "EnvVars", "type": "array", "required": false, "description": "用户自定义环境变量。", "example": "无", "item_type": "string" }, { "name": "Docker", "type": "object", "required": false, "description": "容器配置信息。", "example": "无" }, { "name": "OutputRedirect", "type": "object", "required": false, "description": "无", "example": "无" }, { "name": "TaskType", "type": "string", "required": false, "description": "表示所选训练框架，支持可选参数 - PyTorch：表示提交PyTorch训练作业 - Custom：表示用户自定义作业 默认参数为：Custom", "example": "Custom" } ] }, { "name": "TaskName", "type": "string", "required": false, "description": "作业任务名称。", "example": "test-task" }, { "name": "TaskInstanceNum", "type": "integer", "required": false, "description": "作业任务所需的节点数/副本数。", "example": "1" }, { "name": "Timeout", "type": "integer", "required": false, "description": "任务超时时间(单位：秒)。", "example": "86400" } ] }, { "name": "JobName", "type": "string", "required": false, "description": "作业名称。", "example": "test-job" }, { "name": "JobDescription", "type": "string", "required": false, "description": "作业描述。", "example": "test job" }, { "name": "Priority", "type": "integer", "required": false, "description": "作业优先级，数值越大，优先级越高，数值范围1～100。", "example": "1" }, { "name": "TaskDependencies", "type": "array", "required": false, "description": "描述任务的依赖关系，DAG有向无环图。", "example": "无", "item_type": "object", "children": [ { "name": "StartTask", "type": "string", "required": true, "description": "依赖关系的起点任务名称。", "example": "task0" }, { "name": "EndTask", "type": "string", "required": true, "description": "依赖关系的终点任务名称。", "example": "task1" } ] } ] }, { "name": "QueueName", "type": "string", "required": false, "description": "队列名称。不指定则为默认队列： SLURM默认队列为：compute。 SGE默认队列为：all.q。", "example": "compute" } ], "required": [ "ClusterId", "Job" ] }, { "name": "TerminateJob", "description": "本接口 (TerminateJob) 用于终止一个作业任务。", "status": "online", "parameters": [ { "name": "JobId", "type": "string", "required": true, "description": "作业任务ID", "example": "job-xxx" } ], "required": [ "JobId" ] }, { "name": "TerminateWorkspaces", "description": "本接口 (TerminateWorkspaces) 用于主动退还工作空间。", "status": "online", "parameters": [ { "name": "SpaceIds", "type": "array", "required": true, "description": "工作空间ID", "example": "['wks-qk5u85i8']", "item_type": "string" }, { "name": "ReleasePrepaidDataDisks", "type": "boolean", "required": false, "description": "释放空间挂载的包年包月数据盘。true表示销毁空间同时释放包年包月数据盘，false表示只销毁空间。", "example": "true" } ], "required": [ "SpaceIds" ] } ] }