/** * 集群概览信息。 */ export interface ClusterOverview { /** * 集群ID。 */ ClusterId?: string; /** * 集群状态。取值范围:
集群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; } /** * 描述GooseFS挂载信息 */ export interface GooseFSOption { /** * 文件系统本地挂载路径。 */ LocalPath: string; /** * 文件系统远程挂载路径。 */ RemotePath: string; /** * 文件系统master的ip和端口。 */ Masters: Array集群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; } /** * DeleteClusterStorageOption请求参数结构体 */ export interface DeleteClusterStorageOptionRequest { /** * 集群ID。 */ ClusterId: string; /** * 本地挂载路径。 */ LocalPath: string; } /** * 描述了 “腾讯云可观测平台” 服务相关的信息。 */ export interface RunMonitorServiceEnabled { /** * 是否开启[腾讯云可观测平台](/document/product/248)服务。取值范围:集群活动历史记录列表。
*/ ClusterActivitySet?: Array集群活动历史记录数量。
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddNodes请求参数结构体 */ export interface AddNodesRequest { /** *集群中实例所在的位置。
*/ 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; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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; } /** * 描述节点执行脚本信息。 */ export interface NodeScript { /** * 节点执行脚本获取地址。 目前仅支持cos地址。地址最大长度:255。 */ ScriptPath: string; /** * 脚本执行超时时间(包含拉取脚本的时间)。单位秒,默认值:30。取值范围:10~1200。 */ Timeout?: number; } /** * ModifyInitNodeScripts返回参数结构体 */ export interface ModifyInitNodeScriptsResponse { /** * 唯一请求 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; } /** * 输出重定向配置 */ export interface OutputRedirect { /** * 输出driver类型 */ Driver?: string; /** * 重定向配置参数 */ Options?: Array集群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队列名称。
*/ 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 简介中的相关小节。
集群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; } /** * 作业概览信息 */ export interface JobView { /** * 作业ID */ JobId?: string; /** * 作业名称 */ JobName?: string; /** * 作业描述 */ JobDescription?: string; /** * 作业优先级 */ Priority?: number; /** * 作业状态,包括CREATED, QUEING, STARTNG, RUNING, TERMINATING, TERMINATED, SUCCESS, FAILED */ JobState?: string; /** * 作业所属集群ID */ ClusterId?: string; /** * 作业所属队列名称 */ QueueName?: string; /** * 完成作业任务所需资源 */ OccupyResources?: string; /** * 作业任务创建时间 */ CreateTime?: string; /** * 作业任务结束时间 */ EndTime?: 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; }