tencentcloud-sdk-nodejs

/** * 集群概览信息。 */ export interface ClusterOverview { /** * 集群ID。 */ ClusterId?: string; /** * 集群状态。取值范围：<li>PENDING：创建中</li><li>INITING：初始化中</li><li>INIT_FAILED：初始化失败</li><li>RUNNING：运行中</li><li>TERMINATING：销毁中</li> */ ClusterStatus?: string; /** * 集群名称。 */ ClusterName?: string; /** * 集群位置信息。 */ Placement?: Placement; /** * 集群创建时间。 */ CreateTime?: string; /** * 集群调度器。 */ SchedulerType?: string; /** * 集群调度器版本。 */ SchedulerVersion?: string; /** * 计算节点数量。 */ ComputeNodeCount?: number; /** * 计算节点概览。 */ ComputeNodeSet?: Array<ComputeNodeOverview>; /** * 管控节点数量。 */ ManagerNodeCount?: number; /** * 管控节点概览。 */ ManagerNodeSet?: Array<ManagerNodeOverview>; /** * 登录节点概览。 */ LoginNodeSet?: Array<LoginNodeOverview>; /** * 登录节点数量。 */ LoginNodeCount?: number; /** * 弹性伸缩类型。 */ AutoScalingType?: string; /** * 集群所属私有网络ID。 */ VpcId?: string; /** * 集群类型 */ ClusterType?: string; /** * 集群销毁保护开关状态，当前支持参数： - ON: 集群销毁保护打开 - OFF: 集群销毁保护关闭 */ DeletionProtection?: string; } /** * ModifyNodeAttribute返回参数结构体 */ export interface ModifyNodeAttributeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 节点概览信息。 */ export interface NodeOverview { /** * 集群ID */ ClusterId?: string; /** * 节点实例ID。注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId?: string; /** * 节点所在可用区信息。注意：此字段可能返回 null，表示取不到有效值。 */ Zone?: string; /** * 节点状态。<li>SUBMITTED：已完成提交。</li><li>CREATING：创建中。</li><li>CREATED：完成创建。</li><li>INITING：初始化中。</li><li>INIT_FAILED：初始化失败。</li><li>RUNNING：运行中。</li><li>DELETING：销毁中。</li> 注意：此字段可能返回 null，表示取不到有效值。 */ NodeState?: string; /** * 镜像ID。注意：此字段可能返回 null，表示取不到有效值。 */ ImageId?: string; /** * 节点所属队列名称。注意：此字段可能返回 null，表示取不到有效值。 */ QueueName?: string; /** * 节点角色。<li>Manager：管控节点。</li><li>Compute：计算节点。</li><li>Login：登录节点。</li><li>ManagerBackup：备用管控节点。</li> 注意：此字段可能返回 null，表示取不到有效值。 */ NodeRole?: string; /** * 节点类型。<li>STATIC：静态节点。</li><li>DYNAMIC：弹性节点。</li> 注意：此字段可能返回 null，表示取不到有效值。 */ NodeType?: string; /** * thpc集群节点id 注意：此字段可能返回 null，表示取不到有效值。 */ NodeId?: string; /** * 节点的工作状态 */ NodeAllocateState?: string; /** * 节点的名称 */ NodeName?: string; /** * 节点的创建时间 */ CreateTime?: string; } /** * DescribeInitNodeScripts请求参数结构体 */ export interface DescribeInitNodeScriptsRequest { /** * 集群ID。 */ ClusterId: string; } /** * AddNodes返回参数结构体 */ export interface AddNodesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 弹性扩容节点配置信息。 */ export interface ExpansionNodeConfig { /** * 扩容实例所在的位置。 */ Placement: Placement; /** * 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。 <li>PREPAID：预付费，即包年包月</li> <li>POSTPAID_BY_HOUR：按小时后付费</li> <li>SPOTPAID：竞价付费 默认值：POSTPAID_BY_HOUR。</li> */ InstanceChargeType?: string; /** * 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid; /** * 节点机型。不同实例机型指定了不同的资源规格。 <li>具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。</li> */ InstanceType?: string; /** * 私有网络相关信息配置。 */ VirtualPrivateCloud?: VirtualPrivateCloud; /** * 实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。 */ ProjectId?: number; } /** * 节点活动信息。 */ export interface NodeActivity { /** * 节点活动所在的实例ID。注意：此字段可能返回 null，表示取不到有效值。 */ NodeInstanceId?: string; /** * 节点活动状态。取值范围： <li>RUNNING：运行中</li> <li>SUCCESSFUL：活动成功</li> <li>FAILED：活动失败</li> */ NodeActivityStatus?: string; /** * 节点活动状态码。注意：此字段可能返回 null，表示取不到有效值。 */ NodeActivityStatusCode?: string; /** * 节点活动状态原因。注意：此字段可能返回 null，表示取不到有效值。 */ NodeActivityStatusReason?: string; } /** * ModifyClusterDeletionProtection返回参数结构体 */ export interface ModifyClusterDeletionProtectionResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateWorkspaces返回参数结构体 */ export interface CreateWorkspacesResponse { /** * 工作空间ID */ SpaceIdSet?: Array<string>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述了工作空间VPC相关信息，包括子网，IP信息等 */ export interface SpaceVirtualPrivateCloud { /** * 私有网络ID */ VpcId: string; /** * 私有网络子网ID */ SubnetId: string; /** * 是否用作公网网关 */ AsVpcGateway?: boolean; /** * 私有网络子网 IP 数组 */ PrivateIpAddresses?: Array<string>; /** * 为弹性网卡指定随机生成 */ Ipv6AddressCount?: number; } /** * 管控节点概览。 */ 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; } /** * TerminateWorkspaces返回参数结构体 */ export interface TerminateWorkspacesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInitNodeScripts请求参数结构体 */ export interface ModifyInitNodeScriptsRequest { /** * 集群ID。 */ ClusterId: string; /** * 节点初始化脚本信息列表。 */ InitNodeScripts?: Array<NodeScript>; } /** * AttachNodes请求参数结构体 */ export interface AttachNodesRequest { /** * 集群id */ ClusterId: string; /** * 节点的实例id列表 */ ResourceSet: Array<string>; /** * 队列名称。不指定则为默认队列： SLURM默认队列为：compute。 */ QueueName?: string; /** * 指定有效的镜像ID，格式形如img-xxx。目前仅支持公有镜像和特定自定义镜像。如不指定，则该字段是默认镜像。 */ ImageId?: string; /** * 要新增节点的资源类型。<li>CVM：CVM实例类型资源</li><li>WORKSPACE：工作空间类型实例资源</li>默认值：CVM。 */ ResourceType?: string; /** * 提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16KB。关于获取此参数的详细介绍，请参阅<a href="https://cloud.tencent.com/document/product/213/17526">Windows</a>和<a href="https://cloud.tencent.com/document/product/213/17525">Linux</a>启动时运行命令。 */ 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<SpaceInfo>; /** * 集群数量 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 标签键值对。 */ export interface Tag { /** * 标签键 */ Key: string; /** * 标签值 */ Value: string; } /** * 描述GooseFS挂载信息 */ export interface GooseFSOption { /** * 文件系统本地挂载路径。 */ LocalPath: string; /** * 文件系统远程挂载路径; 远端路径为GooseFS控制台看到的命名空间的url;命名空间文档参考https://cloud.tencent.com/document/product/1424/117877 */ RemotePath: string; /** * 文件系统master的ip和端口，此参数和FileSystemId互斥。 */ Masters?: Array<string>; /** * GooseFS的文件ID；此参数和Masters 互斥。 */ FileSystemId?: string; } /** * 集群存储选项概览信息。 */ export interface StorageOptionOverview { /** * CFS存储选项概览信息列表。 */ CFSOptions?: Array<CFSOptionOverview>; /** * GooseFS存储选项概览信息列表。 */ GooseFSOptions?: Array<GooseFSOptionOverview>; /** * GooseFSx存储选项概览信息列表。 */ GooseFSxOptions?: Array<GooseFSxOptionOverview>; /** * COS存储选项概览信息列表。 */ CosOptions?: Array<CosOptionOverview>; } /** * DescribeJobsOverview请求参数结构体 */ export interface DescribeJobsOverviewRequest { /** * 集群ID */ ClusterId: string; } /** * DeleteCluster返回参数结构体 */ export interface DeleteClusterResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAutoScalingConfiguration返回参数结构体 */ export interface DescribeAutoScalingConfigurationResponse { /** * 集群ID。 */ ClusterId?: string; /** * 任务连续等待时间，队列的任务处于连续等待的时间。单位秒。 */ ExpansionBusyTime?: number; /** * 节点连续空闲（未运行作业）时间，一个节点连续处于空闲状态时间。 */ ShrinkIdleTime?: number; /** * 扩容队列配置概览列表。 */ QueueConfigs?: Array<QueueConfigOverview>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeClusters请求参数结构体 */ export interface DescribeClustersRequest { /** * 集群ID列表。通过该参数可以指定需要查询信息的集群列表。 如果您不指定该参数，则返回Limit数量以内的集群信息。 */ ClusterIds?: Array<string>; /** * 偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */ Offset?: number; /** * 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */ Limit?: number; /** * <ul> <li>cluster-type 按照【集群类型】进行过滤 类型：String 必选：否 </li> </ul> 每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。 */ Filters?: Array<Filter>; } /** * TerminateJob请求参数结构体 */ export interface TerminateJobRequest { /** * 作业任务ID */ JobId: string; } /** * 创建资源工作空间时同时绑定的标签对说明 */ export interface TagSpecification { /** * 标签绑定的资源类型 */ ResourceType: string; /** * 标签对列表 */ Tags: Array<Tag>; } /** * DeleteNodes返回参数结构体 */ export interface DeleteNodesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddClusterStorageOption返回参数结构体 */ export interface AddClusterStorageOptionResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeWorkspaces请求参数结构体 */ export interface DescribeWorkspacesRequest { /** * 集群ID列表。通过该参数可以指定需要查询信息的集群列表。 如果您不指定该参数，则返回Limit数量以内的集群信息。 */ SpaceIds?: Array<string>; /** * 偏移量，默认为0。关于<code>Offset</code>的更进一步介绍请参考 API <a href="https://cloud.tencent.com/document/api/213/15688">简介</a>中的相关小节。 */ Offset?: number; /** * 返回数量，默认为20，最大值为100。关于<code>Limit</code>的更进一步介绍请参考 API <a href="https://cloud.tencent.com/document/api/213/15688">简介</a>中的相关小节。 */ Limit?: number; /** * <ul> <li> zone 按照【可用区】进行过滤 类型：String 必选：否</li> <li> space-id 按照【工作空间实例ID】进行过滤 类型：String 必选：否</li> <li> cvm-instance-id 按照【CVM实例ID】进行过滤 类型：String 必选：否</li> <li> space-state 按照【工作空间状态】进行过滤 类型：String 必选：否</li> <li> space-name 按照【工作空间别名】进行过滤 类型：String 必选：否</li> <li> space-charge-type 按照【工作空间实例付费模式】进行过滤 类型：String 必选：否</li> <li> tag-key 按照【标签键】进行过滤 类型：String 必选：否</li> <li> tag-value 按照【标签值】进行过滤 类型：String 必选：否</li> </ul> 每次请求的<code>Filters</code>的上限为10，<code>Filter.Values</code>的上限为5。 */ Filters?: Array<Filter>; } /** * ModifyNodeAttribute请求参数结构体 */ export interface ModifyNodeAttributeRequest { /** * 节点ID，节点ID通过调用接口 <a href="https://cloud.tencent.com/document/api/1527/89569">DescribeNodes</a>获取。 */ NodeId: string; /** * 节点别名 */ NodeName?: string; /** * 资源的分配状态: - IDLE: 资源空闲 - ISOLATE: 资源隔离 */ NodeAllocateState?: string; /** * 目标队列名 */ QueueName?: string; } /** * AddQueue请求参数结构体 */ export interface AddQueueRequest { /** * 集群ID。 */ ClusterId: string; /** * 队列名称。 <li>最多支持32个字符。</li> */ QueueName: string; } /** * 扩容队列配置概览。 */ export interface QueueConfigOverview { /** * 队列名称。 */ QueueName?: string; /** * 队列中弹性节点数量最小值。取值范围0～200。 */ MinSize?: number; /** * 队列中弹性节点数量最大值。取值范围0～200。 */ MaxSize?: number; /** * 是否开启自动扩容。 */ EnableAutoExpansion?: boolean; /** * 是否开启自动缩容。 */ EnableAutoShrink?: boolean; /** * 扩容节点配置信息。 */ ExpansionNodeConfigs?: Array<ExpansionNodeConfigOverview>; /** * 队列中期望的空闲节点数量（包含弹性节点和静态节点）。默认值：0。队列中，处于空闲状态的节点小于此值，集群会扩容弹性节点；处于空闲状态的节点大于此值，集群会缩容弹性节点。 */ DesiredIdleNodeCapacity?: number; /** * 队列中期望的总节点数。 */ DesiredNodeCount?: number; /** * 扩容比例。默认值：100。取值范围：1～100。如果扩容比例为50，那么每轮只会扩容当前作业负载所需的50%数量的节点。 */ ScaleOutRatio?: number; /** * 比例扩容阈值。默认值：0。取值范围：0～200。当作业负载需要扩容节点数量大于此值，当前扩容轮次按照ScaleOutRatio配置的的比例进行扩容。当作业负载需要扩容节点数量小于此值，当前扩容轮次扩容当前作业负载所需数量的节点。此参数配合ScaleOutRatio参数进行使用，用于比例扩容场景下，在作业负载所需节点数量较小时，加快收敛速度。 */ ScaleOutNodeThreshold?: number; /** * 每轮扩容最大节点个数。 */ MaxNodesPerCycle?: number; /** * 扩容过程中，作业的内存在匹配实例机型时增大比例（不会影响作业提交的内存大小，只影响匹配计算过程）。 针对场景：由于实例机型的总内存会大于实例内部的可用内存，16GB内存规格的实例，实例操作系统内的可用内存只有约14.9GB内存。假设此时提交一个需要15GB内存的作业， - 当ScaleUpMemRatio=0时，会匹配到16GB内存规格的实例,但是由于操作系统内的可用内存为14.9GB小于作业所需的15GB，扩容出来的实例作业无法运行起来。 - 当ScaleUpMemRatio=10时，匹配实例规格会按照15*(1+10%)=16.5GB来进行实例规格匹配，则不会匹配到16GB的实例，而是更大内存规格的实例来保证作业能够被运行起来。 */ ScaleUpMemRatio?: number; } /** * DescribeQueues返回参数结构体 */ export interface DescribeQueuesResponse { /** * 队列概览信息列表。 */ QueueSet?: Array<QueueOverview>; /** * 符合条件的队列数量。 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SubmitJob请求参数结构体 */ export interface SubmitJobRequest { /** * 集群id */ ClusterId: string; /** * 作业任务参数配置 */ Job: Job; /** * 队列名称。不指定则为默认队列： SLURM默认队列为：compute。 SGE默认队列为：all.q。 */ QueueName?: string; } /** * 提交Job作业信息 */ export interface Job { /** * 任务配置信息。 */ Tasks: Array<Task>; /** * 作业名称。 */ JobName?: string; /** * 作业描述。 */ JobDescription?: string; /** * 作业优先级，数值越大，优先级越高，数值范围1～100。 */ Priority?: number; /** * 描述任务的依赖关系，DAG有向无环图。 */ TaskDependencies?: Array<TaskDependence>; } /** * ModifyWorkspacesRenewFlag返回参数结构体 */ export interface ModifyWorkspacesRenewFlagResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述了实例的抽象位置 */ export interface Placement { /** * 实例所属的可用区名称。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。注意：此字段可能返回 null，表示取不到有效值。 */ Zone: string; } /** * DescribeNodes返回参数结构体 */ export interface DescribeNodesResponse { /** * 节点概览信息列表。 */ NodeSet?: Array<NodeOverview>; /** * 符合条件的节点数量。 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GooseFS存储选项概览信息。 */ export interface GooseFSOptionOverview { /** * 文件系统本地挂载路径。 */ LocalPath?: string; /** * 文件系统远程挂载路径。 */ RemotePath?: string; /** * 文件系统master的ip和端口。 */ Masters?: Array<string>; } /** * 描述CFS文件系统版本和挂载信息 */ export interface CFSOption { /** * 文件系统本地挂载路径。 */ LocalPath: string; /** * 文件系统远程挂载ip及路径。 */ RemotePath?: string; /** * 文件系统协议类型。 <li>NFS 3.0</li> <li>NFS 4.0</li> <li>TURBO</li> */ Protocol?: string; /** * 文件系统存储类型，默认值SD；其中 SD 为通用标准型标准型存储， HP为通用性能型存储， TB为turbo标准型， TP 为turbo性能型。 */ StorageType?: string; /** * 文件系统挂载挂载命令参数选项。 - NFS 3.0默认值：vers=3,nolock,proto=tcp,noresvport - NFS 4.0默认值：vers=4.0,noresvport - TURBO默认值：user_xattr */ MountOption?: string; /** * 文件系统ID 文件系统ID通过调用接口[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)获取。 */ FileSystemId?: string; } /** * COS挂载信息 */ export interface CosOption { /** * 文件系统本地挂载路径。 */ LocalPath: string; /** * COS桶地址，可以在COS桶详情页查看。 */ RemotePath: string; /** * cosfs2挂载工具支持的参数。 */ MountParamsOption?: string; } /** * DeleteClusterStorageOption请求参数结构体 */ export interface DeleteClusterStorageOptionRequest { /** * 集群ID。 */ ClusterId: string; /** * 本地挂载路径。 */ LocalPath: string; } /** * 描述了 “腾讯云可观测平台” 服务相关的信息。 */ export interface RunMonitorServiceEnabled { /** * 是否开启[腾讯云可观测平台](/document/product/248)服务。取值范围： <li>TRUE：表示开启腾讯云可观测平台服务</li> <li>FALSE：表示不开启腾讯云可观测平台服务</li> 默认取值：TRUE。 */ Enabled?: boolean; } /** * 扩容节点配置信息概览。 */ export interface ExpansionNodeConfigOverview { /** * 节点机型。注意：此字段可能返回 null，表示取不到有效值。 */ InstanceType?: string; /** * 扩容实例所在的位置。注意：此字段可能返回 null，表示取不到有效值。 */ Placement?: Placement; /** * 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。注意：此字段可能返回 null，表示取不到有效值。 */ InstanceChargeType?: string; /** * 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。注意：此字段可能返回 null，表示取不到有效值。 */ InstanceChargePrepaid?: InstanceChargePrepaid; /** * 私有网络相关信息配置。注意：此字段可能返回 null，表示取不到有效值。 */ VirtualPrivateCloud?: VirtualPrivateCloud; /** * 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID，格式形如`img-xxx`。注意：此字段可能返回 null，表示取不到有效值。 */ ImageId?: string; /** * 公网带宽相关信息设置。注意：此字段可能返回 null，表示取不到有效值。 */ InternetAccessible?: InternetAccessible; /** * 节点系统盘配置信息。注意：此字段可能返回 null，表示取不到有效值。 */ SystemDisk?: SystemDisk; /** * 节点数据盘配置信息。注意：此字段可能返回 null，表示取不到有效值。 */ DataDisks?: Array<DataDisk>; } /** * DeleteJob请求参数结构体 */ export interface DeleteJobRequest { /** * 作业任务ID */ JobId: string; } /** * 工作空间数据盘配置 */ export interface SpaceDataDisk { /** * 数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围： <li> LOCAL_BASIC：本地硬盘 <li> LOCAL_SSD：本地SSD硬盘 <li> LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定 <li> LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定 <li> CLOUD_BASIC：普通云硬盘 <li> CLOUD_PREMIUM：高性能云硬盘 <li> CLOUD_SSD：SSD云硬盘 <li> CLOUD_HSSD：增强型SSD云硬盘 <li> CLOUD_TSSD：极速型SSD云硬盘 <li> CLOUD_BSSD：通用型SSD云硬盘 默认取值：LOCAL_BASIC。 该参数对`ResizeInstanceDisk`接口无效。 </li> </li> </li> </li> </li> </li> </li> </li> </li> </li> */ DiskType?: string; /** * 数据盘注意：此字段可能返回 null，表示取不到有效值。 */ DiskId?: string; /** * 数据盘大小，单位：GB。最小调整步长为10G，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。 */ DiskSize?: number; /** * 数据盘是否随子机销毁。取值范围： <li>TRUE：子机销毁时，销毁数据盘，只支持按小时后付费云盘</li> <li> FALSE：子机销毁时，保留数据盘 默认取值：TRUE 该参数目前仅用于 `RunInstances` 接口。 </li> 注意：此字段可能返回 null，表示取不到有效值。 */ DeleteWithInstance?: boolean; /** * 数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。注意：此字段可能返回 null，表示取不到有效值。 */ SnapshotId?: string; /** * 数据盘是加密。取值范围： <li>true：加密</li> <li> false：不加密 默认取值：false 该参数目前仅用于 `RunInstances` 接口。 </li> 注意：此字段可能返回 null，表示取不到有效值。 */ Encrypt?: boolean; /** * 自定义CMK对应的ID，取值为UUID或者类似kms-abcd1234。用于加密云盘。该参数目前仅用于 `CreateWorkspaces` 接口。注意：此字段可能返回 null，表示取不到有效值。 */ KmsKeyId?: string; /** * 云硬盘性能，单位：MB/s 注意：此字段可能返回 null，表示取不到有效值。 */ ThroughputPerformance?: number; /** * 突发性能注：内测中。注意：此字段可能返回 null，表示取不到有效值。 */ BurstPerformance?: boolean; } /** * DetachNodes返回参数结构体 */ export interface DetachNodesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeClusterStorageOption请求参数结构体 */ export interface DescribeClusterStorageOptionRequest { /** * 集群ID。 */ ClusterId: string; } /** * 描述集群文件系统选项 */ export interface StorageOption { /** * 集群挂载CFS文件系统选项。 */ CFSOptions?: Array<CFSOption>; /** * 集群挂载GooseFS文件系统选项。 */ GooseFSOptions?: Array<GooseFSOption>; /** * 集群挂载GooseFSx文件系统选项。 */ GooseFSxOptions?: Array<GooseFSxOption>; /** * 集群挂载COS文件系统选项。 */ CosOptions?: Array<CosOption>; } /** * 登录节点概览。 */ export interface LoginNodeOverview { /** * 登录节点ID。 */ NodeId: string; } /** * ModifyWorkspacesAttribute返回参数结构体 */ export interface ModifyWorkspacesAttributeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeClusters返回参数结构体 */ export interface DescribeClustersResponse { /** * 集群概览信息列表。 */ ClusterSet?: Array<ClusterOverview>; /** * 集群数量。 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeClusterActivities返回参数结构体 */ export interface DescribeClusterActivitiesResponse { /** * 集群活动历史记录列表。 */ ClusterActivitySet?: Array<ClusterActivity>; /** * 集群活动历史记录数量。 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddNodes请求参数结构体 */ export interface AddNodesRequest { /** * 集群中实例所在的位置。 */ Placement: Placement; /** * 集群ID。 */ ClusterId: string; /** * 私有网络相关信息配置。 */ VirtualPrivateCloud: VirtualPrivateCloud; /** * 添加节点数量。 */ Count: number; /** * 指定有效的<a href="https://cloud.tencent.com/document/product/213/4940">镜像</a>ID，格式形如<code>img-xxx</code>。目前支持部分公有镜像和自定义镜像。公共镜像请参考<a href="https://cloud.tencent.com/document/product/1527/64818#.E9.95.9C.E5.83.8F">镜像限制</a> */ ImageId?: string; /** * 节点<a href="https://cloud.tencent.com/document/product/213/2180">计费类型</a>。 <li>PREPAID：预付费，即包年包月</li><li>POSTPAID_BY_HOUR：按小时后付费</li><li>SPOTPAID：竞价付费</li>默认值：POSTPAID_BY_HOUR。 */ InstanceChargeType?: string; /** * 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid; /** * 节点机型。不同实例机型指定了不同的资源规格。 <li>具体取值可通过调用接口<a href="https://cloud.tencent.com/document/api/213/15749">DescribeInstanceTypeConfigs</a>来获得最新的规格表或参见<a href="https://cloud.tencent.com/document/product/213/11518">实例规格</a>描述。</li> */ InstanceType?: string; /** * 节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。 */ SystemDisk?: SystemDisk; /** * 节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。 */ DataDisks?: Array<DataDisk>; /** * 公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。 */ InternetAccessible?: InternetAccessible; /** * 节点显示名称。 不指定节点显示名称则默认显示‘未命名’。 最多支持60个字符。 */ InstanceName?: string; /** * 集群登录设置。 */ LoginSettings?: LoginSettings; /** * 集群中实例所属安全组。该参数可以通过调用 <a href="https://cloud.tencent.com/document/api/215/15808">DescribeSecurityGroups</a> 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。 */ SecurityGroupIds?: Array<string>; /** * 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 */ ClientToken?: string; /** * 队列名称。不指定则为默认队列。<li>SLURM默认队列为：compute。</li> */ QueueName?: string; /** * 添加节点角色。默认值：Compute <li>Compute：计算节点。</li><li>Login：登录节点。</li> */ NodeRole?: string; /** * 是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和云服务器库存。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId. false（默认）：发送正常请求，通过检查后直接创建实例 */ DryRun?: boolean; /** * 添加节点类型。默认取值：STATIC。<li>STATIC：静态节点，不会参与弹性伸缩流程。</li><li>DYNAMIC：弹性节点，会被弹性缩容的节点。管控节点和登录节点不支持此参数。</li> */ NodeType?: string; /** * 实例所属项目ID。该参数可以通过调用 <a href="https://cloud.tencent.com/document/api/651/78725">DescribeProject</a> 的返回值中的 projectId 字段来获取。不填为默认项目。 */ ProjectId?: number; /** * 要新增节点的资源类型。<li>CVM：CVM实例类型资源</li><li>WORKSPACE：工作空间类型实例资源</li>默认值：CVM。 */ ResourceType?: string; } /** * DeleteQueue返回参数结构体 */ export interface DeleteQueueResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述了数据盘的信息 */ export interface DataDisk { /** * 数据盘大小，单位：GB。最小调整步长为10G，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。注意：此字段可能返回 null，表示取不到有效值。 */ DiskSize: number; /** * 数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围： <li>LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定 <li>LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定 <li>CLOUD_BASIC：普通云硬盘 <li>CLOUD_PREMIUM：高性能云硬盘 <li>CLOUD_SSD：SSD云硬盘 <li>CLOUD_HSSD：增强型SSD云硬盘 <li>CLOUD_TSSD：极速型SSD云硬盘 <li>CLOUD_BSSD：通用型SSD云硬盘注意：此字段可能返回 null，表示取不到有效值。 */ DiskType?: string; } /** * 队列信息概览。 */ export interface QueueOverview { /** * 队列名称。 */ QueueName?: string; } /** * DeleteJob返回参数结构体 */ export interface DeleteJobResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述了实例登录相关配置与信息。 */ export interface LoginSettings { /** * 实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下： <li>Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) \` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。</li> <li>Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) \` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。</li> 若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到用户。 */ Password?: string; /** * 实例登录密钥 */ KeyIds?: Array<string>; } /** * 任务的依赖关系。 */ export interface TaskDependence { /** * 依赖关系的起点任务名称。 */ StartTask: string; /** * 依赖关系的终点任务名称。 */ EndTask: string; } /** * 描述了实例的增强服务启用情况与其设置，如云安全，腾讯云可观测平台等实例 Agent */ export interface EnhancedService { /** * 开启云安全服务。若不指定该参数，则默认开启云安全服务。 */ SecurityService?: RunSecurityServiceEnabled; /** * 开启腾讯云可观测平台服务。若不指定该参数，则默认开启腾讯云可观测平台服务。 */ MonitorService?: RunMonitorServiceEnabled; /** * 开启云自动化助手服务（TencentCloud Automation Tools，TAT）。若不指定该参数，默认开启云自动化助手服务。 */ AutomationService?: RunAutomationServiceEnabled; } /** * 描述了 “云自动化助手” 服务相关的信息。 */ export interface RunAutomationServiceEnabled { /** * 是否开启云自动化助手。取值范围： <li>TRUE：表示开启云自动化助手服务</li> <li>FALSE：表示不开启云自动化助手服务</li> 默认取值：TRUE。 */ Enabled?: boolean; } /** * 符合条件的集群活动信息。 */ export interface ClusterActivity { /** * 集群ID。 */ ClusterId?: string; /** * 集群活动ID。 */ ActivityId?: string; /** * 集群活动类型。取值范围： <li>CreateAndAddNodes：创建实例并添加进集群</li> <li>RemoveNodesFromCluster：从集群移除实例</li> <li>TerminateNodes：销毁实例</li> <li>MountStorageOption：增加挂载选项并进行挂载</li> <li>UmountStorageOption：删除集群挂载存储选项并解挂载</li> */ ActivityType?: string; /** * 集群活动状态。取值范围： <li>PENDING：等待运行</li> <li>RUNNING：运行中</li> <li>SUCCESSFUL：活动成功</li> <li>PARTIALLY_SUCCESSFUL：活动部分成功</li> <li>FAILED：活动失败</li> */ ActivityStatus?: string; /** * 集群活动状态码。 */ ActivityStatusCode?: string; /** * 集群活动结果详情。注意：此字段可能返回 null，表示取不到有效值。 */ ResultDetail?: string; /** * 集群活动起因。 */ Cause?: string; /** * 集群活动描述。 */ Description?: string; /** * 集群活动相关节点活动集合。 */ RelatedNodeActivitySet?: Array<NodeActivity>; /** * 集群活动开始时间。 */ StartTime?: string; /** * 集群活动结束时间。 */ EndTime?: string; } /** * DescribeJobSubmitInfo返回参数结构体 */ export interface DescribeJobSubmitInfoResponse { /** * 集群ID */ ClusterId?: string; /** * 队列名称 */ QueueName?: string; /** * 作业信息 */ Job?: Job; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateCluster返回参数结构体 */ export interface CreateClusterResponse { /** * 集群ID。 */ ClusterId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述了 “云安全” 服务相关的信息。 */ export interface RunSecurityServiceEnabled { /** * 是否开启[云安全](/document/product/296)服务。取值范围： <li>TRUE：表示开启云安全服务</li> <li>FALSE：表示不开启云安全服务</li> 默认取值：TRUE。 */ Enabled?: boolean; } /** * DescribeQueues请求参数结构体 */ export interface DescribeQueuesRequest { /** * 集群ID。 */ ClusterId: string; /** * 偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */ Offset?: number; /** * 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */ Limit?: number; } /** * SetAutoScalingConfiguration返回参数结构体 */ export interface SetAutoScalingConfigurationResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateCluster请求参数结构体 */ export interface CreateClusterRequest { /** * 集群中实例所在的位置。 */ Placement?: Placement; /** * 指定管理节点。 */ ManagerNode?: ManagerNode; /** * 指定管理节点的数量。默认取值：1。取值范围：1～2。 */ ManagerNodeCount?: number; /** * 指定计算节点。 */ ComputeNode?: ComputeNode; /** * 指定计算节点的数量。默认取值：0。 */ ComputeNodeCount?: number; /** * 调度器类型。默认取值：SLURM。<li>SLURM：SLURM调度器。</li> */ SchedulerType?: string; /** * 创建调度器的版本号，可填写版本号为“latest” 和各调度器支持的版本号；如果是"latest", 则代表创建的是平台当前支持的该类型调度器最新版本。如果不填写，默认创建的是“latest”版本调度器 各调度器支持的集群版本：<li>SLURM：21.08.8、23.11.7</li> */ SchedulerVersion?: string; /** * 指定有效的<a href="https://cloud.tencent.com/document/product/213/4940">镜像</a>ID，格式形如<code>img-xxx</code>。目前支持部分公有镜像和自定义镜像。公共镜像请参考<a href="https://cloud.tencent.com/document/product/1527/64818#.E9.95.9C.E5.83.8F">镜像限制</a> */ ImageId?: string; /** * 私有网络相关信息配置。 */ VirtualPrivateCloud?: VirtualPrivateCloud; /** * 集群登录设置。 */ LoginSettings?: LoginSettings; /** * 集群中实例所属安全组。该参数可以通过调用 <a href="https://cloud.tencent.com/document/api/215/15808">DescribeSecurityGroups</a> 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。 */ SecurityGroupIds?: Array<string>; /** * 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 */ ClientToken?: string; /** * 是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和云服务器库存。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId. false（默认）：发送正常请求，通过检查后直接创建实例 */ DryRun?: boolean; /** * 域名字服务类型。默认取值：NIS。<li>NIS：NIS域名字服务。</li> */ AccountType?: string; /** * 集群显示名称。 */ ClusterName?: string; /** * 集群存储选项 */ StorageOption?: StorageOption; /** * 指定登录节点。 */ LoginNode?: LoginNode; /** * 指定登录节点的数量。默认取值：0。取值范围：0～10。 */ LoginNodeCount?: number; /** * 创建集群时同时绑定的标签对说明。 */ Tags?: Array<Tag>; /** * 弹性伸缩类型。默认值：THPC_AS */ AutoScalingType?: string; /** * 节点初始化脚本信息列表。 */ InitNodeScripts?: Array<NodeScript>; /** * 高性能计算集群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 { /** * 节点<a href="https://cloud.tencent.com/document/product/213/2180">计费类型</a>。枚举值：<ul><li> PREPAID：预付费，即包年包月</li><li> POSTPAID_BY_HOUR：按小时后付费</li></ul> */ InstanceChargeType?: string; /** * 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid; /** * 节点机型。不同实例机型指定了不同的资源规格。 <li>具体取值可通过调用接口<a href="https://cloud.tencent.com/document/api/213/15749">DescribeInstanceTypeConfigs</a>来获得最新的规格表或参见<a href="https://cloud.tencent.com/document/product/213/11518">实例规格</a>描述。</li> */ InstanceType?: string; /** * 节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。 */ SystemDisk?: SystemDisk; /** * 节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。 */ DataDisks?: Array<DataDisk>; /** * 公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。 */ InternetAccessible?: InternetAccessible; /** * 节点显示名称。 <li> 不指定节点显示名称则默认显示‘未命名’。 </li><li>购买多个节点，如果指定模式串<code>{R:x}</code>，表示生成数字[<code>[x, x+n-1]</code>，其中<code>n</code>表示购买节点的数量，例如<code>server_{R:3}</code>，购买1个时，节点显示名称为<code>server_3</code>；购买2个时，节点显示名称分别为<code>server_3</code>，<code>server_4</code>。支持指定多个模式串<code>{R:x}</code>。购买多个节点，如果不指定模式串，则在节点显示名称添加后缀<code>1、2...n</code>，其中<code>n</code>表示购买节点的数量，例如<code>server_</code>，购买2个时，节点显示名称分别为<code>server_1</code>，<code>server_2</code>。</li><li> 最多支持60个字符（包含模式串）。</li> */ InstanceName?: string; /** * 实例所属项目ID。该参数可以通过调用 <a href="https://cloud.tencent.com/document/api/651/78725">DescribeProject</a> 的返回值中的 projectId 字段来获取。不填为默认项目。 */ ProjectId?: number; /** * 增强服务。通过该参数可以指定是否开启云安全、腾讯云可观测平台等服务。若不指定该参数，则默认开启腾讯云可观测平台、云安全服务、自动化助手服务。 */ EnhancedService?: EnhancedService; } /** * DescribeJobSubmitInfo请求参数结构体 */ export interface DescribeJobSubmitInfoRequest { /** * 作业ID */ JobId: string; } /** * 输出重定向配置 */ export interface OutputRedirect { /** * 输出driver类型枚举值：<ul><li>local：宿主机本地目录</li><li>cos：远端cos存储</li></ul>默认值：local */ Driver?: string; /** * 重定向配置参数日志重定向路径，用于指定任务日志的输出目标。取值格式与 Driver 类型关联： 当 Driver 为 local 时，格式为本地文件路径，如 stdout=/tmp/train_out.log； 当 Driver 为 cos 时，格式为 COS 存储桶路径，如 stdout=cos://test-123456.cos.ap-shanghai.myqcloud.com/test/. */ Options?: Array<string>; } /** * ModifyWorkspacesAttribute请求参数结构体 */ export interface ModifyWorkspacesAttributeRequest { /** * 工作空间列表 */ SpaceIds: Array<string>; /** * 修改后的工作空间名称。可任意命名，但不得超过60个字符。 */ SpaceName?: string; } /** * >描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等 > * 若存在多个`Filter`时，`Filter`间的关系为逻辑与（`AND`）关系。 > * 若同一个`Filter`存在多个`Values`，同一`Filter`下`Values`间的关系为逻辑或（`OR`）关系。 */ export interface Filter { /** * 需要过滤的字段。 */ Name: string; /** * 字段的过滤值。 */ Values: Array<string>; } /** * 容器配置信息。 */ export interface Docker { /** * 容器镜像地址 */ Image: string; /** * 容器运行参数 */ RunArgs?: Array<string>; } /** * 任务的应用环境配置信息。 */ export interface Application { /** * 待执行脚本命令。 */ Commands: Array<CommandItem>; /** * 存储目录挂载配置。 */ StorageMounts?: Array<StorageMount>; /** * 用户自定义环境变量。 */ EnvVars?: Array<EnvVar>; /** * 容器配置信息。 */ Docker?: Docker; /** * 无 */ OutputRedirect?: OutputRedirect; /** * 表示所选训练框架，支持可选参数 - PyTorch：表示提交PyTorch训练作业 - Custom：表示用户自定义作业默认参数为：Custom * @deprecated */ JobType?: string; /** * 表示所选训练框架，支持可选参数 - PyTorch：表示提交PyTorch训练作业 - Custom：表示用户自定义作业默认参数为：Custom */ TaskType?: string; } /** * 描述工作空间的信息 */ export interface SpaceInfo { /** * 工作空间ID */ SpaceId?: string; /** * 工作空间类别 */ SpaceClass?: string; /** * 工作空间类型 */ SpaceFamily?: string; /** * 工作空间规格 */ SpaceType?: string; /** * 工作空间名称 */ SpaceName?: string; /** * 工作空间状态。取值范围： <li>PENDING：表示创建中 </li><li>LAUNCH_FAILED：表示创建失败 </li><li>ONLINE：表示运行中 </li><li>ARREARS：表示隔离中 </li><li>TERMINATING：表示销毁中。 </li> */ SpaceState?: string; /** * 工作空间计费模式 */ SpaceChargeType?: string; /** * 工作空间对应资源ID */ ResourceId?: string; /** * 自动续费标识 */ RenewFlag?: string; /** * 工作空间关联的工作列表 */ Tags?: Array<Tag>; /** * 创建时间 */ CreatedTime?: string; /** * 到期时间 */ ExpiredTime?: string; /** * 工作空间所在位置 */ Placement?: Placement; /** * 工作空间的最新操作 注意：此字段可能返回 null，表示取不到有效值。 */ LatestOperation?: string; /** * 工作空间的最新操作状态 注意：此字段可能返回 null，表示取不到有效值。 */ LatestOperationState?: string; /** * 实例的内网IP */ PrivateIpAddresses?: Array<string>; } /** * TerminateWorkspaces请求参数结构体 */ export interface TerminateWorkspacesRequest { /** * 工作空间ID */ SpaceIds: Array<string>; /** * 释放空间挂载的包年包月数据盘。true表示销毁空间同时释放包年包月数据盘，false表示只销毁空间。 */ ReleasePrepaidDataDisks?: boolean; } /** * 计算节点信息。 */ export interface ComputeNode { /** * 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。<li>PREPAID：预付费，即包年包月</li><li>POSTPAID_BY_HOUR：按小时后付费</li><li>SPOTPAID：竞价付费</li>默认值：POSTPAID_BY_HOUR。 */ InstanceChargeType?: string; /** * 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid; /** * 节点机型。不同实例机型指定了不同的资源规格。<li>具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。</li> */ InstanceType?: string; /** * 节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。 */ SystemDisk?: SystemDisk; /** * 节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。 */ DataDisks?: Array<DataDisk>; /** * 公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。 */ InternetAccessible?: InternetAccessible; /** * 节点显示名称。<li>不指定节点显示名称则默认显示‘未命名’。最多支持60个字符。</li> */ InstanceName?: string; /** * 实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。 */ ProjectId?: number; /** * 实例资源类型，默认是CVM资源 */ ResourceType?: string; } /** * DeleteNodes请求参数结构体 */ export interface DeleteNodesRequest { /** * 集群ID。 */ ClusterId: string; /** * 节点ID。 */ NodeIds: Array<string>; } /** * DeleteClusterStorageOption返回参数结构体 */ export interface DeleteClusterStorageOptionResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TerminateJob返回参数结构体 */ export interface TerminateJobResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述了工作空间的公网可访问性，声明了工作空间的公网使用计费模式，最大带宽等 */ export interface SpaceInternetAccessible { /** * 网络计费类型注意：此字段可能返回 null，表示取不到有效值。 */ InternetChargeType?: string; /** * 公网出带宽上限，默认为0 注意：此字段可能返回 null，表示取不到有效值。 */ InternetMaxBandwidthOut?: number; /** * 是否分配公网IP 注意：此字段可能返回 null，表示取不到有效值。 */ PublicIpAssigned?: boolean; /** * 带宽包ID 注意：此字段可能返回 null，表示取不到有效值。 */ BandwidthPackageId?: string; } /** * DescribeJobs请求参数结构体 */ export interface DescribeJobsRequest { /** * 作业任务ID列表 */ JobIds?: Array<string>; /** * 过滤列表 */ Filters?: Array<Filter>; /** * 偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */ Offset?: number; /** * 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */ Limit?: number; } /** * GooseFSx存储选项概览信息。 */ export interface GooseFSxOptionOverview { /** * 文件系统master的ip和端口列表。 */ Masters?: Array<string>; /** * 文件系统的本地挂载路径。GooseFSx目前只支持挂载在/goosefsx/{文件系统ID}_proxy/目录下。 */ LocalPath?: string; } /** * COS存储选项概览信息。 */ export interface CosOptionOverview { /** * 文件系统本地挂载路径。 */ LocalPath?: string; /** * COS桶地址。 */ RemotePath?: string; /** * COS挂载参数 */ MountOption?: string; } /** * SetAutoScalingConfiguration请求参数结构体 */ export interface SetAutoScalingConfigurationRequest { /** * 集群ID。 */ ClusterId: string; /** * 任务连续等待时间，队列的任务处于连续等待的时间。单位秒。默认值120。 */ ExpansionBusyTime?: number; /** * 节点连续空闲（未运行作业）时间，一个节点连续处于空闲状态时间。单位秒。默认值300。 */ ShrinkIdleTime?: number; /** * 扩容队列配置列表。 */ QueueConfigs?: Array<QueueConfig>; /** * 是否只预检此次请求。 true：发送检查请求，不会绑定弹性伸缩组。检查项包括是否填写了必需参数，请求格式，业务限制。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId。 false（默认）：发送正常请求，通过检查后直接绑定弹性伸缩组。 */ DryRun?: boolean; } /** * SubmitJob返回参数结构体 */ export interface SubmitJobResponse { /** * 作业任务ID */ JobId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeNodes请求参数结构体 */ export interface DescribeNodesRequest { /** * 集群ID。 */ ClusterId?: string; /** * <ul> <li>queue-name 按照【队列名称】进行过滤。队列名称形如：compute。 类型：String 必选：否 </li> <li>node-role 按照【节点角色】进行过滤。节点角色形如：Manager。（Manager：管控节点。Compute：计算节点。Login：登录节点。ManagerBackup：备用管控节点。） 类型：String 必选：否 </li> <li>node-type 按照【节点类型】进行过滤。节点类型形如：STATIC。(STATIC：静态节点。DYNAMIC：弹性节点。) 类型：String 必选：否 </li> <li>instance-id 按照【CVM实例资源ID】进行过滤。资源ID名称形如：ins-xxx。 类型：String 必选：否 </li> </ul>每次请求的`Filters`的上限为10，`Filter.Values`的上限为100。 */ Filters?: Array<Filter>; /** * 偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */ Offset?: number; /** * 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */ Limit?: number; } /** * DetachNodes请求参数结构体 */ export interface DetachNodesRequest { /** * 集群id */ ClusterId: string; /** * 集群中的节点id */ NodeIds: Array<string>; } /** * AttachNodes返回参数结构体 */ export interface AttachNodesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 登录节点信息。 */ export interface LoginNode { /** * 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。 <li>PREPAID：预付费，即包年包月</li> <li>POSTPAID_BY_HOUR：按小时后付费</li> <li>SPOTPAID：竞价付费 默认值：POSTPAID_BY_HOUR。</li> */ InstanceChargeType?: string; /** * 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid; /** * 节点机型。不同实例机型指定了不同的资源规格。 <li>具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。</li> */ InstanceType?: string; /** * 节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。 */ SystemDisk?: SystemDisk; /** * 节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。 */ DataDisks?: Array<DataDisk>; /** * 公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。 */ InternetAccessible?: InternetAccessible; /** * 节点显示名称。 <li> 不指定节点显示名称则默认显示‘未命名’。最多支持60个字符。</li> */ In