API 中心
开发与运维产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>高性能计算平台>数据结构

数据结构

最近更新时间：2025-02-14 02:04:01

我的收藏

本页目录：

CFSOption

描述CFS文件系统版本和挂载信息

被如下接口引用：AddClusterStorageOption, CreateCluster。

名称 类型 必选 描述
LocalPath String 是 文件系统本地挂载路径。
示例值：/data/
RemotePath String 是 文件系统远程挂载ip及路径。
示例值：172.0.0.1:/
Protocol String 否 文件系统协议类型，默认值NFS 3.0。
  • NFS 3.0。
  • NFS 4.0。
  • TURBO。
    示例值：NFS 3.0
    		•
    StorageType String 否 文件系统存储类型，默认值SD；其中 SD 为通用标准型标准型存储， HP为通用性能型存储， TB为turbo标准型， TP 为turbo性能型。
    示例值：SD
    MountOption String 否 文件系统挂载挂载命令参数选项。

    - NFS 3.0默认值：vers=3,nolock,proto=tcp,noresvport
    - NFS 4.0默认值：vers=4.0,noresvport
    - TURBO默认值：user_xattr
    示例值：vers=4.0,noresvport

    CFSOptionOverview

    CFS存储选项概览信息。

    被如下接口引用：DescribeClusterStorageOption。

    名称 类型 描述
    LocalPath String 文件系统本地挂载路径。
    示例值：/data/
    RemotePath String 文件系统远程挂载ip及路径。
    示例值：172.0.0.1:/
    Protocol String 文件系统协议类型。
  • NFS 3.0。
  • NFS 4.0。
  • TURBO。
    示例值：NFS 3.0
    		•
    StorageType String 文件系统存储类型，默认值SD；其中 SD 为通用标准型标准型存储， HP为通用性能型存储， TB为turbo标准型， TP 为turbo性能型。
    示例值：SD
    MountOption String 文件系统挂载命令参数选项。
    示例值：vers=3,nolock,proto=tcp,noresvport

    ClusterActivity

    符合条件的集群活动信息。

    被如下接口引用：DescribeClusterActivities。

    名称 类型 描述
    ClusterId String 集群ID。
    示例值：hpc-myd8fgsc
    ActivityId String 集群活动ID。
    示例值：cha-gvzj0zbd
    ActivityType String 集群活动类型。取值范围：
  • CreateAndAddNodes：创建实例并添加进集群

  • RemoveNodesFromCluster：从集群移除实例

  • TerminateNodes：销毁实例

  • MountStorageOption：增加挂载选项并进行挂载

  • UmountStorageOption：删除集群挂载存储选项并解挂载

    • 示例值：TerminateNodes
    ActivityStatus String 集群活动状态。取值范围：
  • PENDING：等待运行

  • RUNNING：运行中

  • SUCCESSFUL：活动成功

  • PARTIALLY_SUCCESSFUL：活动部分成功

  • FAILED：活动失败

    • 示例值：SUCCESSFUL
    ActivityStatusCode String 集群活动状态码。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：ActivitySuccess
    ResultDetail String 集群活动结果详情。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：Activity success.
    Cause String 集群活动起因。
    示例值：DeleteCluster
    Description String 集群活动描述。
    示例值：删除指定集群，销毁实例，销毁所有节点。
    RelatedNodeActivitySet Array of NodeActivity 集群活动相关节点活动集合。
    示例值：[{"NodeInstanceId":"ins-1zll2of0","NodeActivityStatus":"SUCCESSFUL"}]
    StartTime Timestamp ISO8601 集群活动开始时间。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：2021-11-01T02:17:20Z
    EndTime Timestamp ISO8601 集群活动结束时间。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：2021-11-01T02:17:38Z

    ClusterOverview

    集群概览信息。

    被如下接口引用：DescribeClusters。

    名称 类型 描述
    ClusterId String 集群ID。
    示例值：hpc-2mv1i3d8
    ClusterStatus String 集群状态。取值范围：
  • PENDING：创建中
  • INITING：初始化中
  • INIT_FAILED：初始化失败
  • RUNNING：运行中
  • TERMINATING：销毁中

    • 示例值：RUNNING
    ClusterName String 集群名称。
    示例值：hpc-test
    Placement Placement 集群位置信息。
    示例值：{ "Zone": "ap-guangzhou-6" }
    CreateTime Timestamp ISO8601 集群创建时间。
    示例值：2024-12-18T13:46:34Z
    SchedulerType String 集群调度器。
    示例值：SGE
    SchedulerVersion String 集群调度器版本。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：21.08.8
    ComputeNodeCount Integer 计算节点数量。
    示例值：1
    ComputeNodeSet Array of ComputeNodeOverview 计算节点概览。
    示例值：[{"NodeId":"ins-riredadfj6"},{"NodeId":"ins-mdafdsai"},{"NodeId":"ins-5icofadac"},{"NodeId":"ins-icfdadfy"}]
    ManagerNodeCount Integer 管控节点数量。
    示例值：1
    ManagerNodeSet Array of ManagerNodeOverview 管控节点概览。
    示例值：[{"NodeId":"node-rirfdafa"}]
    LoginNodeSet Array of LoginNodeOverview 登录节点概览。
    示例值：[{"NodeId":"ins-riredadfj6"},{"NodeId":"ins-mdafdsai"},{"NodeId":"ins-5icofadac"},{"NodeId":"ins-icfdadfy"}]
    LoginNodeCount Integer 登录节点数量。
    示例值：1
    AutoScalingType String 弹性伸缩类型。
    示例值：THPC_AS
    VpcId String 集群所属私有网络ID。
    示例值：vpc-r9fr2jzy

    ComputeNode

    计算节点信息。

    被如下接口引用：CreateCluster。

    名称 类型 必选 描述
    InstanceChargeType String 否 节点计费类型。
  • PREPAID：预付费，即包年包月
  • POSTPAID_BY_HOUR：按小时后付费
  • SPOTPAID：竞价付费
    • 默认值：POSTPAID_BY_HOUR。
    示例值：POSTPAID_BY_HOUR
    InstanceChargePrepaid InstanceChargePrepaid 否 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。
    示例值：{"Period":1,"RenewFlag":"NOTIFY_AND_AUTO_RENEW"}
    InstanceType String 否 节点机型。不同实例机型指定了不同的资源规格。
  • 具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表或参见实例规格描述。

    • 示例值：S2.SMALL2
    SystemDisk SystemDisk 否 节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。
    示例值：{"DiskSize":50,"DiskType":"CLOUD_PREMIUM","DiskBackupQuota":1}
    DataDisks Array of DataDisk 否 节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
    示例值：[{"DiskSize":50,"DiskType":"CLOUD_PREMIUM","DiskBackupQuota":1}]
    InternetAccessible InternetAccessible 否 公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。
    示例值：{"PublicIpAssigned":true,"InternetMaxBandwidthOut":5}
    InstanceName String 否 节点显示名称。
  • 不指定节点显示名称则默认显示‘未命名’。
    最多支持60个字符。

    • 示例值：未命名
    ProjectId Integer 否 实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。
    示例值：0
    ResourceType String 否 实例资源类型，默认是CVM资源
    示例值：CVM

    ComputeNodeOverview

    计算节点概览。

    被如下接口引用：DescribeClusters。

    名称 类型 描述
    NodeId String 计算节点ID。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：ins-jfhc307q

    DataDisk

    描述了数据盘的信息

    被如下接口引用：AddNodes, CreateCluster, DescribeAutoScalingConfiguration, SetAutoScalingConfiguration。

    名称 类型 必选 描述
    DiskSize Integer 是 数据盘大小，单位：GB。最小调整步长为10G，不同数据盘类型取值范围不同，具体限制详见：存储概述。默认值为0，表示不购买数据盘。更多限制详见产品文档。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：0
    DiskType String 否 数据盘类型。数据盘类型限制详见存储概述。取值范围：
  • LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定
  • LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定
  • CLOUD_BASIC：普通云硬盘
  • CLOUD_PREMIUM：高性能云硬盘
  • CLOUD_SSD：SSD云硬盘
  • CLOUD_HSSD：增强型SSD云硬盘
  • CLOUD_TSSD：极速型SSD云硬盘
  • CLOUD_BSSD：通用型SSD云硬盘
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：CLOUD_BASIC
    		•

    EnhancedService

    描述了实例的增强服务启用情况与其设置，如云安全，腾讯云可观测平台等实例 Agent

    被如下接口引用：CreateCluster, CreateWorkspaces, SetAutoScalingConfiguration。

    名称 类型 必选 描述
    SecurityService RunSecurityServiceEnabled 否 开启云安全服务。若不指定该参数，则默认开启云安全服务。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：TRUE
    MonitorService RunMonitorServiceEnabled 否 开启腾讯云可观测平台服务。若不指定该参数，则默认开启腾讯云可观测平台服务。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：TRUE
    AutomationService RunAutomationServiceEnabled 否 开启云自动化助手服务（TencentCloud Automation Tools，TAT）。若不指定该参数，默认开启云自动化助手服务。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：TRUE

    ExpansionNodeConfig

    弹性扩容节点配置信息。

    被如下接口引用：SetAutoScalingConfiguration。

    名称 类型 必选 描述
    Placement Placement 是 扩容实例所在的位置。
    示例值：{"Zone": "ap-guangzhou-1"}
    InstanceChargeType String 否 节点计费类型。
  • PREPAID：预付费，即包年包月

  • POSTPAID_BY_HOUR：按小时后付费

  • SPOTPAID：竞价付费
    默认值：POSTPAID_BY_HOUR。

    • 示例值：POSTPAID_BY_HOUR
    InstanceChargePrepaid InstanceChargePrepaid 否 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。
    示例值：{"Period":1,"RenewFlag":"NOTIFY_AND_AUTO_RENEW"}
    InstanceType String 否 节点机型。不同实例机型指定了不同的资源规格。

  • 具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表或参见实例规格描述。

    • 示例值：S2.SMALL2
    VirtualPrivateCloud VirtualPrivateCloud 否 私有网络相关信息配置。
    示例值：{"VpcId": "vpc-xxx", "SubnetId": "subnet-xxx"}
    ProjectId Integer 否 实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。
    示例值：0

    ExpansionNodeConfigOverview

    扩容节点配置信息概览。

    被如下接口引用：DescribeAutoScalingConfiguration。

    名称 类型 描述
    InstanceType String 节点机型。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：S2.SMALL2
    Placement Placement 扩容实例所在的位置。
    注意：此字段可能返回 null，表示取不到有效值。
    InstanceChargeType String 节点计费类型。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：POSTPAID_BY_HOUR
    InstanceChargePrepaid InstanceChargePrepaid 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。
    注意：此字段可能返回 null，表示取不到有效值。
    VirtualPrivateCloud VirtualPrivateCloud 私有网络相关信息配置。
    注意：此字段可能返回 null，表示取不到有效值。
    ImageId String 指定有效的镜像ID，格式形如img-xxx。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：img-3la7wgnt
    InternetAccessible InternetAccessible 公网带宽相关信息设置。
    注意：此字段可能返回 null，表示取不到有效值。
    SystemDisk SystemDisk 节点系统盘配置信息。
    注意：此字段可能返回 null，表示取不到有效值。
    DataDisks Array of DataDisk 节点数据盘配置信息。
    注意：此字段可能返回 null，表示取不到有效值。

    Filter

    描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等

    • 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。
    • 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

    被如下接口引用：DescribeNodes, DescribeWorkspaces。

    名称 类型 必选 描述
    Name String 是 需要过滤的字段。
    示例值：fiter-name
    Values Array of String 是 字段的过滤值。
    示例值：fiter-value

    GooseFSOption

    描述GooseFS挂载信息

    被如下接口引用：AddClusterStorageOption, CreateCluster。

    名称 类型 必选 描述
    LocalPath String 是 文件系统本地挂载路径。
    示例值：/data
    RemotePath String 是 文件系统远程挂载路径。
    示例值：/data/goosefs-fuse
    Masters Array of String 是 文件系统master的ip和端口。
    示例值：["172.16.0.2:55533","172.16.0.3:55533","172.16.0.4:55533"]

    GooseFSOptionOverview

    GooseFS存储选项概览信息。

    被如下接口引用：DescribeClusterStorageOption。

    名称 类型 描述
    LocalPath String 文件系统本地挂载路径。
    示例值：/data/
    RemotePath String 文件系统远程挂载路径。
    示例值：/data/goosefs-fuse/
    Masters Array of String 文件系统master的ip和端口。
    示例值：["172.16.0.2:55533","172.16.0.3:55533","172.16.0.4:55533"]

    GooseFSxOption

    描述GooseFSx挂载信息

    被如下接口引用：AddClusterStorageOption, CreateCluster。

    名称 类型 必选 描述
    Masters Array of String 是 文件系统master的ip和端口列表。
    示例值：["172.16.0.2:55533","172.16.0.3:55533","172.16.0.4:55533"]
    LocalPath String 是 文件系统的本地挂载路径。GooseFSx目前只支持挂载在/goosefsx/{文件系统ID}_proxy/目录下。
    示例值：/goosefsx/x_c60_54oi5id3_proxy/

    GooseFSxOptionOverview

    GooseFSx存储选项概览信息。

    被如下接口引用：DescribeClusterStorageOption。

    名称 类型 描述
    Masters Array of String 文件系统master的ip和端口列表。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：["172.16.0.2:55533","172.16.0.3:55533","172.16.0.4:55533"]
    LocalPath String 文件系统的本地挂载路径。GooseFSx目前只支持挂载在/goosefsx/{文件系统ID}_proxy/目录下。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：/goosefsx/x_c60_54oi5id3_proxy/

    InstanceChargePrepaid

    描述了实例的计费模式

    被如下接口引用：AddNodes, CreateCluster, DescribeAutoScalingConfiguration, SetAutoScalingConfiguration。

    名称 类型 必选 描述
    Period Integer 是 购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：1
    RenewFlag String 否 自动续费标识。取值范围：
    NOTIFY_AND_AUTO_RENEW：通知过期且自动续费
    NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费
    DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费

    默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：NOTIFY_AND_AUTO_RENEW

    InternetAccessible

    描述了实例的公网可访问性，声明了实例的公网使用计费模式，最大带宽等

    被如下接口引用：AddNodes, CreateCluster, DescribeAutoScalingConfiguration, SetAutoScalingConfiguration。

    名称 类型 必选 描述
    InternetChargeType String 否 网络计费类型。取值范围：
    BANDWIDTH_PREPAID：预付费按带宽结算
    TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费
    BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费
    BANDWIDTH_PACKAGE：带宽包用户
    默认取值：非带宽包用户默认与子机付费类型保持一致。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：TRAFFIC_POSTPAID_BY_HOUR
    InternetMaxBandwidthOut Integer 否 公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见购买网络带宽。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：0

    LoginNode

    登录节点信息。

    被如下接口引用：CreateCluster。

    名称 类型 必选 描述
    InstanceChargeType String 否 节点计费类型。
  • PREPAID：预付费，即包年包月

  • POSTPAID_BY_HOUR：按小时后付费

  • SPOTPAID：竞价付费
    默认值：POSTPAID_BY_HOUR。

    • 示例值：POSTPAID_BY_HOUR
    InstanceChargePrepaid InstanceChargePrepaid 否 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。
    示例值：{"Period":1,"RenewFlag":"NOTIFY_AND_AUTO_RENEW"}
    InstanceType String 否 节点机型。不同实例机型指定了不同的资源规格。

  • 具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表或参见实例规格描述。

    • 示例值：S2.SMALL2
    SystemDisk SystemDisk 否 节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。
    示例值：{"DiskSize":50,"DiskType":"CLOUD_PREMIUM","DiskBackupQuota":1}
    DataDisks Array of DataDisk 否 节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
    示例值：[{"DiskSize":50,"DiskType":"CLOUD_PREMIUM","DiskBackupQuota":1}]
    InternetAccessible InternetAccessible 否 公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。
    示例值：{"PublicIpAssigned":true,"InternetMaxBandwidthOut":5}
    InstanceName String 否 节点显示名称。

  • 不指定节点显示名称则默认显示‘未命名’。
    最多支持60个字符。

    • 示例值：未命名
    ProjectId Integer 否 实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。
    示例值：0

    LoginNodeOverview

    登录节点概览。

    被如下接口引用：DescribeClusters。

    名称 类型 描述
    NodeId String 登录节点ID。
    示例值：ins-jfhc307q

    LoginSettings

    描述了实例登录相关配置与信息。

    被如下接口引用：AddNodes, CreateCluster, CreateWorkspaces。

    名称 类型 必选 描述
    Password String 否 实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：
  • Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) ` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。

  • Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) ` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。


    • 若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到用户。
    示例值：test@123456
    KeyIds Array of String 否 实例登录密钥
    示例值：sky-xxx

    ManagerNode

    管控节点信息

    被如下接口引用：CreateCluster。

    名称 类型 必选 描述
    InstanceChargeType String 否 节点计费类型。
  • PREPAID：预付费，即包年包月

  • POSTPAID_BY_HOUR：按小时后付费

  • SPOTPAID：竞价付费
    默认值：POSTPAID_BY_HOUR。

    • 示例值：POSTPAID_BY_HOUR
    InstanceChargePrepaid InstanceChargePrepaid 否 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。
    示例值：{"Period":1,"RenewFlag":"NOTIFY_AND_AUTO_RENEW"}
    InstanceType String 否 节点机型。不同实例机型指定了不同的资源规格。
  • 具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表或参见实例规格描述。

    • 示例值：S2.SMALL2
    SystemDisk SystemDisk 否 节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。
    示例值：{"DiskSize":50,"DiskType":"CLOUD_PREMIUM","DiskBackupQuota":1}
    DataDisks Array of DataDisk 否 节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
    示例值：[{"DiskSize":50,"DiskType":"CLOUD_PREMIUM","DiskBackupQuota":1}]
    InternetAccessible InternetAccessible 否 公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。
    示例值：{"PublicIpAssigned":true,"InternetMaxBandwidthOut":5}
    InstanceName String 否 节点显示名称。
  • 不指定节点显示名称则默认显示‘未命名’。
  • 购买多个节点，如果指定模式串{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个字符（包含模式串）。

    • 示例值：未命名
    ProjectId Integer 否 实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。
    示例值：0
    EnhancedService EnhancedService 否 增强服务。通过该参数可以指定是否开启云安全、腾讯云可观测平台等服务。若不指定该参数，则默认开启腾讯云可观测平台、云安全服务、自动化助手服务。
    示例值：{"SecurityService":{"Enabled":true},"MonitorService":{"Enabled":true},"AutomationService":{"Enabled":true}}

    ManagerNodeOverview

    管控节点概览。

    被如下接口引用：DescribeClusters。

    名称 类型 描述
    NodeId String 管控节点ID。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：ins-jfhc307q

    NodeActivity

    节点活动信息。

    被如下接口引用：DescribeClusterActivities。

    名称 类型 描述
    NodeInstanceId String 节点活动所在的实例ID。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：ins-1zll2of0
    NodeActivityStatus String 节点活动状态。取值范围：
  • RUNNING：运行中

  • SUCCESSFUL：活动成功

  • FAILED：活动失败

    • 示例值：SUCCESSFUL
    NodeActivityStatusCode String 节点活动状态码。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：ActivitySuccess
    NodeActivityStatusReason String 节点活动状态原因。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：Activity success.

    NodeOverview

    节点概览信息。

    被如下接口引用：DescribeNodes。

    名称 类型 描述
    InstanceId String 节点实例ID。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：ins-f5ew7k5w
    Zone String 节点所在可用区信息。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：ap-chongqing-1
    NodeState String 节点状态。
  • SUBMITTED：已完成提交。
  • CREATING：创建中。
  • CREATED：完成创建。
  • INITING：初始化中。
  • INIT_FAILED：初始化失败。
  • RUNNING：运行中。
  • DELETING：销毁中。

    • 注意：此字段可能返回 null，表示取不到有效值。
    示例值：RUNNING
    ImageId String 镜像ID。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：img-l8og963d
    QueueName String 节点所属队列名称。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：compute
    NodeRole String 节点角色。
  • Manager：管控节点。
  • Compute：计算节点。
  • Login：登录节点。
  • ManagerBackup：备用管控节点。

    • 注意：此字段可能返回 null，表示取不到有效值。
    示例值：Compute
    NodeType String 节点类型。
  • STATIC：静态节点。
  • DYNAMIC：弹性节点。

    • 注意：此字段可能返回 null，表示取不到有效值。
    示例值：STATIC
    NodeId String thpc集群节点id
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：node-2sh754ah

    NodeScript

    描述节点执行脚本信息。

    被如下接口引用：CreateCluster, DescribeInitNodeScripts, ModifyInitNodeScripts。

    名称 类型 必选 描述
    ScriptPath String 是 节点执行脚本获取地址。
    目前仅支持cos地址。地址最大长度：255。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：cos://demo-xxxxxxxx.cos.ap-guangzhou.myqcloud.com/test/echo.sh
    Timeout Integer 否 脚本执行超时时间（包含拉取脚本的时间）。单位秒，默认值：30。取值范围：10～1200。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：30

    Placement

    描述了实例的抽象位置

    被如下接口引用：AddNodes, CreateCluster, DescribeAutoScalingConfiguration, DescribeClusters, DescribeWorkspaces, SetAutoScalingConfiguration。

    名称 类型 必选 描述
    Zone String 是 实例所属的可用区名称。该参数可以通过调用 DescribeZones 的返回值中的Zone字段来获取。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：ap-guangzhou-1

    QueueConfig

    扩容队列配置。

    被如下接口引用：SetAutoScalingConfiguration。

    名称 类型 必选 描述
    QueueName String 是 队列名称。
    示例值：compute
    MinSize Integer 否 队列中弹性节点数量最小值。默认值：0。取值范围：0～200。
    示例值：0
    MaxSize Integer 否 队列中弹性节点数量最大值。默认值：10。取值范围：0～200。
    示例值：10
    EnableAutoExpansion Boolean 否 是否开启自动扩容。
    示例值：False
    EnableAutoShrink Boolean 否 是否开启自动缩容。
    示例值：False
    ImageId String 否 指定有效的镜像ID，格式形如img-xxx。目前仅支持公有镜和特定自定义镜像。
    示例值：ins-jfhc307q
    SystemDisk SystemDisk 否 节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。
    示例值：{ "DiskSize": 50 }
    DataDisks Array of DataDisk 否 节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
    示例值：[ { "DiskSize": 50, "DiskType": "CLOUD_PREMIUM" } ]
    InternetAccessible InternetAccessible 否 公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。
    示例值：{ "PublicIpAssigned": "false" }
    ExpansionNodeConfigs Array of ExpansionNodeConfig 否 扩容节点配置信息。
    示例值：{"Placement": "ap-guangzhou-6"}
    DesiredIdleNodeCapacity Integer 否 队列中期望的空闲节点数量（包含弹性节点和静态节点）。默认值：0。队列中，处于空闲状态的节点小于此值，集群会扩容弹性节点；处于空闲状态的节点大于此值，集群会缩容弹性节点。
    示例值：5
    DesiredNodeCount Integer 否 队列中期望的总节点数。
    示例值：1
    ScaleOutRatio Integer 否 扩容比例。默认值：100。取值范围：1～100。
    如果扩容比例为50，那么每轮只会扩容当前作业负载所需的50%数量的节点。
    示例值：50
    ScaleOutNodeThreshold Integer 否 比例扩容阈值。默认值：0。取值范围：0～200。
    当作业负载需要扩容节点数量大于此值，当前扩容轮次按照ScaleOutRatio配置的比例进行扩容。当作业负载需要扩容节点数量小于此值，当前扩容轮次扩容当前作业负载所需数量的节点。
    此参数配合ScaleOutRatio参数进行使用，用于比例扩容场景下，在作业负载所需节点数量较小时，加快收敛速度。
    示例值：0
    MaxNodesPerCycle Integer 否 每轮扩容最大节点个数。默认值：100。取值范围：1～100。
    示例值：10
    ScaleUpMemRatio Integer 否 扩容过程中，作业的内存在匹配实例机型时增大比例（不会影响作业提交的内存大小，只影响匹配计算过程）。

    针对场景：由于实例机型的总内存会大于实例内部的可用内存，16GB内存规格的实例，实例操作系统内的可用内存只有约14.9GB内存。假设此时提交一个需要15GB内存的作业，

    - 当ScaleUpMemRatio=0时，会匹配到16GB内存规格的实例,但是由于操作系统内的可用内存为14.9GB小于作业所需的15GB，扩容出来的实例作业无法运行起来。
    - 当ScaleUpMemRatio=10时，匹配实例规格会按照15*(1+10%)=16.5GB来进行实例规格匹配，则不会匹配到16GB的实例，而是更大内存规格的实例来保证作业能够被运行起来。
    示例值：0
    EnhancedService EnhancedService 否 增强服务。通过该参数可以指定是否开启云安全、腾讯云可观测平台等服务。若不指定该参数，则默认开启腾讯云可观测平台、云安全服务、自动化助手服务。
    示例值：{"SecurityService":{"Enabled":true},"MonitorService":{"Enabled":true},"AutomationService":{"Enabled":true}}

    QueueConfigOverview

    扩容队列配置概览。

    被如下接口引用：DescribeAutoScalingConfiguration。

    名称 类型 描述
    QueueName String 队列名称。
    示例值：compute
    MinSize Integer 队列中弹性节点数量最小值。取值范围0～200。
    示例值：1
    MaxSize Integer 队列中弹性节点数量最大值。取值范围0～200。
    示例值：5
    EnableAutoExpansion Boolean 是否开启自动扩容。
    示例值：False
    EnableAutoShrink Boolean 是否开启自动缩容。
    示例值：False
    ExpansionNodeConfigs Array of ExpansionNodeConfigOverview 扩容节点配置信息。
    示例值：[{"InstanceType":"M5.SMALL8","InstanceChargeType":"POSTPAID_BY_HOUR"}]
    DesiredIdleNodeCapacity Integer 队列中期望的空闲节点数量（包含弹性节点和静态节点）。默认值：0。队列中，处于空闲状态的节点小于此值，集群会扩容弹性节点；处于空闲状态的节点大于此值，集群会缩容弹性节点。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：5
    DesiredNodeCount Integer 队列中期望的总节点数。
    示例值：0
    ScaleOutRatio Integer 扩容比例。默认值：100。取值范围：1～100。
    如果扩容比例为50，那么每轮只会扩容当前作业负载所需的50%数量的节点。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：50
    ScaleOutNodeThreshold Integer 比例扩容阈值。默认值：0。取值范围：0～200。
    当作业负载需要扩容节点数量大于此值，当前扩容轮次按照ScaleOutRatio配置的的比例进行扩容。当作业负载需要扩容节点数量小于此值，当前扩容轮次扩容当前作业负载所需数量的节点。
    此参数配合ScaleOutRatio参数进行使用，用于比例扩容场景下，在作业负载所需节点数量较小时，加快收敛速度。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：0
    MaxNodesPerCycle Integer 每轮扩容最大节点个数。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：10
    ScaleUpMemRatio Integer 扩容过程中，作业的内存在匹配实例机型时增大比例（不会影响作业提交的内存大小，只影响匹配计算过程）。

    针对场景：由于实例机型的总内存会大于实例内部的可用内存，16GB内存规格的实例，实例操作系统内的可用内存只有约14.9GB内存。假设此时提交一个需要15GB内存的作业，

    - 当ScaleUpMemRatio=0时，会匹配到16GB内存规格的实例,但是由于操作系统内的可用内存为14.9GB小于作业所需的15GB，扩容出来的实例作业无法运行起来。
    - 当ScaleUpMemRatio=10时，匹配实例规格会按照15*(1+10%)=16.5GB来进行实例规格匹配，则不会匹配到16GB的实例，而是更大内存规格的实例来保证作业能够被运行起来。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：0

    QueueOverview

    队列信息概览。

    被如下接口引用：DescribeQueues。

    名称 类型 描述
    QueueName String 队列名称。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：compute

    RunAutomationServiceEnabled

    描述了 “云自动化助手” 服务相关的信息。

    被如下接口引用：CreateCluster, CreateWorkspaces, SetAutoScalingConfiguration。

    名称 类型 必选 描述
    Enabled Boolean 否 是否开启云自动化助手。取值范围：
  • TRUE：表示开启云自动化助手服务

  • FALSE：表示不开启云自动化助手服务


    • 默认取值：TRUE。
    示例值：true

    RunMonitorServiceEnabled

    描述了 “腾讯云可观测平台” 服务相关的信息。

    被如下接口引用：CreateCluster, CreateWorkspaces, SetAutoScalingConfiguration。

    名称 类型 必选 描述
    Enabled Boolean 否 是否开启腾讯云可观测平台服务。取值范围：
  • TRUE：表示开启腾讯云可观测平台服务

  • FALSE：表示不开启腾讯云可观测平台服务


    • 默认取值：TRUE。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：true

    RunSecurityServiceEnabled

    描述了 “云安全” 服务相关的信息。

    被如下接口引用：CreateCluster, CreateWorkspaces, SetAutoScalingConfiguration。

    名称 类型 必选 描述
    Enabled Boolean 否 是否开启云安全服务。取值范围：
  • TRUE：表示开启云安全服务

  • FALSE：表示不开启云安全服务


    • 默认取值：TRUE。
    示例值：true

    SpaceChargePrepaid

    描述了工作空间的计费模式

    被如下接口引用：CreateWorkspaces。

    名称 类型 必选 描述
    Period Integer 否 购买实例的时长，单位：月。取值范围：1, 2, 3, 12, 24, 36。默认取值为1。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：1
    RenewFlag String 否 自动续费标识。取值范围：

    NOTIFY_AND_AUTO_RENEW：通知过期且自动续费

    NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费

    DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费


    默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：NOTIFY_AND_AUTO_RENEW

    SpaceDataDisk

    工作空间数据盘配置

    被如下接口引用：CreateWorkspaces。

    名称 类型 必选 描述
    DiskType String 否 数据盘类型。数据盘类型限制详见存储概述。取值范围：


  • 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接口无效。










    • 示例值：CLOUD_SSD
    DiskId String 否 数据盘
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：disk-ciezoimt
    DiskSize Integer 否 数据盘大小，单位：GB。最小调整步长为10G，不同数据盘类型取值范围不同，具体限制详见：存储概述。默认值为0，表示不购买数据盘。更多限制详见产品文档。
    示例值：50
    DeleteWithInstance Boolean 否 数据盘是否随子机销毁。取值范围：
  • TRUE：子机销毁时，销毁数据盘，只支持按小时后付费云盘

  • FALSE：子机销毁时，保留数据盘

    默认取值：TRUE

    该参数目前仅用于 RunInstances 接口。

    • 注意：此字段可能返回 null，表示取不到有效值。
    示例值：true
    SnapshotId String 否 数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：snap-6yczrj8x
    Encrypt Boolean 否 数据盘是加密。取值范围：
  • true：加密

  • false：不加密

    默认取值：false

    该参数目前仅用于 RunInstances 接口。

    • 注意：此字段可能返回 null，表示取不到有效值。
    示例值：false
    KmsKeyId String 否 自定义CMK对应的ID，取值为UUID或者类似kms-abcd1234。用于加密云盘。

    该参数目前仅用于 CreateWorkspaces 接口。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：kms-abcd1234
    ThroughputPerformance Integer 否 云硬盘性能，单位：MB/s
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：20
    BurstPerformance Boolean 否 突发性能

    注：内测中。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：false

    SpaceInfo

    描述工作空间的信息

    被如下接口引用：DescribeWorkspaces。

    名称 类型 描述
    SpaceId String 工作空间ID
    示例值：wks-3rr4w3t7
    SpaceFamily String 工作空间类型
    示例值：96AS
    SpaceType String 工作空间规格
    示例值：96AS.4XLARGE160
    SpaceName String 工作空间名称
    示例值：workspace
    SpaceState String 工作空间状态。取值范围：
  • PENDING：表示创建中
  • LAUNCH_FAILED：表示创建失败
  • ONLINE：表示运行中
  • ARREARS：表示隔离中
  • TERMINATING：表示销毁中。

    • 示例值：ONLINE
    SpaceChargeType String 工作空间计费模式
    示例值：PREPAID
    ResourceId String 工作空间对应资源ID
    示例值：ins-3zjugd6z
    RenewFlag String 自动续费标识
    示例值：NOTIFY_AND_MANUAL_RENEW
    Tags Array of Tag 工作空间关联的工作列表
    示例值：[{"Key": "env", "Value": "product"}]
    CreatedTime Timestamp ISO8601 创建时间
    示例值：2024-09-22T00:00:00+00:00
    ExpiredTime Timestamp ISO8601 到期时间
    示例值：2025-09-22T00:00:00+00:00
    Placement Placement 工作空间所在位置
    示例值：{"Zone": "ap-guangzhou-2"}
    LatestOperation String 工作空间的最新操作
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：CreateWorkspaces
    LatestOperationState String 工作空间的最新操作状态
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：SUCCESS

    SpaceInternetAccessible

    描述了工作空间的公网可访问性，声明了工作空间的公网使用计费模式，最大带宽等

    被如下接口引用：CreateWorkspaces。

    名称 类型 必选 描述
    InternetChargeType String 否 网络计费类型
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：BANDWIDTH_PREPAID
    InternetMaxBandwidthOut Integer 否 公网出带宽上限，默认为0
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：10
    PublicIpAssigned Boolean 否 是否分配公网IP
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：false
    BandwidthPackageId String 否 带宽包ID
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：bwp-h1ro

    SpacePlacement

    描述了实例的抽象位置，包括其所在的可用区，所属的项目

    被如下接口引用：CreateWorkspaces。

    名称 类型 必选 描述
    Zone String 是 可用区
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：ap-guangzhou-1
    ProjectId Integer 否 项目，默认是0
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：0

    SpaceSystemDisk

    工作空间系统盘配置

    被如下接口引用：CreateWorkspaces。

    名称 类型 必选 描述
    DiskType String 否 系统盘类型。系统盘类型限制详见存储概述。取值范围：
    • LOCAL_BASIC：本地硬盘
    • LOCAL_SSD：本地SSD硬盘
    • CLOUD_BASIC：普通云硬盘
    • CLOUD_SSD：SSD云硬盘
    • CLOUD_PREMIUM：高性能云硬盘
    • CLOUD_BSSD：通用性SSD云硬盘
    • CLOUD_HSSD：增强型SSD云硬盘
    • CLOUD_TSSD：极速型SSD云硬盘
    默认取值：当前有库存的硬盘类型。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：CLOUD_HSSD
    DiskSize Integer 否 系统盘大小，单位：GB。默认值为 50
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：50

    SpaceVirtualPrivateCloud

    描述了工作空间VPC相关信息，包括子网，IP信息等

    被如下接口引用：CreateWorkspaces。

    名称 类型 必选 描述
    VpcId String 是 私有网络ID
    示例值：vpc-2ij
    SubnetId String 是 私有网络子网ID
    示例值：subnet-2ks
    AsVpcGateway Boolean 否 是否用作公网网关
    示例值：false
    PrivateIpAddresses Array of String 否 私有网络子网 IP 数组
    示例值：["10.0.0.1"]
    Ipv6AddressCount Integer 否 为弹性网卡指定随机生成
    示例值：1

    StorageOption

    描述集群文件系统选项

    被如下接口引用：AddClusterStorageOption, CreateCluster。

    名称 类型 必选 描述
    CFSOptions Array of CFSOption 否 集群挂载CFS文件系统选项。
    GooseFSOptions Array of GooseFSOption 否 集群挂载GooseFS文件系统选项。
    GooseFSxOptions Array of GooseFSxOption 否 集群挂载GooseFSx文件系统选项。

    StorageOptionOverview

    集群存储选项概览信息。

    被如下接口引用：DescribeClusterStorageOption。

    名称 类型 描述
    CFSOptions Array of CFSOptionOverview CFS存储选项概览信息列表。
    GooseFSOptions Array of GooseFSOptionOverview GooseFS存储选项概览信息列表。
    GooseFSxOptions Array of GooseFSxOptionOverview GooseFSx存储选项概览信息列表。

    SystemDisk

    描述了操作系统所在块设备即系统盘的信息

    被如下接口引用：AddNodes, CreateCluster, DescribeAutoScalingConfiguration, SetAutoScalingConfiguration。

    名称 类型 必选 描述
    DiskType String 否 系统盘类型。系统盘类型限制详见存储概述。取值范围：
    CLOUD_BASIC：普通云硬盘
    CLOUD_SSD：SSD云硬盘
    CLOUD_PREMIUM：高性能云硬盘

    默认取值：当前有库存的硬盘类型。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：CLOUD_BASIC
    DiskSize Integer 否 系统盘大小，单位：GB。默认值为 50
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：50

    Tag

    标签键值对。

    被如下接口引用：CreateCluster, CreateWorkspaces, DescribeWorkspaces。

    名称 类型 必选 描述
    Key String 是 标签键
    示例值：env
    Value String 是 标签值
    示例值：product

    TagSpecification

    创建资源工作空间时同时绑定的标签对说明

    被如下接口引用：CreateWorkspaces。

    名称 类型 必选 描述
    ResourceType String 是 标签绑定的资源类型
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：workspace
    Tags Array of Tag 是 标签对列表
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：[{"Name": "env", "Value": "test"}]

    VirtualPrivateCloud

    描述了VPC相关信息

    被如下接口引用：AddNodes, CreateCluster, DescribeAutoScalingConfiguration, SetAutoScalingConfiguration。

    名称 类型 必选 描述
    VpcId String 是 私有网络ID，形如vpc-xxx。有效的VpcId可通过登录控制台查询；也可以调用接口 DescribeVpcEx ，从接口返回中的unVpcId字段获取。若在创建子机时VpcId与SubnetId同时传入DEFAULT，则强制使用默认vpc网络。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：vpc-jfkanfen
    SubnetId String 是 私有网络子网ID，形如subnet-xxx。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 DescribeSubnets ，从接口返回中的unSubnetId字段获取。若在创建子机时SubnetId与VpcId同时传入DEFAULT，则强制使用默认vpc网络。
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：subnet-jfnakenf
    中国站
    文档活动
    message-icon联系我们
    目录