/** * 集群概览信息。 */ export interface ClusterOverview { /** * 集群ID。 */ ClusterId?: string; /** * 集群状态。取值范围:
工作空间 ID 列表。每次请求的工作空间计费模式必须一致。
*/ SpaceIds: Array转换的目标计费模式。当前仅支持 PREPAID(按量计费转包年包月)。
*/ SpaceChargeType: string; /** *是否只进行参数和资源预检。true:不发起询价、组单或正式下单;false:执行对应操作。默认为 false。
*/ DryRun?: boolean; /** *预付费参数。Period 和 RenewFlag 均为可选字段;未传入时后端使用默认值 Period=1、RenewFlag=NOTIFY_AND_MANUAL_RENEW。
*/ SpaceChargePrepaid?: SpaceChargePrepaid; } /** * 节点概览信息。 */ export interface NodeOverview { /** * 集群ID */ ClusterId?: string; /** * 节点实例ID。 注意:此字段可能返回 null,表示取不到有效值。 */ InstanceId?: string; /** * 节点所在可用区信息。 注意:此字段可能返回 null,表示取不到有效值。 */ Zone?: string; /** * 节点状态。代理是否已开通。true表示已开通,false表示从未开通。
*/ Enabled?: boolean; /** *终端节点ID。未开通代理时为空。
注意:此字段可能返回 null,表示取不到有效值。 */ EndPointId?: string; /** *终端节点VIP地址。未开通代理时为空。
注意:此字段可能返回 null,表示取不到有效值。 */ EndPointVip?: string; /** *终端节点是否就绪。true表示已就绪可用,false表示未就绪或未开通。
*/ EndPointReady?: boolean; /** *终端节点状态。取值范围:
上次同步的终端节点状态(DB记录值)。
注意:此字段可能返回 null,表示取不到有效值。 */ LastKnownStatus?: string; /** *终端节点服务ID。
注意:此字段可能返回 null,表示取不到有效值。 */ EndPointServiceId?: string; /** *私有网络ID。
注意:此字段可能返回 null,表示取不到有效值。 */ VpcId?: string; /** *子网ID。
注意:此字段可能返回 null,表示取不到有效值。 */ SubnetId?: string; /** *代理创建时间。未开通时为空。
注意:此字段可能返回 null,表示取不到有效值。 */ CreateTime?: string; /** *上次状态同步时间。cron未同步过时为null。
注意:此字段可能返回 null,表示取不到有效值。 */ LastSyncTime?: string; /** *本次实时查询时间。未开通时为空。
注意:此字段可能返回 null,表示取不到有效值。 */ RealtimeQueryTime?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateWorkspaces返回参数结构体 */ export interface CreateWorkspacesResponse { /** * 工作空间ID */ SpaceIdSet?: ArrayIDC集群ID,形如hpc-xxxxxxxx。
是否通过内网专线代理连接。
私有网络ID,形如vpc-xxx。仅当Proxy=true且集群未绑定VPC时必填。与SubnetId需同时指定或同时不指定。
私有网络子网ID,形如subnet-xxx。仅当Proxy=true且集群未绑定VPC时必填。与VpcId需同时指定或同时不指定。
注册码绑定的队列名称。不指定时由系统取集群默认队列。
*/ QueueName?: string; /** *注册码有效期,单位:秒。默认值为604800(7天)。
*/ ExpireSeconds?: number; } /** * 描述了工作空间VPC相关信息,包括子网,IP信息等 */ export interface SpaceVirtualPrivateCloud { /** * 私有网络ID */ VpcId: string; /** * 私有网络子网ID */ SubnetId: string; /** * 是否用作公网网关 */ AsVpcGateway?: boolean; /** * 私有网络子网 IP 数组 */ PrivateIpAddresses?: Array集群 ID。
*/ ClusterId: string; /** *GPU 厂商过滤条件。
*/ Vendor?: string; } /** * 管控节点概览。 */ export interface ManagerNodeOverview { /** * 管控节点ID。 */ NodeId?: string; } /** * DeleteCluster请求参数结构体 */ export interface DeleteClusterRequest { /** * 集群ID。 */ ClusterId: string; } /** * 描述了操作系统所在块设备即系统盘的信息 */ export interface SystemDisk { /** * 系统盘类型。系统盘类型限制详见存储概述。取值范围: CLOUD_BASIC:普通云硬盘 CLOUD_SSD:SSD云硬盘 CLOUD_PREMIUM:高性能云硬盘 默认取值:当前有库存的硬盘类型。 注意:此字段可能返回 null,表示取不到有效值。 */ DiskType?: string; /** * 系统盘大小,单位:GB。默认值为 50 注意:此字段可能返回 null,表示取不到有效值。 */ DiskSize?: number; } /** * 作业任务配置信息。 */ export interface Task { /** * 作业任务的应用环境配置信息。 */ Application: Application; /** * 作业任务名称。 */ TaskName?: string; /** * 作业任务所需的节点数/副本数。 */ TaskInstanceNum?: number; /** * 任务超时时间(单位:秒)。 */ Timeout?: number; } /** * GenerateRegisterCode请求参数结构体 */ export interface GenerateRegisterCodeRequest { /** *集群ID。
*/ ClusterId: string; /** *队列名称。
*/ QueueName?: string; /** *指定生成的注册码的过期时间, 单位为秒
取值范围:[1, 604800]
默认值:604800
*/ ExpireSeconds?: number; } /** * ModifyScheduledAction返回参数结构体 */ export interface ModifyScheduledActionResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInitNodeScripts请求参数结构体 */ export interface ModifyInitNodeScriptsRequest { /** * 集群ID。 */ ClusterId: string; /** * 节点初始化脚本信息列表。 */ InitNodeScripts?: Array集群id
*/ ClusterId: string; /** *节点的实例id列表
*/ ResourceSet: Array队列名称。不指定则为默认队列:
SLURM默认队列为:compute。
指定有效的镜像ID,格式形如img-xxx。目前仅支持公有镜像和特定自定义镜像。如不指定,则该字段是默认镜像。
*/ ImageId?: string; /** *要新增节点的资源类型。
提供给实例使用的用户数据,需要以 base64 方式编码,支持的最大数据大小为 16KB。关于获取此参数的详细介绍,请参阅Windows和Linux启动时运行命令。
*/ UserData?: string; /** *控制实例加入集群是否跳过重装系统
默认值:False
*/ SkipResetInstance?: boolean; } /** * 描述了工作空间的计费模式 */ export interface SpaceChargePrepaid { /** * 购买实例的时长,单位:月。取值范围:1, 2, 3, 12, 24, 36。默认取值为1。 注意:此字段可能返回 null,表示取不到有效值。 */ Period?: number; /** * 自动续费标识。取值范围: NOTIFY_AND_AUTO_RENEW:通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费 默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。 注意:此字段可能返回 null,表示取不到有效值。 */ RenewFlag?: string; } /** * DescribeWorkspaces返回参数结构体 */ export interface DescribeWorkspacesResponse { /** *集群概览信息列表
*/ SpaceSet?: Array集群数量
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 标签键值对。 */ export interface Tag { /** * 标签键 */ Key: string; /** * 标签值 */ Value: string; } /** * DescribeNodes返回参数结构体 */ export interface DescribeNodesResponse { /** * 节点概览信息列表。 */ NodeSet?: Array定时伸缩任务 ID。
*/ ScheduledActionId: string; /** *定时伸缩任务名称。
*/ ScheduledActionName?: string; /** *定时触发后队列期望节点数。
*/ DesiredCapacity?: number; /** *任务状态。
*/ Status?: string; } /** * DescribeJobsOverview请求参数结构体 */ export interface DescribeJobsOverviewRequest { /** *集群ID
*/ ClusterId: string; } /** * BindClusterVpc返回参数结构体 */ export interface BindClusterVpcResponse { /** *集群ID。
*/ ClusterId?: string; /** *绑定的私有网络ID。
*/ VpcId?: string; /** *绑定的子网ID。
*/ SubnetId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteCluster返回参数结构体 */ export interface DeleteClusterResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAutoScalingConfiguration返回参数结构体 */ export interface DescribeAutoScalingConfigurationResponse { /** *集群ID。
*/ ClusterId?: string; /** *任务连续等待时间,队列的任务处于连续等待的时间。单位秒。
*/ ExpansionBusyTime?: number; /** *节点连续空闲(未运行作业)时间,一个节点连续处于空闲状态时间。
*/ ShrinkIdleTime?: number; /** *扩容队列配置概览列表。
*/ QueueConfigs?: Array按照【集群类型】进行过滤
类型:String
必选:否
每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。
*/ Filters?: Array集群ID列表。通过该参数可以指定需要查询信息的集群列表。
如果您不指定该参数,则返回Limit数量以内的集群信息。
偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
按照【可用区】进行过滤
类型:String
必选:否
按照【工作空间实例ID】进行过滤
类型:String
必选:否
按照【CVM实例ID】进行过滤
类型:String
必选:否
按照【工作空间状态】进行过滤
类型:String
必选:否
按照【工作空间别名】进行过滤
类型:String
必选:否
按照【工作空间实例付费模式】进行过滤
类型:String
必选:否
按照【标签键】进行过滤
类型:String
必选:否
按照【标签值】进行过滤
类型:String
必选:否
每次请求的Filters的上限为10,Filter.Values的上限为5。
节点ID,节点ID通过调用接口 DescribeNodes获取。
*/ NodeId: string; /** *节点别名
*/ NodeName?: string; /** *资源的分配状态: - IDLE: 资源空闲 - ISOLATE: 资源隔离
*/ NodeAllocateState?: string; /** *目标队列名
*/ QueueName?: string; } /** * AddQueue请求参数结构体 */ export interface AddQueueRequest { /** * 集群ID。 */ ClusterId: string; /** * 队列名称。扩容方式。可选值:LAUNCH_TEMPLATE(启动模板)、MULTI_CARD(多卡型混扩)。
*/ ExpansionMode?: string; /** *启动模板 ID 列表,最多 10 个。ExpansionMode=LAUNCH_TEMPLATE 时使用。
注意:此字段可能返回 null,表示取不到有效值。 */ LaunchTemplateIds?: Array参考实例 ID,根据已有实例配置生成启动模板。
注意:此字段可能返回 null,表示取不到有效值。 */ ReferenceInstanceId?: string; /** *启动模板扩容覆盖配置。ExpansionMode=MULTI_CARD 时使用。
注意:此字段可能返回 null,表示取不到有效值。 */ TemplateOverrides?: TemplateOverrides; /** *候选规格排序策略。
注意:此字段可能返回 null,表示取不到有效值。 */ ExpansionPriority?: ExpansionPriority; } /** * DeleteScheduledAction请求参数结构体 */ export interface DeleteScheduledActionRequest { /** *定时伸缩任务 ID 列表,最多 20 个。
*/ ScheduledActionIds: Array期望节点数。
注意:此字段可能返回 null,表示取不到有效值。 */ DesiredCapacity?: number; /** *伸缩单位。可选值:NODE(按节点)、GPU_CARD(按 GPU 卡)。
注意:此字段可能返回 null,表示取不到有效值。 */ ScalingUnit?: string; } /** * DescribeQueues返回参数结构体 */ export interface DescribeQueuesResponse { /** * 队列概览信息列表。 */ QueueSet?: Array文件系统本地挂载路径。
*/ LocalPath: string; /** *文件系统远程挂载路径; 远端路径为GooseFS控制台看到的命名空间的url;命名空间文档参考https://cloud.tencent.com/document/product/1424/117877
*/ RemotePath: string; /** *文件系统master的ip和端口,此参数和FileSystemId互斥。
*/ Masters?: ArrayGooseFS的文件ID;此参数和Masters 互斥。
*/ FileSystemId?: string; } /** * GooseFS存储选项概览信息。 */ export interface GooseFSOptionOverview { /** * 文件系统本地挂载路径。 */ LocalPath?: string; /** * 文件系统远程挂载路径。 */ RemotePath?: string; /** * 文件系统master的ip和端口。 */ Masters?: Array集群ID。
*/ ClusterId: string; } /** * 描述了工作空间的公网可访问性,声明了工作空间的公网使用计费模式,最大带宽等 */ export interface SpaceInternetAccessible { /** * 网络计费类型 注意:此字段可能返回 null,表示取不到有效值。 */ InternetChargeType?: string; /** * 公网出带宽上限,默认为0 注意:此字段可能返回 null,表示取不到有效值。 */ InternetMaxBandwidthOut?: number; /** * 是否分配公网IP 注意:此字段可能返回 null,表示取不到有效值。 */ PublicIpAssigned?: boolean; /** * 带宽包ID 注意:此字段可能返回 null,表示取不到有效值。 */ BandwidthPackageId?: string; } /** * COS挂载信息 */ export interface CosOption { /** *文件系统本地挂载路径。
*/ LocalPath: string; /** *COS桶地址,可以在COS桶详情页查看。
*/ RemotePath: string; /** *cosfs2挂载工具支持的参数。
*/ MountParamsOption?: string; } /** * DescribeQueueAutoScaling返回参数结构体 */ export interface DescribeQueueAutoScalingResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SetAutoScalingConfiguration返回参数结构体 */ export interface SetAutoScalingConfigurationResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteClusterStorageOption请求参数结构体 */ export interface DeleteClusterStorageOptionRequest { /** * 集群ID。 */ ClusterId: string; /** * 本地挂载路径。 */ LocalPath: string; } /** * ModifyClusterDeletionProtection请求参数结构体 */ export interface ModifyClusterDeletionProtectionRequest { /** * 集群ID。 */ ClusterId: string; /** * 集群删除保护开关。 可选值:集群挂载CFS文件系统选项。
*/ CFSOptions?: Array集群挂载GooseFS文件系统选项。
*/ GooseFSOptions?: Array集群挂载GooseFSx文件系统选项。
*/ GooseFSxOptions?: Array集群挂载COS文件系统选项。
*/ CosOptions?: Array候选规格排序方式。可选值:LARGE_FIRST(大规格优先)、SMALL_FIRST(小规格优先)。
注意:此字段可能返回 null,表示取不到有效值。 */ InstanceSpecPriority?: string; } /** * DescribeClusters返回参数结构体 */ export interface DescribeClustersResponse { /** * 集群概览信息列表。 */ ClusterSet?: Array集群活动历史记录列表。
*/ ClusterActivitySet?: Array集群活动历史记录数量。
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInitNodeScripts返回参数结构体 */ export interface DescribeInitNodeScriptsResponse { /** * 节点初始化脚本列表。 */ InitNodeScriptSet?: Array集群ID。
*/ ClusterId: string; /** *私有网络ID,形如vpc-xxx。可通过调用DescribeVpcs获取。
私有网络子网ID,形如subnet-xxx。可通过调用DescribeSubnets获取。
集群 ID。
*/ ClusterId: string; /** *队列名称。
*/ QueueName: string; /** *定时伸缩任务名称。
*/ ScheduledActionName: string; /** *定时伸缩任务生效起始时间,格式:YYYY-MM-DD HH:MM:SS。
*/ StartTime: string; /** *定时触发后队列期望节点数。
*/ DesiredCapacity: number; /** *定时伸缩任务生效结束时间,格式:YYYY-MM-DD HH:MM:SS。不传则永久有效。
*/ EndTime?: string; /** *重复策略,遵循 cron 表达式格式。不传则只执行一次。
*/ Recurrence?: string; } /** * 描述了实例的增强服务启用情况与其设置,如云安全,腾讯云可观测平台等实例 Agent */ export interface EnhancedService { /** * 开启云安全服务。若不指定该参数,则默认开启云安全服务。 */ SecurityService?: RunSecurityServiceEnabled; /** * 开启腾讯云可观测平台服务。若不指定该参数,则默认开启腾讯云可观测平台服务。 */ MonitorService?: RunMonitorServiceEnabled; /** * 开启云自动化助手服务(TencentCloud Automation Tools,TAT)。若不指定该参数,默认开启云自动化助手服务。 */ AutomationService?: RunAutomationServiceEnabled; } /** * 描述了 “云自动化助手” 服务相关的信息。 */ export interface RunAutomationServiceEnabled { /** * 是否开启云自动化助手。取值范围:集群ID。
*/ ClusterId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeScheduledActions请求参数结构体 */ export interface DescribeScheduledActionsRequest { /** *集群 ID。
*/ ClusterId: string; /** *队列名称。
*/ QueueName?: string; /** *定时伸缩任务 ID 列表。
*/ ScheduledActionIds?: Array任务状态过滤条件。
*/ Status?: string; } /** * 描述了 “云安全” 服务相关的信息。 */ export interface RunSecurityServiceEnabled { /** * 是否开启[云安全](/document/product/296)服务。取值范围:集群中实例所在的位置。
*/ Placement?: Placement; /** *指定管理节点。
*/ ManagerNode?: ManagerNode; /** *指定管理节点的数量。默认取值:1。取值范围:1~2。
*/ ManagerNodeCount?: number; /** *指定计算节点。
*/ ComputeNode?: ComputeNode; /** *指定计算节点的数量。默认取值:0。
*/ ComputeNodeCount?: number; /** *调度器类型。默认取值:SLURM。
创建调度器的版本号,可填写版本号为“latest” 和 各调度器支持的版本号;如果是"latest", 则代表创建的是平台当前支持的该类型调度器最新版本。如果不填写,默认创建的是“latest”版本调度器
各调度器支持的集群版本:
指定有效的镜像ID,格式形如img-xxx。目前支持部分公有镜像和自定义镜像。公共镜像请参考镜像限制
私有网络相关信息配置。
*/ VirtualPrivateCloud?: VirtualPrivateCloud; /** *集群登录设置。
*/ LoginSettings?: LoginSettings; /** *集群中实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。
*/ SecurityGroupIds?: Array用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
*/ ClientToken?: string; /** *是否只预检此次请求。
true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和云服务器库存。
如果检查不通过,则返回对应错误码;
如果检查通过,则返回RequestId.
false(默认):发送正常请求,通过检查后直接创建实例
域名字服务类型。默认取值:NIS。
集群显示名称。
*/ ClusterName?: string; /** *集群存储选项
*/ StorageOption?: StorageOption; /** *指定登录节点。
*/ LoginNode?: LoginNode; /** *指定登录节点的数量。默认取值:0。取值范围:0~10。
*/ LoginNodeCount?: number; /** *创建集群时同时绑定的标签对说明。
*/ Tags?: Array弹性伸缩类型。默认值:THPC_AS
*/ AutoScalingType?: string; /** *节点初始化脚本信息列表。
*/ InitNodeScripts?: Array高性能计算集群ID。若创建的实例为高性能计算实例,需指定实例放置的集群,否则不可指定。
*/ HpcClusterId?: string; } /** * AddQueue返回参数结构体 */ export interface AddQueueResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeClusterStorageOption返回参数结构体 */ export interface DescribeClusterStorageOptionResponse { /** * 集群存储选项信息概览。 */ StorageOption?: StorageOptionOverview; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateScheduledAction返回参数结构体 */ export interface CreateScheduledActionResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 集群存储选项概览信息。 */ export interface StorageOptionOverview { /** *CFS存储选项概览信息列表。
*/ CFSOptions?: ArrayGooseFS存储选项概览信息列表。
*/ GooseFSOptions?: ArrayGooseFSx存储选项概览信息列表。
*/ GooseFSxOptions?: ArrayCOS存储选项概览信息列表。
*/ CosOptions?: Array集群队列的注册码,用于机器注册进入队列时使用
默认值:无
*/ RegisterCode?: string; /** *注册码的过期时间, unix时间戳格式
*/ ExpireAt?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 任务执行命令脚本。 */ export interface CommandItem { /** * 脚本命令 */ Command: string; } /** * 管控节点信息 */ export interface ManagerNode { /** *节点计费类型。
枚举值:预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。
*/ InstanceChargePrepaid?: InstanceChargePrepaid; /** *节点机型。不同实例机型指定了不同的资源规格。
节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
*/ SystemDisk?: SystemDisk; /** *节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
*/ DataDisks?: Array公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
*/ InternetAccessible?: InternetAccessible; /** *节点显示名称。
{R:x},表示生成数字[[x, x+n-1],其中n表示购买节点的数量,例如server_{R:3},购买1个时,节点显示名称为server_3;购买2个时,节点显示名称分别为server_3,server_4。支持指定多个模式串{R:x}。 购买多个节点,如果不指定模式串,则在节点显示名称添加后缀1、2...n,其中n表示购买节点的数量,例如server_,购买2个时,节点显示名称分别为server_1,server_2。实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。
*/ ProjectId?: number; /** *增强服务。通过该参数可以指定是否开启云安全、腾讯云可观测平台等服务。若不指定该参数,则默认开启腾讯云可观测平台、云安全服务、自动化助手服务。
*/ EnhancedService?: EnhancedService; } /** * DescribeJobSubmitInfo请求参数结构体 */ export interface DescribeJobSubmitInfoRequest { /** * 作业ID */ JobId: string; } /** * EnableClusterDedicatedProxy请求参数结构体 */ export interface EnableClusterDedicatedProxyRequest { /** *集群ID。
*/ ClusterId: string; /** *私有网络ID,形如vpc-xxx。可通过调用DescribeVpcs获取。若不指定,则使用集群已绑定的VPC。
私有网络子网ID,形如subnet-xxx。可通过调用DescribeSubnets获取。与VpcId需同时指定或同时不指定。
输出driver类型
枚举值:
默认值:local
*/ Driver?: string; /** *重定向配置参数
日志重定向路径,用于指定任务日志的输出目标。取值格式与 Driver 类型关联:
当 Driver 为 local 时,格式为本地文件路径,如 stdout=/tmp/train_out.log;
当 Driver 为 cos 时,格式为 COS 存储桶路径,如 stdout=cos://test-123456.cos.ap-shanghai.myqcloud.com/test/.
工作空间 ID 列表。每次请求的工作空间计费模式必须一致。
*/ SpaceIds: Array转换的目标计费模式。当前仅支持 PREPAID(按量计费转包年包月)。
*/ SpaceChargeType: string; /** *是否只进行参数和资源预检。true:不发起询价、组单或正式下单;false:执行对应操作。默认为 false。
*/ DryRun?: boolean; /** *预付费参数。Period 和 RenewFlag 均为可选字段;未传入时后端使用默认值 Period=1、RenewFlag=NOTIFY_AND_MANUAL_RENEW。
*/ SpaceChargePrepaid?: SpaceChargePrepaid; } /** * 任务的应用环境配置信息。 */ export interface Application { /** * 待执行脚本命令。 */ Commands: Array工作空间ID
*/ SpaceId?: string; /** *工作空间类别
*/ SpaceClass?: string; /** *工作空间类型
*/ SpaceFamily?: string; /** *工作空间规格
*/ SpaceType?: string; /** *工作空间名称
*/ SpaceName?: string; /** *工作空间状态。取值范围:
工作空间计费模式
*/ SpaceChargeType?: string; /** *工作空间对应资源ID
*/ ResourceId?: string; /** *自动续费标识
*/ RenewFlag?: string; /** *工作空间关联的工作列表
*/ Tags?: Array创建时间
*/ CreatedTime?: string; /** *到期时间
*/ ExpiredTime?: string; /** *工作空间所在位置
*/ Placement?: Placement; /** *工作空间的最新操作
注意:此字段可能返回 null,表示取不到有效值。 */ LatestOperation?: string; /** *工作空间的最新操作状态
注意:此字段可能返回 null,表示取不到有效值。 */ LatestOperationState?: string; /** *实例的内网IP
*/ PrivateIpAddresses?: Array渲染好的节点注册命令,可直接在IDC机器上以root身份执行。
*/ RegisterCommand?: string; /** *节点注册码。作为不透明凭证使用,请妥善保管,仅在节点注册纳管时传入。
*/ RegisterCode?: string; /** *注册码到期的Unix时间戳,单位:秒。
*/ ExpireAt?: number; /** *回显本次是否走内网专线代理。
*/ Proxy?: boolean; /** *代理终端节点VIP地址。当Proxy=true且终端节点就绪时非空。
终端节点状态。取值范围:
回显集群ID。
*/ ClusterId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 计算节点信息。 */ export interface ComputeNode { /** * 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。集群ID。
*/ ClusterId: string; } /** * EnableClusterDedicatedProxy返回参数结构体 */ export interface EnableClusterDedicatedProxyResponse { /** *终端节点ID。
*/ EndPointId?: string; /** *终端节点VIP地址。
*/ EndPointVip?: string; /** *终端节点是否就绪。true表示已就绪,false表示未就绪。
*/ EndPointReady?: boolean; /** *终端节点状态。取值范围:
私有网络ID。
*/ VpcId?: string; /** *子网ID。
*/ SubnetId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GooseFSx存储选项概览信息。 */ export interface GooseFSxOptionOverview { /** * 文件系统master的ip和端口列表。 */ Masters?: Array文件系统本地挂载路径。
*/ LocalPath?: string; /** *COS桶地址。
*/ RemotePath?: string; /** *COS挂载参数
*/ MountOption?: string; } /** * SetAutoScalingConfiguration请求参数结构体 */ export interface SetAutoScalingConfigurationRequest { /** *集群ID。
*/ ClusterId: string; /** *任务连续等待时间,队列的任务处于连续等待的时间。单位秒。默认值120。
*/ ExpansionBusyTime?: number; /** *节点连续空闲(未运行作业)时间,一个节点连续处于空闲状态时间。单位秒。默认值300。
*/ ShrinkIdleTime?: number; /** *扩容队列配置列表。
*/ QueueConfigs?: Array是否只预检此次请求。
true:发送检查请求,不会绑定弹性伸缩组。检查项包括是否填写了必需参数,请求格式,业务限制。
如果检查不通过,则返回对应错误码;
如果检查通过,则返回RequestId。
false(默认):发送正常请求,通过检查后直接绑定弹性伸缩组。
按照【队列名称】进行过滤。队列名称形如:compute。
类型:String
必选:否
按照【节点角色】进行过滤。节点角色形如:Manager。(Manager:管控节点。Compute:计算节点。Login:登录节点。ManagerBackup:备用管控节点。)
类型:String
必选:否
按照【节点类型】进行过滤。节点类型形如:STATIC。(STATIC:静态节点。DYNAMIC:弹性节点。)
类型:String
必选:否
按照【CVM实例资源ID】进行过滤。资源ID名称形如:ins-xxx。
类型:String
必选:否
每次请求的`Filters`的上限为10,`Filter.Values`的上限为100。
*/ Filters?: Array集群id
*/ ClusterId: string; /** *集群中的节点id
*/ NodeIds: Array作业任务数量
*/ JobTotal?: number; /** *排队中的作业任务数量
*/ QueuingJobTotal?: number; /** *运行中的作业数量
*/ RunningJobTotal?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述CFS文件系统版本和挂载信息 */ export interface CFSOption { /** * 文件系统本地挂载路径。 */ LocalPath: string; /** * 文件系统远程挂载ip及路径。 */ RemotePath?: string; /** * 文件系统协议类型。候选机型族列表,最多 10 个。MULTI_CARD 模式的明确标志字段。
注意:此字段可能返回 null,表示取不到有效值。 */ InstanceFamilies?: Array每节点 GPU 卡数。
注意:此字段可能返回 null,表示取不到有效值。 */ GpuCountPerNode?: number; /** *是否启用混合 GPU 卡数折算,默认 false。未传时保持已持久化的混卡开关。
注意:此字段可能返回 null,表示取不到有效值。 */ EnableMixedGpuCount?: boolean; /** *是否启用多可用区扩容。未传时保持已持久化的分区策略,局部更新不得覆盖。
注意:此字段可能返回 null,表示取不到有效值。 */ EnableMultiZone?: boolean; } /** * DescribeQueueAutoScalingOverview返回参数结构体 */ export interface DescribeQueueAutoScalingOverviewResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 工作空间系统盘配置 */ export interface SpaceSystemDisk { /** * 系统盘类型。系统盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围:队列名称。
*/ QueueName: string; /** *队列中弹性节点数量最小值。默认值:0。取值范围:0~200。
*/ MinSize?: number; /** *队列中弹性节点数量最大值。默认值:10。取值范围:0~200。
*/ MaxSize?: number; /** *是否开启自动扩容。
*/ EnableAutoExpansion?: boolean; /** *是否开启自动缩容。
*/ EnableAutoShrink?: boolean; /** *指定有效的镜像ID,格式形如img-xxx。目前仅支持公有镜和特定自定义镜像。
节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
*/ SystemDisk?: SystemDisk; /** *节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
*/ DataDisks?: Array公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
*/ InternetAccessible?: InternetAccessible; /** *扩容节点配置信息。
*/ ExpansionNodeConfigs?: Array队列中期望的空闲节点数量(包含弹性节点和静态节点)。默认值:0。队列中,处于空闲状态的节点小于此值,集群会扩容弹性节点;处于空闲状态的节点大于此值,集群会缩容弹性节点。
*/ DesiredIdleNodeCapacity?: number; /** *队列中期望的总节点数。
*/ DesiredNodeCount?: number; /** *扩容比例。默认值:100。取值范围:1~100。
如果扩容比例为50,那么每轮只会扩容当前作业负载所需的50%数量的节点。
比例扩容阈值。默认值:0。取值范围:0~200。
当作业负载需要扩容节点数量大于此值,当前扩容轮次按照ScaleOutRatio配置的比例进行扩容。当作业负载需要扩容节点数量小于此值,当前扩容轮次扩容当前作业负载所需数量的节点。
此参数配合ScaleOutRatio参数进行使用,用于比例扩容场景下,在作业负载所需节点数量较小时,加快收敛速度。
每轮扩容最大节点个数。默认值:100。取值范围:1~100。
*/ MaxNodesPerCycle?: number; /** *扩容过程中,作业的内存在匹配实例机型时增大比例(不会影响作业提交的内存大小,只影响匹配计算过程)。
针对场景:由于实例机型的总内存会大于实例内部的可用内存,16GB内存规格的实例,实例操作系统内的可用内存只有约14.9GB内存。假设此时提交一个需要15GB内存的作业,
增强服务。通过该参数可以指定是否开启云安全、腾讯云可观测平台等服务。若不指定该参数,则默认开启腾讯云可观测平台、云安全服务、自动化助手服务。
*/ EnhancedService?: EnhancedService; /** *扩容实例模板,可以在cvm侧进行设置
*/ LaunchTemplateIds?: Array集群ID。通过该参数指定需要查询活动历史记录的集群。
*/ ClusterId: string; /** *偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
按照【队列名称】进行过滤。队列名称形如:compute。
类型:String
必选:否
每次请求的Filters的上限为10,Filter.Values的上限为5。
集群中实例所在的位置。
*/ Placement: Placement; /** *集群ID。
*/ ClusterId: string; /** *私有网络相关信息配置。
*/ VirtualPrivateCloud: VirtualPrivateCloud; /** *添加节点数量。
*/ Count: number; /** *指定有效的镜像ID,格式形如img-xxx。目前支持部分公有镜像和自定义镜像。公共镜像请参考镜像限制
节点计费类型。
预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。
*/ InstanceChargePrepaid?: InstanceChargePrepaid; /** *节点机型。不同实例机型指定了不同的资源规格。
节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
*/ SystemDisk?: SystemDisk; /** *节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
*/ DataDisks?: Array公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
*/ InternetAccessible?: InternetAccessible; /** *节点显示名称。
不指定节点显示名称则默认显示‘未命名’。
最多支持60个字符。
集群登录设置。
*/ LoginSettings?: LoginSettings; /** *集群中实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。
*/ SecurityGroupIds?: Array用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
*/ ClientToken?: string; /** *队列名称。不指定则为默认队列。
添加节点角色。默认值:Compute
是否只预检此次请求。
true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和云服务器库存。
如果检查不通过,则返回对应错误码;
如果检查通过,则返回RequestId.
false(默认):发送正常请求,通过检查后直接创建实例
添加节点类型。默认取值:STATIC。
实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。
*/ ProjectId?: number; /** *要新增节点的资源类型。
集群ID。
*/ ClusterId: string; /** *队列名称
*/ QueueName?: string; } /** * 存储目录挂载配置。 */ export interface StorageMount { /** * 挂载源 */ Source: string; /** * 目标挂载位置 */ Target: string; /** * 挂载的存储类型,目前仅支持:local */ StorageType?: string; } /** * 描述了实例的公网可访问性,声明了实例的公网使用计费模式,最大带宽等 */ export interface InternetAccessible { /** * 网络计费类型。取值范围: BANDWIDTH_PREPAID:预付费按带宽结算 TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费 BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费 BANDWIDTH_PACKAGE:带宽包用户 默认取值:非带宽包用户默认与子机付费类型保持一致。 注意:此字段可能返回 null,表示取不到有效值。 */ InternetChargeType?: string; /** * 公网出带宽上限,单位:Mbps。默认值:0Mbps。不同机型带宽上限范围不一致,具体限制详见购买网络带宽。 注意:此字段可能返回 null,表示取不到有效值。 */ InternetMaxBandwidthOut?: number; } /** * SetQueueAutoScaling请求参数结构体 */ export interface SetQueueAutoScalingRequest { /** * 集群 ID。 */ ClusterId: string; /** * 队列名称。 */ QueueName: string; /** *伸缩容量策略,用于设置目标容量及容量单位。单独传入时仅更新容量相关配置,未传字段保持原值。
*/ ScalingPolicy?: ScalingPolicy; /** *扩容策略,用于配置启动模板、机型族、GPU 卡数、规格优先级和多可用区等扩容方式。单独传入时仅更新扩容相关配置,未传字段保持原值。
*/ ExpansionPolicy?: ExpansionPolicy; } /** * 作业概览信息 */ export interface JobView { /** *作业ID
*/ JobId?: string; /** *作业名称
*/ JobName?: string; /** *作业描述
*/ JobDescription?: string; /** *作业创建者
*/ Creator?: string; /** *作业优先级
*/ Priority?: number; /** *作业状态,包括CREATED, QUEING, STARTNG, RUNING, TERMINATING, TERMINATED, SUCCESS,
FAILED
作业所属集群ID
*/ ClusterId?: string; /** *作业所属队列名称
*/ QueueName?: string; /** *完成作业任务所需资源
*/ OccupyResources?: string; /** *作业任务创建时间
*/ CreateTime?: string; /** *作业任务结束时间
*/ EndTime?: string; } /** * InquirePriceModifyWorkspacesChargeType返回参数结构体 */ export interface InquirePriceModifyWorkspacesChargeTypeResponse { /** *该参数表示对应规格工作空间的价格
*/ Price?: Price; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 用户自定义环境变量。 */ export interface EnvVar { /** * ENV */ Name: string; /** * test */ Value: string; } /** * 描述了实例的计费模式 */ export interface InstanceChargePrepaid { /** * 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。 注意:此字段可能返回 null,表示取不到有效值。 */ Period: number; /** * 自动续费标识。取值范围: NOTIFY_AND_AUTO_RENEW:通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费 默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。 注意:此字段可能返回 null,表示取不到有效值。 */ RenewFlag?: string; } /** * 描述了单项的价格信息。 */ export interface ItemPrice { /** * 预支合计费用的原价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 */ OriginalPrice?: number; /** * 预支合计费用的折扣价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 */ DiscountPrice?: number; /** * 折扣,如20.0代表2折。 注意:此字段可能返回 null,表示取不到有效值。 */ Discount?: number; /** * 后续合计费用的原价,后付费模式使用,单位:元。 如返回了其他时间区间项,如UnitPriceSecondStep,则本项代表时间区间在(0, 96)小时;若未返回其他时间区间项,则本项代表全时段,即(0, ∞)小时 注意:此字段可能返回 null,表示取不到有效值。 */ UnitPrice?: number; /** * 后续合计费用的折扣价,后付费模式使用,单位:元 如返回了其他时间区间项,如DiscountUnitPriceSecondStep,则本项代表时间区间在(0, 96)小时;若未返回其他时间区间项,则本项代表全时段,即(0, ∞)小时 注意:此字段可能返回 null,表示取不到有效值。 */ DiscountUnitPrice?: number; /** * 后续计价单元,后付费模式使用,可取值范围: HOUR:表示计价单元是按每小时来计算。当前涉及该计价单元的场景有:实例按小时后付费(POSTPAID_BY_HOUR)、带宽按小时后付费(BANDWIDTH_POSTPAID_BY_HOUR): GB:表示计价单元是按每GB来计算。当前涉及该计价单元的场景有:流量按小时后付费(TRAFFIC_POSTPAID_BY_HOUR)。 注意:此字段可能返回 null,表示取不到有效值。 */ ChargeUnit?: string; /** * 后续合计费用的折扣价,后付费模式使用,单位:元 如返回了其他时间区间项,如UnitPriceDiscount float,则本项代表时间区间在(0, 96)小时;若未返回其他时间区间项,则本项代表全时段,即(0, ∞)小时 */ UnitPriceDiscount?: number; }