UNPKG

tenyun

Version:

Promise based and chained Tencent Cloud OpenAPI client for NodeJS

1,504 lines (1,366 loc) 128 kB
/// <reference types="node" /> import { AxiosPromise, AxiosRequestConfig } from "axios"; /** 任务的应用环境配置信息。 */ declare interface Application { /** 待执行脚本命令。 */ Commands: CommandItem[]; /** 存储目录挂载配置。 */ StorageMounts?: StorageMount[]; /** 用户自定义环境变量。 */ EnvVars?: EnvVar[]; /** 容器配置信息。 */ Docker?: Docker; /** 无 */ OutputRedirect?: OutputRedirect; /** 表示所选训练框架,支持可选参数 - PyTorch:表示提交PyTorch训练作业- Custom:表示用户自定义作业默认参数为:Custom */ JobType?: string; } /** 描述CFS文件系统版本和挂载信息 */ declare interface CFSOption { /** 文件系统本地挂载路径。 */ LocalPath: string; /** 文件系统远程挂载ip及路径。 */ RemotePath?: string; /** 文件系统协议类型。NFS 3.0NFS 4.0TURBO */ 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; } /** CFS存储选项概览信息。 */ declare interface CFSOptionOverview { /** 文件系统本地挂载路径。 */ LocalPath: string; /** 文件系统远程挂载ip及路径。 */ RemotePath: string; /** 文件系统协议类型。NFS 3.0。NFS 4.0。TURBO。 */ Protocol: string; /** 文件系统存储类型,默认值SD;其中 SD 为通用标准型标准型存储, HP为通用性能型存储, TB为turbo标准型, TP 为turbo性能型。 */ StorageType: string; /** 文件系统挂载命令参数选项。 */ MountOption?: string; } /** 符合条件的集群活动信息。 */ declare interface ClusterActivity { /** 集群ID。 */ ClusterId?: string; /** 集群活动ID。 */ ActivityId?: string; /** 集群活动类型。取值范围:CreateAndAddNodes:创建实例并添加进集群RemoveNodesFromCluster:从集群移除实例TerminateNodes:销毁实例MountStorageOption:增加挂载选项并进行挂载UmountStorageOption:删除集群挂载存储选项并解挂载 */ ActivityType?: string; /** 集群活动状态。取值范围:PENDING:等待运行RUNNING:运行中SUCCESSFUL:活动成功PARTIALLY_SUCCESSFUL:活动部分成功FAILED:活动失败 */ ActivityStatus?: string; /** 集群活动状态码。 */ ActivityStatusCode?: string; /** 集群活动结果详情。 */ ResultDetail?: string | null; /** 集群活动起因。 */ Cause?: string; /** 集群活动描述。 */ Description?: string; /** 集群活动相关节点活动集合。 */ RelatedNodeActivitySet?: NodeActivity[]; /** 集群活动开始时间。 */ StartTime?: string; /** 集群活动结束时间。 */ EndTime?: string; } /** 集群概览信息。 */ declare interface ClusterOverview { /** 集群ID。 */ ClusterId?: string; /** 集群状态。取值范围:PENDING:创建中INITING:初始化中INIT_FAILED:初始化失败RUNNING:运行中TERMINATING:销毁中 */ ClusterStatus?: string; /** 集群名称。 */ ClusterName?: string; /** 集群位置信息。 */ Placement?: Placement; /** 集群创建时间。 */ CreateTime?: string; /** 集群调度器。 */ SchedulerType?: string; /** 集群调度器版本。 */ SchedulerVersion?: string; /** 计算节点数量。 */ ComputeNodeCount?: number; /** 计算节点概览。 */ ComputeNodeSet?: ComputeNodeOverview[]; /** 管控节点数量。 */ ManagerNodeCount?: number; /** 管控节点概览。 */ ManagerNodeSet?: ManagerNodeOverview[]; /** 登录节点概览。 */ LoginNodeSet?: LoginNodeOverview[]; /** 登录节点数量。 */ LoginNodeCount?: number; /** 弹性伸缩类型。 */ AutoScalingType?: string; /** 集群所属私有网络ID。 */ VpcId?: string; /** 集群类型 */ ClusterType?: string; } /** 任务执行命令脚本。 */ declare interface CommandItem { /** 脚本命令 */ Command: string; } /** 计算节点信息。 */ declare interface ComputeNode { /** 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID:预付费,即包年包月POSTPAID_BY_HOUR:按小时后付费SPOTPAID:竞价付费默认值:POSTPAID_BY_HOUR。 */ InstanceChargeType?: string; /** 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid; /** 节点机型。不同实例机型指定了不同的资源规格。具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。 */ InstanceType?: string; /** 节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。 */ SystemDisk?: SystemDisk; /** 节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。 */ DataDisks?: DataDisk[]; /** 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。 */ InternetAccessible?: InternetAccessible; /** 节点显示名称。不指定节点显示名称则默认显示‘未命名’。最多支持60个字符。 */ InstanceName?: string; /** 实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。 */ ProjectId?: number; /** 实例资源类型,默认是CVM资源 */ ResourceType?: string; } /** 计算节点概览。 */ declare interface ComputeNodeOverview { /** 计算节点ID。 */ NodeId?: string; } /** 描述了数据盘的信息 */ declare interface DataDisk { /** 数据盘大小,单位:GB。最小调整步长为10G,不同数据盘类型取值范围不同,具体限制详见:[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0,表示不购买数据盘。更多限制详见产品文档。 */ DiskSize: number | null; /** 数据盘类型。数据盘类型限制详见[存储概述](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云硬盘 */ DiskType?: string | null; } /** 容器配置信息。 */ declare interface Docker { /** 容器镜像地址 */ Image: string; /** 容器运行参数 */ RunArgs?: string[]; } /** 描述了实例的增强服务启用情况与其设置,如云安全,腾讯云可观测平台等实例 Agent */ declare interface EnhancedService { /** 开启云安全服务。若不指定该参数,则默认开启云安全服务。 */ SecurityService?: RunSecurityServiceEnabled; /** 开启腾讯云可观测平台服务。若不指定该参数,则默认开启腾讯云可观测平台服务。 */ MonitorService?: RunMonitorServiceEnabled; /** 开启云自动化助手服务(TencentCloud Automation Tools,TAT)。若不指定该参数,默认开启云自动化助手服务。 */ AutomationService?: RunAutomationServiceEnabled; } /** 用户自定义环境变量。 */ declare interface EnvVar { /** ENV */ Name: string; /** test */ Value: string; } /** 弹性扩容节点配置信息。 */ declare interface ExpansionNodeConfig { /** 扩容实例所在的位置。 */ Placement: Placement; /** 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID:预付费,即包年包月POSTPAID_BY_HOUR:按小时后付费SPOTPAID:竞价付费默认值:POSTPAID_BY_HOUR。 */ InstanceChargeType?: string; /** 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid; /** 节点机型。不同实例机型指定了不同的资源规格。具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。 */ InstanceType?: string; /** 私有网络相关信息配置。 */ VirtualPrivateCloud?: VirtualPrivateCloud; /** 实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。 */ ProjectId?: number; } /** 扩容节点配置信息概览。 */ declare interface ExpansionNodeConfigOverview { /** 节点机型。 */ InstanceType?: string | null; /** 扩容实例所在的位置。 */ Placement?: Placement | null; /** 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。 */ InstanceChargeType?: string | null; /** 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid | null; /** 私有网络相关信息配置。 */ VirtualPrivateCloud?: VirtualPrivateCloud | null; /** 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。 */ ImageId?: string | null; /** 公网带宽相关信息设置。 */ InternetAccessible?: InternetAccessible | null; /** 节点系统盘配置信息。 */ SystemDisk?: SystemDisk | null; /** 节点数据盘配置信息。 */ DataDisks?: DataDisk[] | null; } /** >描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等> * 若存在多个`Filter`时,`Filter`间的关系为逻辑与(`AND`)关系。> * 若同一个`Filter`存在多个`Values`,同一`Filter`下`Values`间的关系为逻辑或(`OR`)关系。 */ declare interface Filter { /** 需要过滤的字段。 */ Name: string; /** 字段的过滤值。 */ Values: string[]; } /** 描述GooseFS挂载信息 */ declare interface GooseFSOption { /** 文件系统本地挂载路径。 */ LocalPath: string; /** 文件系统远程挂载路径。 */ RemotePath: string; /** 文件系统master的ip和端口。 */ Masters: string[]; } /** GooseFS存储选项概览信息。 */ declare interface GooseFSOptionOverview { /** 文件系统本地挂载路径。 */ LocalPath?: string; /** 文件系统远程挂载路径。 */ RemotePath?: string; /** 文件系统master的ip和端口。 */ Masters?: string[]; } /** 描述GooseFSx挂载信息 */ declare interface GooseFSxOption { /** 文件系统master的ip和端口列表。 */ Masters: string[] | null; /** 文件系统的本地挂载路径。GooseFSx目前只支持挂载在/goosefsx/{文件系统ID}_proxy/目录下。 */ LocalPath: string | null; } /** GooseFSx存储选项概览信息。 */ declare interface GooseFSxOptionOverview { /** 文件系统master的ip和端口列表。 */ Masters?: string[]; /** 文件系统的本地挂载路径。GooseFSx目前只支持挂载在/goosefsx/{文件系统ID}_proxy/目录下。 */ LocalPath?: string; } /** 描述了实例的计费模式 */ declare interface InstanceChargePrepaid { /** 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。 */ Period: number | null; /** 自动续费标识。取值范围:NOTIFY_AND_AUTO_RENEW:通知过期且自动续费NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。 */ RenewFlag?: string | null; } /** 描述了实例的公网可访问性,声明了实例的公网使用计费模式,最大带宽等 */ declare interface InternetAccessible { /** 网络计费类型。取值范围:BANDWIDTH_PREPAID:预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费BANDWIDTH_PACKAGE:带宽包用户默认取值:非带宽包用户默认与子机付费类型保持一致。 */ InternetChargeType?: string | null; /** 公网出带宽上限,单位:Mbps。默认值:0Mbps。不同机型带宽上限范围不一致,具体限制详见购买网络带宽。 */ InternetMaxBandwidthOut?: number | null; } /** 提交Job作业信息 */ declare interface Job { /** 任务配置信息。 */ Tasks: Task[]; /** 作业名称。 */ JobName?: string; /** 作业描述。 */ JobDescription?: string; /** 作业优先级,数值越大,优先级越高,数值范围1~100。 */ Priority?: number; /** 描述任务的依赖关系,DAG有向无环图。 */ TaskDependencies?: TaskDependence[]; } /** 作业概览信息 */ declare 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; } /** 登录节点信息。 */ declare interface LoginNode { /** 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID:预付费,即包年包月POSTPAID_BY_HOUR:按小时后付费SPOTPAID:竞价付费默认值:POSTPAID_BY_HOUR。 */ InstanceChargeType?: string; /** 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid; /** 节点机型。不同实例机型指定了不同的资源规格。具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。 */ InstanceType?: string; /** 节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。 */ SystemDisk?: SystemDisk; /** 节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。 */ DataDisks?: DataDisk[]; /** 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。 */ InternetAccessible?: InternetAccessible; /** 节点显示名称。不指定节点显示名称则默认显示‘未命名’。最多支持60个字符。 */ InstanceName?: string; /** 实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。 */ ProjectId?: number; } /** 登录节点概览。 */ declare interface LoginNodeOverview { /** 登录节点ID。 */ NodeId: string; } /** 描述了实例登录相关配置与信息。 */ declare interface LoginSettings { /** 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:Linux实例密码必须8到30位,至少包括两项[a-z],[A-Z]、[0-9] 和 [( ) \` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。Windows实例密码必须12到30位,至少包括三项[a-z],[A-Z],[0-9] 和 [( ) \` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数,则由系统随机生成密码,并通过站内信方式通知到用户。 */ Password?: string; /** 实例登录密钥 */ KeyIds?: string[]; } /** 管控节点信息 */ declare interface ManagerNode { /** 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID:预付费,即包年包月POSTPAID_BY_HOUR:按小时后付费SPOTPAID:竞价付费默认值:POSTPAID_BY_HOUR。 */ InstanceChargeType?: string; /** 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid; /** 节点机型。不同实例机型指定了不同的资源规格。 具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。 */ InstanceType?: string; /** 节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。 */ SystemDisk?: SystemDisk; /** 节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。 */ DataDisks?: DataDisk[]; /** 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为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`。 最多支持60个字符(包含模式串)。 */ InstanceName?: string; /** 实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。 */ ProjectId?: number; /** 增强服务。通过该参数可以指定是否开启云安全、腾讯云可观测平台等服务。若不指定该参数,则默认开启腾讯云可观测平台、云安全服务、自动化助手服务。 */ EnhancedService?: EnhancedService; } /** 管控节点概览。 */ declare interface ManagerNodeOverview { /** 管控节点ID。 */ NodeId?: string; } /** 节点活动信息。 */ declare interface NodeActivity { /** 节点活动所在的实例ID。 */ NodeInstanceId?: string | null; /** 节点活动状态。取值范围:RUNNING:运行中SUCCESSFUL:活动成功FAILED:活动失败 */ NodeActivityStatus?: string; /** 节点活动状态码。 */ NodeActivityStatusCode?: string | null; /** 节点活动状态原因。 */ NodeActivityStatusReason?: string | null; } /** 节点概览信息。 */ declare interface NodeOverview { /** 集群ID */ ClusterId?: string; /** 节点实例ID。 */ InstanceId?: string | null; /** 节点所在可用区信息。 */ Zone?: string | null; /** 节点状态。SUBMITTED:已完成提交。CREATING:创建中。CREATED:完成创建。INITING:初始化中。INIT_FAILED:初始化失败。RUNNING:运行中。DELETING:销毁中。 */ NodeState?: string | null; /** 镜像ID。 */ ImageId?: string | null; /** 节点所属队列名称。 */ QueueName?: string | null; /** 节点角色。Manager:管控节点。Compute:计算节点。Login:登录节点。ManagerBackup:备用管控节点。 */ NodeRole?: string | null; /** 节点类型。STATIC:静态节点。DYNAMIC:弹性节点。 */ NodeType?: string | null; /** thpc集群节点id */ NodeId?: string | null; /** 节点的工作状态 */ NodeAllocateState?: string; /** 节点的名称 */ NodeName?: string; /** 节点的创建时间 */ CreateTime?: string; } /** 描述节点执行脚本信息。 */ declare interface NodeScript { /** 节点执行脚本获取地址。目前仅支持cos地址。地址最大长度:255。 */ ScriptPath: string; /** 脚本执行超时时间(包含拉取脚本的时间)。单位秒,默认值:30。取值范围:10~1200。 */ Timeout?: number; } /** 输出重定向配置 */ declare interface OutputRedirect { /** 输出driver类型 */ Driver?: string; /** 重定向配置参数 */ Options?: string[]; } /** 描述了实例的抽象位置 */ declare interface Placement { /** 实例所属的可用区名称。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。 */ Zone: string | null; } /** 扩容队列配置。 */ declare interface QueueConfig { /** 队列名称。 */ QueueName: string; /** 队列中弹性节点数量最小值。默认值:0。取值范围:0~200。 */ MinSize?: number; /** 队列中弹性节点数量最大值。默认值:10。取值范围:0~200。 */ MaxSize?: number; /** 是否开启自动扩容。 */ EnableAutoExpansion?: boolean; /** 是否开启自动缩容。 */ EnableAutoShrink?: boolean; /** 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。目前仅支持公有镜和特定自定义镜像。 */ ImageId?: string; /** 节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。 */ SystemDisk?: SystemDisk; /** 节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。 */ DataDisks?: DataDisk[]; /** 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。 */ InternetAccessible?: InternetAccessible; /** 扩容节点配置信息。 */ ExpansionNodeConfigs?: ExpansionNodeConfig[]; /** 队列中期望的空闲节点数量(包含弹性节点和静态节点)。默认值:0。队列中,处于空闲状态的节点小于此值,集群会扩容弹性节点;处于空闲状态的节点大于此值,集群会缩容弹性节点。 */ DesiredIdleNodeCapacity?: number; /** 队列中期望的总节点数。 */ DesiredNodeCount?: number; /** 扩容比例。默认值:100。取值范围:1~100。如果扩容比例为50,那么每轮只会扩容当前作业负载所需的50%数量的节点。 */ ScaleOutRatio?: number; /** 比例扩容阈值。默认值:0。取值范围:0~200。当作业负载需要扩容节点数量大于此值,当前扩容轮次按照ScaleOutRatio配置的比例进行扩容。当作业负载需要扩容节点数量小于此值,当前扩容轮次扩容当前作业负载所需数量的节点。此参数配合ScaleOutRatio参数进行使用,用于比例扩容场景下,在作业负载所需节点数量较小时,加快收敛速度。 */ ScaleOutNodeThreshold?: number; /** 每轮扩容最大节点个数。默认值:100。取值范围:1~100。 */ MaxNodesPerCycle?: number; /** 扩容过程中,作业的内存在匹配实例机型时增大比例(不会影响作业提交的内存大小,只影响匹配计算过程)。针对场景:由于实例机型的总内存会大于实例内部的可用内存,16GB内存规格的实例,实例操作系统内的可用内存只有约14.9GB内存。假设此时提交一个需要15GB内存的作业,- 当ScaleUpMemRatio=0时,会匹配到16GB内存规格的实例,但是由于操作系统内的可用内存为14.9GB小于作业所需的15GB,扩容出来的实例作业无法运行起来。- 当ScaleUpMemRatio=10时,匹配实例规格会按照15*(1+10%)=16.5GB来进行实例规格匹配,则不会匹配到16GB的实例,而是更大内存规格的实例来保证作业能够被运行起来。 */ ScaleUpMemRatio?: number; /** 增强服务。通过该参数可以指定是否开启云安全、腾讯云可观测平台等服务。若不指定该参数,则默认开启腾讯云可观测平台、云安全服务、自动化助手服务。 */ EnhancedService?: EnhancedService; } /** 扩容队列配置概览。 */ declare interface QueueConfigOverview { /** 队列名称。 */ QueueName?: string; /** 队列中弹性节点数量最小值。取值范围0~200。 */ MinSize?: number; /** 队列中弹性节点数量最大值。取值范围0~200。 */ MaxSize?: number; /** 是否开启自动扩容。 */ EnableAutoExpansion?: boolean; /** 是否开启自动缩容。 */ EnableAutoShrink?: boolean; /** 扩容节点配置信息。 */ ExpansionNodeConfigs?: 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; } /** 队列信息概览。 */ declare interface QueueOverview { /** 队列名称。 */ QueueName?: string; } /** 描述了 “云自动化助手” 服务相关的信息。 */ declare interface RunAutomationServiceEnabled { /** 是否开启云自动化助手。取值范围:TRUE:表示开启云自动化助手服务FALSE:表示不开启云自动化助手服务默认取值:TRUE。 */ Enabled?: boolean; } /** 描述了 “腾讯云可观测平台” 服务相关的信息。 */ declare interface RunMonitorServiceEnabled { /** 是否开启[腾讯云可观测平台](/document/product/248)服务。取值范围:TRUE:表示开启腾讯云可观测平台服务FALSE:表示不开启腾讯云可观测平台服务默认取值:TRUE。 */ Enabled?: boolean; } /** 描述了 “云安全” 服务相关的信息。 */ declare interface RunSecurityServiceEnabled { /** 是否开启[云安全](/document/product/296)服务。取值范围:TRUE:表示开启云安全服务FALSE:表示不开启云安全服务默认取值:TRUE。 */ Enabled?: boolean; } /** 描述了工作空间的计费模式 */ declare interface SpaceChargePrepaid { /** 购买实例的时长,单位:月。取值范围:1, 2, 3, 12, 24, 36。默认取值为1。 */ Period?: number | null; /** 自动续费标识。取值范围:NOTIFY_AND_AUTO_RENEW:通知过期且自动续费NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。 */ RenewFlag?: string | null; } /** 工作空间数据盘配置 */ declare interface SpaceDataDisk { /** 数据盘类型。数据盘类型限制详见[存储概述](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_BSSD:通用型SSD云硬盘默认取值:LOCAL_BASIC。该参数对`ResizeInstanceDisk`接口无效。 */ DiskType?: string; /** 数据盘 */ DiskId?: string | null; /** 数据盘大小,单位:GB。最小调整步长为10G,不同数据盘类型取值范围不同,具体限制详见:[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0,表示不购买数据盘。更多限制详见产品文档。 */ DiskSize?: number; /** 数据盘是否随子机销毁。取值范围:TRUE:子机销毁时,销毁数据盘,只支持按小时后付费云盘 FALSE:子机销毁时,保留数据盘 默认取值:TRUE 该参数目前仅用于 `RunInstances` 接口。 */ DeleteWithInstance?: boolean | null; /** 数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。 */ SnapshotId?: string | null; /** 数据盘是加密。取值范围:true:加密 false:不加密 默认取值:false 该参数目前仅用于 `RunInstances` 接口。 */ Encrypt?: boolean | null; /** 自定义CMK对应的ID,取值为UUID或者类似kms-abcd1234。用于加密云盘。该参数目前仅用于 `CreateWorkspaces` 接口。 */ KmsKeyId?: string | null; /** 云硬盘性能,单位:MB/s */ ThroughputPerformance?: number | null; /** 突发性能注:内测中。 */ BurstPerformance?: boolean | null; } /** 描述工作空间的信息 */ declare interface SpaceInfo { /** 工作空间ID */ SpaceId?: string; /** 工作空间类型 */ SpaceFamily?: string; /** 工作空间规格 */ SpaceType?: string; /** 工作空间名称 */ SpaceName?: string; /** 工作空间状态。取值范围:PENDING:表示创建中LAUNCH_FAILED:表示创建失败ONLINE:表示运行中ARREARS:表示隔离中TERMINATING:表示销毁中。 */ SpaceState?: string; /** 工作空间计费模式 */ SpaceChargeType?: string; /** 工作空间对应资源ID */ ResourceId?: string; /** 自动续费标识 */ RenewFlag?: string; /** 工作空间关联的工作列表 */ Tags?: Tag[]; /** 创建时间 */ CreatedTime?: string; /** 到期时间 */ ExpiredTime?: string; /** 工作空间所在位置 */ Placement?: Placement; /** 工作空间的最新操作 */ LatestOperation?: string | null; /** 工作空间的最新操作状态 */ LatestOperationState?: string | null; } /** 描述了工作空间的公网可访问性,声明了工作空间的公网使用计费模式,最大带宽等 */ declare interface SpaceInternetAccessible { /** 网络计费类型 */ InternetChargeType?: string | null; /** 公网出带宽上限,默认为0 */ InternetMaxBandwidthOut?: number | null; /** 是否分配公网IP */ PublicIpAssigned?: boolean | null; /** 带宽包ID */ BandwidthPackageId?: string | null; } /** 描述了实例的抽象位置,包括其所在的可用区,所属的项目 */ declare interface SpacePlacement { /** 可用区 */ Zone: string; /** 项目,默认是0 */ ProjectId?: number; } /** 工作空间系统盘配置 */ declare interface SpaceSystemDisk { /** 系统盘类型。系统盘类型限制详见[存储概述](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云硬盘默认取值:当前有库存的硬盘类型。 */ DiskType?: string | null; /** 系统盘大小,单位:GB。默认值为 50 */ DiskSize?: number | null; } /** 描述了工作空间VPC相关信息,包括子网,IP信息等 */ declare interface SpaceVirtualPrivateCloud { /** 私有网络ID */ VpcId: string; /** 私有网络子网ID */ SubnetId: string; /** 是否用作公网网关 */ AsVpcGateway?: boolean; /** 私有网络子网 IP 数组 */ PrivateIpAddresses?: string[]; /** 为弹性网卡指定随机生成 */ Ipv6AddressCount?: number; } /** 存储目录挂载配置。 */ declare interface StorageMount { /** 挂载源 */ Source: string; /** 目标挂载位置 */ Target: string; /** 挂载的存储类型,目前仅支持:local */ StorageType?: string; } /** 描述集群文件系统选项 */ declare interface StorageOption { /** 集群挂载CFS文件系统选项。 */ CFSOptions?: CFSOption[]; /** 集群挂载GooseFS文件系统选项。 */ GooseFSOptions?: GooseFSOption[]; /** 集群挂载GooseFSx文件系统选项。 */ GooseFSxOptions?: GooseFSxOption[] | null; } /** 集群存储选项概览信息。 */ declare interface StorageOptionOverview { /** CFS存储选项概览信息列表。 */ CFSOptions: CFSOptionOverview[]; /** GooseFS存储选项概览信息列表。 */ GooseFSOptions: GooseFSOptionOverview[]; /** GooseFSx存储选项概览信息列表。 */ GooseFSxOptions?: GooseFSxOptionOverview[]; } /** 描述了操作系统所在块设备即系统盘的信息 */ declare interface SystemDisk { /** 系统盘类型。系统盘类型限制详见存储概述。取值范围:CLOUD_BASIC:普通云硬盘CLOUD_SSD:SSD云硬盘CLOUD_PREMIUM:高性能云硬盘默认取值:当前有库存的硬盘类型。 */ DiskType?: string | null; /** 系统盘大小,单位:GB。默认值为 50 */ DiskSize?: number | null; } /** 标签键值对。 */ declare interface Tag { /** 标签键 */ Key: string; /** 标签值 */ Value: string; } /** 创建资源工作空间时同时绑定的标签对说明 */ declare interface TagSpecification { /** 标签绑定的资源类型 */ ResourceType: string; /** 标签对列表 */ Tags: Tag[]; } /** 作业任务配置信息。 */ declare interface Task { /** 作业任务的应用环境配置信息。 */ Application: Application; /** 作业任务名称。 */ TaskName?: string; /** 作业任务所需的节点数/副本数。 */ TaskInstanceNum?: number; /** 任务超时时间(单位:秒)。 */ Timeout?: number; } /** 任务的依赖关系。 */ declare interface TaskDependence { /** 依赖关系的起点任务名称。 */ StartTask: string; /** 依赖关系的终点任务名称。 */ EndTask: string; } /** 描述了VPC相关信息 */ declare interface VirtualPrivateCloud { /** 私有网络ID,形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询;也可以调用接口 [DescribeVpcEx](/document/api/215/1372) ,从接口返回中的`unVpcId`字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`,则强制使用默认vpc网络。 */ VpcId: string | null; /** 私有网络子网ID,形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询;也可以调用接口 [DescribeSubnets](/document/api/215/15784) ,从接口返回中的`unSubnetId`字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`,则强制使用默认vpc网络。 */ SubnetId: string | null; } declare interface AddClusterStorageOptionRequest { /** 集群ID。 */ ClusterId: string; /** 集群存储选项;集群已存在的节点和新增节点都会挂载此存储。 */ StorageOption: StorageOption; } declare interface AddClusterStorageOptionResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface AddNodesRequest { /** 集群中实例所在的位置。 */ Placement: Placement; /** 集群ID。 */ ClusterId: string; /** 私有网络相关信息配置。 */ VirtualPrivateCloud: VirtualPrivateCloud; /** 添加节点数量。 */ Count: number; /** 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。目前支持部分公有镜像和自定义镜像。公共镜像请参考[镜像限制](https://cloud.tencent.com/document/product/1527/64818) */ ImageId?: string; /** 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID:预付费,即包年包月POSTPAID_BY_HOUR:按小时后付费SPOTPAID:竞价付费默认值:POSTPAID_BY_HOUR。 */ InstanceChargeType?: string; /** 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid; /** 节点机型。不同实例机型指定了不同的资源规格。具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。 */ InstanceType?: string; /** 节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。 */ SystemDisk?: SystemDisk; /** 节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。 */ DataDisks?: DataDisk[]; /** 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。 */ InternetAccessible?: InternetAccessible; /** 节点显示名称。不指定节点显示名称则默认显示‘未命名’。最多支持60个字符。 */ InstanceName?: string; /** 集群登录设置。 */ LoginSettings?: LoginSettings; /** 集群中实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。 */ SecurityGroupIds?: string[]; /** 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 */ ClientToken?: string; /** 队列名称。不指定则为默认队列。SLURM默认队列为:compute。 */ QueueName?: string; /** 添加节点角色。默认值:ComputeCompute:计算节点。Login:登录节点。 */ NodeRole?: string; /** 是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和云服务器库存。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.false(默认):发送正常请求,通过检查后直接创建实例 */ DryRun?: boolean; /** 添加节点类型。默认取值:STATIC。STATIC:静态节点,不会参与弹性伸缩流程。DYNAMIC:弹性节点,会被弹性缩容的节点。管控节点和登录节点不支持此参数。 */ NodeType?: string; /** 实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。 */ ProjectId?: number; /** 要新增节点的资源类型。CVM:CVM实例类型资源WORKSPACE:工作空间类型实例资源默认值:CVM。 */ ResourceType?: string; } declare interface AddNodesResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface AddQueueRequest { /** 集群ID。 */ ClusterId: string; /** 队列名称。最多支持32个字符。 */ QueueName: string; } declare interface AddQueueResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface AttachNodesRequest { /** 集群id */ ClusterId: string; /** 节点的实例id列表 */ ResourceSet: string[]; /** 队列名称。不指定则为默认队列:SLURM默认队列为:compute。 */ QueueName?: string; /** 指定有效的镜像ID,格式形如img-xxx。目前仅支持公有镜像和特定自定义镜像。如不指定,则该字段是默认镜像。 */ ImageId?: string; /** 要新增节点的资源类型。CVM:CVM实例类型资源WORKSPACE:工作空间类型实例资源默认值:CVM。 */ ResourceType?: string; } declare interface AttachNodesResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreateClusterRequest { /** 集群中实例所在的位置。 */ Placement: Placement; /** 指定管理节点。 */ ManagerNode?: ManagerNode; /** 指定管理节点的数量。默认取值:1。取值范围:1~2。 */ ManagerNodeCount?: number; /** 指定计算节点。 */ ComputeNode?: ComputeNode; /** 指定计算节点的数量。默认取值:0。 */ ComputeNodeCount?: number; /** 调度器类型。默认取值:SLURM。SLURM:SLURM调度器。 */ SchedulerType?: string; /** 创建调度器的版本号,可填写版本号为“latest” 和 各调度器支持的版本号;如果是"latest", 则代表创建的是平台当前支持的该类型调度器最新版本。如果不填写,默认创建的是“latest”版本调度器各调度器支持的集群版本:SLURM:21.08.8、23.11.7 */ SchedulerVersion?: string; /** 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。目前支持部分公有镜像和自定义镜像。公共镜像请参考[镜像限制](https://cloud.tencent.com/document/product/1527/64818) */ ImageId?: string; /** 私有网络相关信息配置。 */ VirtualPrivateCloud?: VirtualPrivateCloud; /** 集群登录设置。 */ LoginSettings?: LoginSettings; /** 集群中实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。 */ SecurityGroupIds?: string[]; /** 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 */ ClientToken?: string; /** 是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和云服务器库存。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.false(默认):发送正常请求,通过检查后直接创建实例 */ DryRun?: boolean; /** 域名字服务类型。默认取值:NIS。NIS:NIS域名字服务。 */ AccountType?: string; /** 集群显示名称。 */ ClusterName?: string; /** 集群存储选项 */ StorageOption?: StorageOption; /** 指定登录节点。 */ LoginNode?: LoginNode; /** 指定登录节点的数量。默认取值:0。取值范围:0~10。 */ LoginNodeCount?: number; /** 创建集群时同时绑定的标签对说明。 */ Tags?: Tag[]; /** 弹性伸缩类型。默认值:THPC_AS */ AutoScalingType?: string; /** 节点初始化脚本信息列表。 */ InitNodeScripts?: NodeScript[]; /** 高性能计算集群ID。若创建的实例为高性能计算实例,需指定实例放置的集群,否则不可指定。 */ HpcClusterId?: string; } declare interface CreateClusterResponse { /** 集群ID。 */ ClusterId?: string; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface CreateWorkspacesRequest { /** 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 */ ClientToken?: string; /** 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目,所属宿主机(在专用宿主机上创建子机时指定)等属性。 注:如果您不指定LaunchTemplate参数,则Placement为必选参数。若同时传递Placement和LaunchTemplate,则默认覆盖LaunchTemplate中对应的Placement的值。 */ Placement?: SpacePlacement; /** 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。 */ SpaceChargePrepaid?: SpaceChargePrepaid; /** 工作空间计费类型,包括:PREPAID,UNDERWRITE。工作空间计费类型,包括:PREPAID,UNDERWRITE。 */ SpaceChargeType?: string; /** 工作空间规格 */ SpaceType?: string; /** 镜像ID */ ImageId?: string; /** 工作空间系统盘信息 */ SystemDisk?: SpaceSystemDisk; /** 工作空间数据盘信息 */ DataDisks?: SpaceDataDisk[]; /** 私有网络相关信息 */ VirtualPrivateCloud?: SpaceVirtualPrivateCloud; /** 公网带宽相关信息设置 */ InternetAccessible?: SpaceInternetAccessible; /** 购买工作空间实例的数量 */ SpaceCount?: number; /** 工作空间显示名称 */ SpaceName?: string; /** 工作空间登陆设置 */ LoginSettings?: LoginSettings; /** 工作空间所属安全组 */ SecurityGroupIds?: string[]; /** 增强服务 */ EnhancedService?: EnhancedService; /** 是否只预检此次请求 */ DryRun?: boolean; /** 提供给工作空间使用的用户数据 */ UserData?: string; /** 置放群组id */ DisasterRecoverGroupIds?: string[]; /** 标签描述列表 */ TagSpecification?: TagSpecification[]; /** 高性能计算集群ID */ HpcClusterId?: string; /** CAM角色名称 */ CamRoleName?: string; /** 实例主机名。点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。Windows 实例:主机名名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。其他类型(Linux 等)实例:主机名字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。购买多台实例,如果指定模式串`{R:x}`,表示生成数字`[x, x+n-1]`,其中`n`表示购买实例的数量,例如`server{R:3}`,购买1台时,实例主机名为`server3`;购买2台时,实例主机名分别为`server3`,`server4`。支持指定多个模式串`{R:x}`。购买多台实例,如果不指定模式串,则在实例主机名添加后缀`1、2...n`,其中`n`表示购买实例的数量,例如`server`,购买2台时,实例主机名分别为`server1`,`server2`。 */ HostName?: string; } declare interface CreateWorkspacesResponse { /** 工作空间ID */ SpaceIdSet?: string[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DeleteClusterRequest { /** 集群ID。 */ ClusterId: string; } declare interface DeleteClusterResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DeleteClusterStorageOptionRequest { /** 集群ID。 */ ClusterId: string; /** 本地挂载路径。 */ LocalPath: string; } declare interface DeleteClusterStorageOptionResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DeleteJobRequest { /** 作业任务ID */ JobId: string; } declare interface DeleteJobResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DeleteNodesRequest { /** 集群ID。 */ ClusterId: string; /** 节点ID。 */ NodeIds: string[]; } declare interface DeleteNodesResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DeleteQueueRequest { /** 集群ID。 */ ClusterId: string; /** 队列名称。最多支持32个字符。 */ QueueName: string; } declare interface DeleteQueueResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeAutoScalingConfigurationRequest { /** 集群ID。 */ ClusterId: string; } declare interface DescribeAutoScalingConfigurationResponse { /** 集群ID。 */ ClusterId?: string; /** 任务连续等待时间,队列的任务处于连续等待的时间。单位秒。 */ ExpansionBusyTime?: number; /** 节点连续空闲(未运行作业)时间,一个节点连续处于空闲状态时间。 */ ShrinkIdleTime?: number; /** 扩容队列配置概览列表。 */ QueueConfigs?: QueueConfigOverview[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeClusterActivitiesRequest { /** 集群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; } declare interface DescribeClusterActivitiesResponse { /** 集群活动历史记录列表。 */ ClusterActivitySet?: ClusterActivity[]; /** 集群活动历史记录数量。 */ TotalCount?: number; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeClusterStorageOptionRequest { /** 集群ID。 */ ClusterId: string; } declare interface DescribeClusterStorageOptionResponse { /** 集群存储选项信息概览。 */ StorageOption?: StorageOptionOverview; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeClustersRequest { /** 集群ID列表。通过该参数可以指定需要查询信息的集群列表。如果您不指定该参数,则返回Limit数量以内的集群信息。 */ ClusterIds?: 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; /** cluster-type 按照【集群类型】进行过滤 类型:String 必选:否 每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。 */ Filters?: Filter[]; } declare interface DescribeClustersResponse { /** 集群概览信息列表。 */ ClusterSet?: ClusterOverview[]; /** 集群数量。 */ TotalCount?: number; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeInitNodeScriptsRequest { /** 集群ID。 */ ClusterId: string; } declare interface DescribeInitNodeScriptsResponse { /** 节点初始化脚本列表。 */ InitNodeScriptSet?: NodeScript[]; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeJobSubmitInfoRequest { /** 作业ID */ JobId: string; } declare interface DescribeJobSubmitInfoResponse { /** 集群ID */ ClusterId?: string; /** 队列名称 */ QueueName?: string; /** 作业信息 */ Job?: Job; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeJobsOverviewRequest { } declare interface DescribeJobsOverviewResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeJobsRequest { /** 作业任务ID列表 */ JobIds?: string[]; /** 过滤列表 */ Filters?: 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; } declare interface DescribeJobsResponse { /** 作业任务概览列表 */ JobSet?: JobView[]; /** 符合条件的作业任务数量。 */ TotalCount?: number; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeNodesRequest { /** 集群ID。 */ ClusterId?: string; /** queue-name 按照【队列名称】进行过滤。队列名称形如:compute。 类型:String 必选:否 node-role 按照【节点角色】进行过滤。节点角色形如:Manager。(Manager:管控节点。Compute:计算节点。Login:登录节点。ManagerBackup:备用管控节点。) 类型:String 必选:否 node-type 按照【节点类型】进行过滤。节点类型形如:STATIC。(STATIC:静态节点。DYNAMIC:弹性节点。) 类型:String 必选:否 每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。 */ Filters?: 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; } declare interface DescribeNodesResponse { /** 节点概览信息列表。 */ NodeSet?: NodeOverview[]; /** 符合条件的节点数量。 */ TotalCount?: number; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare 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; } declare interface DescribeQueuesResponse { /** 队列概览信息列表。 */ QueueSet?: QueueOverview[]; /** 符合条件的队列数量。 */ TotalCount?: number; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DescribeWorkspacesRequest { /** 集群ID列表。通过该参数可以指定需要查询信息的集群列表。如果您不指定该参数,则返回Limit数量以内的集群信息。 */ SpaceIds?: 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; /** zone 按照【可用区】进行过滤 类型:String 必选:否 space-id 按照【工作空间实例ID】进行过滤 类型:String 必选:否 cvm-instance-id 按照【CVM实例ID】进行过滤 类型:String 必选:否 space-state 按照【工作空间状态】进行过滤 类型:String 必选:否 space-name 按照【工作空间别名】进行过滤 类型:String 必选:否 space-charge-type 按照【工作空间实例付费模式】进行过滤 类型:String 必选:否 tag-key 按照【标签键】进行过滤 类型:String 必选:否 tag-value 按照【标签值】进行过滤 类型:String 必选:否 每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。 */ Filters?: Filter[]; } declare interface DescribeWorkspacesResponse { /** 集群概览信息列表 */ SpaceSet?: SpaceInfo[]; /** 集群数量 */ TotalCount?: number; /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface DetachNodesRequest { /** 集群id */ ClusterId: string; /** 集群中的节点id */ NodeIds: string[]; } declare interface DetachNodesResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ModifyInitNodeScriptsRequest { /** 集群ID。 */ ClusterId: string; /** 节点初始化脚本信息列表。 */ InitNodeScripts?: NodeScript[]; } declare interface ModifyInitNodeScriptsResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ModifyWorkspacesAttributeRequest { /** 工作空间列表 */ SpaceIds: string[]; /** 修改后的工作空间名称。可任意命名,但不得超过60个字符。 */ SpaceName?: string; } declare interface ModifyWorkspacesAttributeResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface ModifyWorkspacesRenewFlagRequest { /** 工作空间列表 */ SpaceIds: string[]; /** 自动续费标识。取值范围:NOTIFY_AND_AUTO_RENEW:通知过期且自动续费NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。 */ RenewFlag: string; } declare interface ModifyWorkspacesRenewFlagResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface SetAutoScalingConfigurationRequest { /** 集群ID。 */ ClusterId: string; /** 任务连续等待时间,队列的任务处于连续等待的时间。单位秒。默认值120。 */ ExpansionBusyTime?: number; /** 节点连续空闲(未运行作业)时间,一个节点连续处于空闲状态时间。单位秒。默认值300。 */ ShrinkIdleTime?: number; /** 扩容队列配置列表。 */ QueueConfigs?: QueueConfig[]; /** 是否只预检此次请求。true:发送检查请求,不会绑定弹性伸缩组。检查项包括是否填写了必需参数,请求格式,业务限制。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId。false(默认):发送正常请求,通过检查后直接绑定弹性伸缩组。 */ DryRun?: boolean; } declare interface SetAutoScalingConfigurationResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface SubmitJobRequest { } declare interface SubmitJobResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface TerminateJobRequest { /** 作业任务ID */ JobId: string; } declare interface TerminateJobResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare interface TerminateWorkspacesRequest { /** 工作空间ID */ SpaceIds: string[]; /** 释放空间挂载的包年包月数据盘。true表示销毁空间同时释放包年包月数据盘,false表示只销毁空间。 */ ReleasePrepaidDataDisks?: boolean; } declare interface TerminateWorkspacesResponse { /** 唯一请求 ID,每次请求都会返回。 */ RequestId?: string; } declare namespace V20220401 { type VersionHeader = { headers: { 'X-TC-Version': '2022-04-01' } } /** 描述CFS文件系统版本和挂载信息 */ interface CFSOption { /** 文件系统本地挂载路径。 */ LocalPath: string; /** 文件系统远程挂载ip及路径。 */ RemotePath: string; /** 文件系统协议类型,默认值NFS 3.0。NFS 3.0。NFS 4.0。TURBO。 */ Protocol?: string; /** 文件系统存储类型,默认值SD;其中 SD 为通用标准型标准型存储, HP为通用性能型存储, TB为turbo标准型, TP 为turbo性能型。 */ StorageType?: string; } /** CFS存储选项概览信息。 */ interface CFSOptionOverview { /** 文件系统本地挂载路径。 */ LocalPath: string; /** 文件系统远程挂载ip及路径。 */ RemotePath: string; /** 文件系统协议类型。NFS 3.0。NFS 4.0。TURBO。 */ Protocol: string; /** 文件系统存储类型,默认值SD;其中 SD 为通用标准型标准型存储, HP为通用性能型存储, TB为turbo标准型, TP 为turbo性能型。 */ StorageType: string; } /** 符合条件的集群活动信息。 */ interface ClusterActivity { /** 集群ID。 */ ClusterId?: string; /** 集群活动ID。 */ ActivityId?: string; /** 集群活动类型。取值范围:CreateAndAddNodes:创建实例并添加进集群RemoveNodesFromCluster:从集群移除实例TerminateNodes:销毁实例MountStorageOption:增加挂载选项并进行挂载UmountStorageOption:删除集群挂载存储选项并解挂载 */ ActivityType?: string; /** 集群活动状态。取值范围:PENDING:等待运行RUNNING:运行中SUCCESSFUL:活动成功PARTIALLY_SUCCESSFUL:活动部分成功FAILED:活动失败 */ ActivityStatus?: string; /** 集群活动状态码。 */ ActivityStatusCode?: string; /** 集群活动结果详情。 */ ResultDetail?: string | null; /** 集群活动起因。 */ Cause?: string; /** 集群活动描述。 */ Description?: string; /** 集群活动相关节点活动集合。 */ RelatedNodeActivitySet?: NodeActivity[]; /** 集群活动开始时间。 */ StartTime?: string; /** 集群活动结束时间。 */ EndTime?: string; } /** 集群概览信息。 */ interface ClusterOverview { /** 集群ID。 */ ClusterId?: string; /** 集群状态。取值范围:PENDING:创建中INITING:初始化中INIT_FAILED:初始化失败RUNNING:运行中TERMINATING:销毁中 */ ClusterStatus?: string; /** 集群名称。 */ ClusterName?: string; /** 集群位置信息。 */ Placement?: Placement; /** 集群创建时间。 */ CreateTime?: string; /** 集群调度器。 */ SchedulerType?: string; /** 计算节点数量。 */ ComputeNodeCount?: number; /** 计算节点概览。 */ ComputeNodeSet?: ComputeNodeOverview[]; /** 管控节点数量。 */ ManagerNodeCount?: number; /** 管控节点概览。 */ ManagerNodeSet?: ManagerNodeOverview[]; /** 登录节点概览。 */ LoginNodeSet?: LoginNodeOverview[]; /** 登录节点数量。 */ LoginNodeCount?: number; /** 集群所属私有网络ID。 */ VpcId?: string; } /** 计算节点信息。 */ interface ComputeNode { /** 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID:预付费,即包年包月POSTPAID_BY_HOUR:按小时后付费SPOTPAID:竞价付费默认值:POSTPAID_BY_HOUR。 */ InstanceChargeType?: string; /** 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid; /** 节点机型。不同实例机型指定了不同的资源规格。具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。 */ InstanceType?: string; /** 节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。 */ SystemDisk?: SystemDisk; /** 节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。 */ DataDisks?: DataDisk[]; /** 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。 */ InternetAccessible?: InternetAccessible; /** 节点显示名称。不指定节点显示名称则默认显示‘未命名’。最多支持60个字符。 */ InstanceName?: string; } /** 计算节点概览。 */ interface ComputeNodeOverview { /** 计算节点ID。 */ NodeId?: string; } /** 描述了数据盘的信息 */ interface DataDisk { /** 数据盘大小,单位:GB。最小调整步长为10G,不同数据盘类型取值范围不同,具体限制详见:[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0,表示不购买数据盘。更多限制详见产品文档。 */ DiskSize: number; /** 数据盘类型。数据盘类型限制详见[存储概述](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云硬盘默认取值:LOCAL_BASIC。 */ DiskType?: string; } /** 弹性扩容节点配置信息。 */ interface ExpansionNodeConfig { /** 扩容实例所在的位置。 */ Placement: Placement; /** 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID:预付费,即包年包月POSTPAID_BY_HOUR:按小时后付费SPOTPAID:竞价付费默认值:POSTPAID_BY_HOUR。 */ InstanceChargeType?: string; /** 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid; /** 节点机型。不同实例机型指定了不同的资源规格。 具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。 */ InstanceType?: string; /** 私有网络相关信息配置。 */ VirtualPrivateCloud?: VirtualPrivateCloud; } /** 扩容节点配置信息概览。 */ interface ExpansionNodeConfigOverview { /** 节点机型。 */ InstanceType?: string | null; /** 扩容实例所在的位置。 */ Placement?: Placement | null; /** 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。 */ InstanceChargeType?: string | null; /** 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid | null; /** 私有网络相关信息配置。 */ VirtualPrivateCloud?: VirtualPrivateCloud | null; /** 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。 */ ImageId?: string | null; /** 公网带宽相关信息设置。 */ InternetAccessible?: InternetAccessible | null; /** 节点系统盘配置信息。 */ SystemDisk?: SystemDisk | null; /** 节点数据盘配置信息。 */ DataDisks?: DataDisk[] | null; } /** >描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等> * 若存在多个`Filter`时,`Filter`间的关系为逻辑与(`AND`)关系。> * 若同一个`Filter`存在多个`Values`,同一`Filter`下`Values`间的关系为逻辑或(`OR`)关系。 */ interface Filter { /** 需要过滤的字段。 */ Name: string; /** 字段的过滤值。 */ Values: string[]; } /** 描述GooseFS挂载信息 */ interface GooseFSOption { /** 文件系统本地挂载路径。 */ LocalPath: string; /** 文件系统远程挂载路径。 */ RemotePath: string; /** 文件系统master的ip和端口。 */ Masters: string[]; } /** GooseFS存储选项概览信息。 */ interface GooseFSOptionOverview { /** 文件系统本地挂载路径。 */ LocalPath?: string; /** 文件系统远程挂载路径。 */ RemotePath?: string; /** 文件系统master的ip和端口。 */ Masters?: string[]; } /** 描述了实例的计费模式 */ interface InstanceChargePrepaid { /** 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。 */ Period: number; /** 自动续费标识。取值范围:NOTIFY_AND_AUTO_RENEW:通知过期且自动续费NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。 */ RenewFlag?: string; } /** 描述了实例的公网可访问性,声明了实例的公网使用计费模式,最大带宽等 */ interface InternetAccessible { /** 网络计费类型。取值范围:BANDWIDTH_PREPAID:预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费BANDWIDTH_PACKAGE:带宽包用户默认取值:非带宽包用户默认与子机付费类型保持一致。 */ InternetChargeType?: string; /** 公网出带宽上限,单位:Mbps。默认值:0Mbps。不同机型带宽上限范围不一致,具体限制详见购买网络带宽。 */ InternetMaxBandwidthOut?: number; } /** 登录节点信息。 */ interface LoginNode { /** 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID:预付费,即包年包月POSTPAID_BY_HOUR:按小时后付费SPOTPAID:竞价付费默认值:POSTPAID_BY_HOUR。 */ InstanceChargeType?: string; /** 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid; /** 节点机型。不同实例机型指定了不同的资源规格。 具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。 */ InstanceType?: string; /** 节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。 */ SystemDisk?: SystemDisk[]; /** 节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。 */ DataDisks?: DataDisk[]; /** 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。 */ InternetAccessible?: InternetAccessible[]; /** 节点显示名称。 不指定节点显示名称则默认显示‘未命名’。 最多支持60个字符。 */ InstanceName?: string; } /** 登录节点概览。 */ interface LoginNodeOverview { /** 登录节点ID。 */ NodeId: string; } /** 描述了实例登录相关配置与信息。 */ interface LoginSettings { /** 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:Linux实例密码必须8到30位,至少包括两项[a-z],[A-Z]、[0-9] 和 [( ) \` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。Windows实例密码必须12到30位,至少包括三项[a-z],[A-Z],[0-9] 和 [( ) \` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数,则由系统随机生成密码,并通过站内信方式通知到用户。 */ Password?: string; } /** 管控节点信息 */ interface ManagerNode { /** 节点[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID:预付费,即包年包月POSTPAID_BY_HOUR:按小时后付费SPOTPAID:竞价付费默认值:POSTPAID_BY_HOUR。 */ InstanceChargeType?: string; /** 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。 */ InstanceChargePrepaid?: InstanceChargePrepaid; /** 节点机型。不同实例机型指定了不同的资源规格。 具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。 */ InstanceType?: string; /** 节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。 */ SystemDisk?: SystemDisk; /** 节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。 */ DataDisks?: DataDisk[]; /** 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为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`。 最多支持60个字符(包含模式串)。 */ InstanceName?: string; } /** 管控节点概览。 */ interface ManagerNodeOverview { /** 管控节点ID。 */ NodeId?: string; } /** 节点活动信息。 */ interface NodeActivity { /** 节点活动所在的实例ID。 */ NodeInstanceId?: string | null;