高性能计算平台
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 高性能计算平台 > API 文档 > 高性能计算平台 API 2021-11-09 > 数据结构

数据结构

最近更新时间：2023-08-17 05:24:54

我的收藏

本页目录：

CFSOption

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

被如下接口引用：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

    ClusterOverview

    集群概览信息。

    被如下接口引用：DescribeClusters。

    名称 类型 描述
    ClusterId String 集群ID。
    示例值：hpc-2mv1i3d8
    ClusterStatus String 集群状态。取值范围：
  • PENDING：创建中
  • INITING：初始化中
  • INIT_FAILED：初始化失败
  • RUNNING：运行中
  • TERMINATING：销毁中
    示例值：RUNNING
    		•
    ClusterName String 集群名称。
    Placement Placement 集群位置信息。
    CreateTime Timestamp ISO8601 集群创建时间。
    SchedulerType String 集群调度器。
    示例值：SGE
    ComputeNodeCount Integer 计算节点数量。
    示例值：1
    ComputeNodeSet Array of ComputeNodeOverview 计算节点概览。
    ManagerNodeCount Integer 管控节点数量。
    示例值：1
    ManagerNodeSet Array of ManagerNodeOverview 管控节点概览。
    LoginNodeSet Array of LoginNodeOverview 登录节点概览。
    LoginNodeCount Integer 登录节点数量。
    示例值：1

    ComputeNode

    计算节点信息。

    被如下接口引用：CreateCluster。

    名称 类型 必选 描述
    InstanceChargeType String 否 节点计费类型。
  • PREPAID：预付费，即包年包月
  • POSTPAID_BY_HOUR：按小时后付费
  • SPOTPAID：竞价付费
    默认值：POSTPAID_BY_HOUR。
    示例值：POSTPAID_BY_HOUR
    		•
    InstanceChargePrepaid InstanceChargePrepaid 否 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。
    InstanceType String 否 节点机型。不同实例机型指定了不同的资源规格。

  • 具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表或参见实例规格描述。
    示例值：S2.SMALL2
    		•
    SystemDisk SystemDisk 否 节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。
    DataDisks Array of DataDisk 否 节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
    InternetAccessible InternetAccessible 否 公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。
    InstanceName String 否 节点显示名称。

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

    ComputeNodeOverview

    计算节点概览。

    被如下接口引用：DescribeClusters。

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

    DataDisk

    描述了数据盘的信息

    被如下接口引用：CreateCluster。

    名称 类型 必选 描述
    DiskSize Integer 是 数据盘大小，单位：GB。最小调整步长为10G，不同数据盘类型取值范围不同，具体限制详见：存储概述。默认值为0，表示不购买数据盘。更多限制详见产品文档。
    示例值：0
    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云硬盘

    默认取值：LOCAL_BASIC。
    示例值：LOCAL_BASIC
    		•

    GooseFSOption

    描述GooseFS挂载信息

    被如下接口引用：CreateCluster。

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

    InstanceChargePrepaid

    描述了实例的计费模式

    被如下接口引用：CreateCluster。

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

    默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。
    示例值：NOTIFY_AND_AUTO_RENEW

    InternetAccessible

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

    被如下接口引用：CreateCluster。

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

    LoginNode

    登录节点信息。

    被如下接口引用：CreateCluster。

    名称 类型 必选 描述
    InstanceChargeType String 否 节点计费类型。
  • PREPAID：预付费，即包年包月
  • POSTPAID_BY_HOUR：按小时后付费
  • SPOTPAID：竞价付费
    默认值：POSTPAID_BY_HOUR。
    示例值：POSTPAID_BY_HOUR
    		•
    InstanceChargePrepaid InstanceChargePrepaid 否 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。
    InstanceType String 否 节点机型。不同实例机型指定了不同的资源规格。

  • 具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表或参见实例规格描述。
    示例值：S2.SMALL2
    		•
    SystemDisk Array of SystemDisk 否 节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。
    DataDisks Array of DataDisk 否 节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
    InternetAccessible Array of InternetAccessible 否 公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。
    InstanceName String 否 节点显示名称。

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

    LoginNodeOverview

    登录节点概览。

    被如下接口引用：DescribeClusters。

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

    LoginSettings

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

    被如下接口引用：CreateCluster。

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

    若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到用户。
    		•

    ManagerNode

    管控节点信息

    被如下接口引用：CreateCluster。

    名称 类型 必选 描述
    InstanceChargeType String 否 节点计费类型。
  • PREPAID：预付费，即包年包月
  • POSTPAID_BY_HOUR：按小时后付费
    默认值：POSTPAID_BY_HOUR。
    示例值：POSTPAID_BY_HOUR
    		•
    InstanceChargePrepaid InstanceChargePrepaid 否 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月节点的购买时长、是否设置自动续费等属性。若指定节点的付费模式为预付费则该参数必传。
    InstanceType String 否 节点机型。不同实例机型指定了不同的资源规格。

  • 对于付费模式为PREPAID或POSTPAID_BY_HOUR的实例创建，具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表或参见实例规格描述。
    示例值：S2.SMALL2
    		•
    SystemDisk SystemDisk 否 节点系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。
    DataDisks Array of DataDisk 否 节点数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
    InternetAccessible InternetAccessible 否 公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。
    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个字符（包含模式串）。
    示例值：未命名
    		•

    ManagerNodeOverview

    管控节点概览。

    被如下接口引用：DescribeClusters。

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

    Placement

    描述了实例的抽象位置

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

    名称 类型 必选 描述
    Zone String 是 实例所属的可用区名称。该参数可以通过调用 DescribeZones 的返回值中的Zone字段来获取。

    StorageOption

    描述集群文件系统选项

    被如下接口引用：CreateCluster。

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

    SystemDisk

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

    被如下接口引用：CreateCluster。

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

    默认取值：当前有库存的硬盘类型。
    示例值：CLOUD_BASIC
    DiskSize Integer 否 系统盘大小，单位：GB。默认值为 50
    示例值：50

    Tag

    标签键值对。

    被如下接口引用：CreateCluster。

    名称 类型 必选 描述
    Key String 是 标签键
    Value String 是 标签值

    VirtualPrivateCloud

    描述了VPC相关信息

    被如下接口引用：CreateCluster。

    名称 类型 必选 描述
    VpcId String 是 私有网络ID，形如vpc-xxx。有效的VpcId可通过登录控制台查询；也可以调用接口 DescribeVpcEx ，从接口返回中的unVpcId字段获取。若在创建子机时VpcId与SubnetId同时传入DEFAULT，则强制使用默认vpc网络。
    SubnetId String 是 私有网络子网ID，形如subnet-xxx。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 DescribeSubnets ，从接口返回中的unSubnetId字段获取。若在创建子机时SubnetId与VpcId同时传入DEFAULT，则强制使用默认vpc网络。
    中国站