CreateCluster - 创建集群

创建一个按量付费或者预付费(包年包月)集群。

接口说明

请确保在使用该接口前,已充分了解 E-HPC 产品的收费方式和价格。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ehpc:CreateClustercreate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ClusterNamestring

集群名称。长度为 1~128 个字符,支持英文、中文和数字。可以包含短划线(-)和下划线(_)。

slurm22.05.8-cluster-20240718
ClusterDescriptionstring

集群描述。长度为 1~128 个字符,支持英文、中文和数字。可以包含短划线(-)和下划线(_)。

slurm22.05.8-cluster-20240718
ClusterCategorystring

集群系列,取值范围:

  • Standard
  • Serverless
Standard
ClusterVpcIdstring

集群使用的专有网络 VPC ID。

vpc-m5efjevmclc0xdmys****
ClusterVSwitchIdstring

集群使用的虚拟交换机 ID。虚拟交换机 ID 需在ClusterVpcId中。

您可以调用 DescribeVpcs 查询已创建的 VPC 和 VSwitch 信息。

vsw-f8za5p0mwzgdu3wgx****
IsEnterpriseSecurityGroupboolean

是否使用企业安全组。取值范围:

  • true:自动创建并使用企业级安全组。
  • false:不使用企业级安全组,自动创建并使用普通安全组。
false
SecurityGroupIdstring

指定新创建集群所属的安全组 ID。

您可以调用 DescribeSecurityGroups 查询当前地域可以使用的安全组。

sg-bp13n61xsydodfyg****
ClientVersionstring

集群客户端版本。默认使用最新版本。

2.1.0
ClusterCustomConfigurationobject

集群后处理脚本。

Scriptstring

后处理脚本的下载地址。

http://*****
Argsstring

安装后脚本的执行参数。

E-HPC cn-hangzhou
ClusterCredentialsobject

集群的安全凭证。

KeyPairNamestring

密钥对名称。长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头,不能以http://https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

说明 如果您要使用 ECS 密钥对功能,具体操作,请参见创建密钥对
ali0824
Passwordstring

登录节点的 root 密码。长度为 8 至 20 个字符,必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是: () ~ ! @ # $ % ^ & * - = + { } [ ] : ; ‘ < > , . ? /

说明 建议使用 HTTPS 协议调用 API 避免密码泄露。
**********
MaxCountinteger

集群可管理的计算节点数量,取值范围:0~5,000。

500
MaxCoreCountinteger

集群可管理的计算节点总核数,取值范围:0~100,000。

10000
DeletionProtectionboolean

集群删除保护属性,指定是否支持通过控制台或 API DeleteCluster 删除集群。

  • true:开启集群删除保护。
  • false:关闭集群删除保护。

默认值:false。

false
ResourceGroupIdstring

资源组 ID。

您可以调用 ListResourceGroups 查询资源组 ID。

rg-acfmxazb4******
Tagsarray<object>

集群的标签列表。

object

集群的标签信息。

Keystring

集群的标签键。N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

ClusterId
Valuestring

集群的标签值。N 的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持 128 个字符,不能包含http://或者https://

ehpc-hz-******
Managerobject

集群管理节点配置。

Schedulerobject

调度器服务配置信息。

Typestring

调度器类型。取值范围:

  • SLURM
  • PBS
  • OPENGRIDSCHEDULER
  • LSF_PLUGIN
  • PBS_PLUGIN
SLURM
Versionstring

调度器版本。

22.05.8
DirectoryServiceobject

域账号服务配置信息。

Typestring

域账号类型。

枚举值:
  • NISNIS
NIS
Versionstring

域账号版本。

2.31
DNSobject

域名解析服务配置信息。

Typestring

域名解析类型。

枚举值:
  • NISNIS
NIS
Versionstring

域名解析版本。

2.31
ManagerNodeNodeTemplate

管理节点的硬件配置信息。

Queuesarray

集群队列的配置。队列数量支持 0~8 个。

QueueTemplate

集群队列的详细配置。

SharedStoragesarray

集群共享存储配置。

SharedStorageTemplate

集群共享存储的详细配置。

AdditionalPackagesarray<object>

集群待安装的软件列表,N 的取值范围:0~10。

object

待安装软件的具体信息。

Namestring

待安装软件名称。

mpich
Versionstring

待安装软件版本。

4.0.3
Addonsarray<object>

集群自定义服务组件配置,仅支持一个组件。

object

自定义服务组件的具体配置信息。

Namestring

自定义服务组件的名称。

Login
Versionstring

自定义服务组件的版本。

1.0
ServicesSpecstring

自定义服务组件的服务配置。

"[{\\"ServiceName\\": \\"SSH\\", \\"ServiceAccessType\\": null, \\"ServiceAccessUrl\\": null, \\"NetworkACL\\": [{\\"IpProtocol\\": \\"TCP\\", \\"Port\\": 22, \\"SourceCidrIp\\": \\"0.0.0.0/0\\"}]}, {\\"ServiceName\\": \\"VNC\\", \\"ServiceAccessType\\": null, \\"ServiceAccessUrl\\": null, \\"NetworkACL\\": [{\\"IpProtocol\\": \\"TCP\\", \\"Port\\": 12016, \\"SourceCidrIp\\": \\"0.0.0.0/0\\"}]}, {\\"ServiceName\\": \\"CLIENT\\", \\"ServiceAccessType\\": \\"URL\\", \\"ServiceAccessUrl\\": \\"\\", \\"NetworkACL\\": [{\\"IpProtocol\\": \\"TCP\\", \\"Port\\": 12011, \\"SourceCidrIp\\": \\"0.0.0.0/0\\"}]}]"
ResourcesSpecstring

自定义服务组件的资源配置。

"{\\"EipResource\\": {\\"AutoCreate\\": true}, \\"EcsResources\\": [{\\"InstanceType\\": \\"ecs.c7.xlarge\\", \\"ImageId\\": \\"centos_7_6_x64_20G_alibase_20211130.vhd\\", \\"SystemDisk\\": {\\"Category\\": \\"cloud_essd\\", \\"Size\\": 40, \\"Level\\": \\"PL0\\"}, \\"EnableHT\\": true, \\"InstanceChargeType\\": \\"PostPaid\\", \\"SpotStrategy\\": \\"NoSpot\\"}]}"
ClusterModestring

集群部署类型,取值范围:

  • Integrated:公共云集群。
  • Hybrid:混合云集群。
  • Custom:自定义集群。
Integrated

返回参数

名称类型描述示例值
object

Schema of Response

Successboolean

请求结果,可能值:

  • true:请求成功。

  • false:请求失败。

true
RequestIdstring

请求 ID。

F6757FA4-8FED-4602-B7F5-3550C0******
ClusterIdstring

集群 ID。

ehpc-hz-FYUr******
TaskIdstring

任务 ID。

F6757FA4-8FED-4602-B7F5-3550C0******

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "F6757FA4-8FED-4602-B7F5-3550C0******",
  "ClusterId": "ehpc-hz-FYUr******",
  "TaskId": "F6757FA4-8FED-4602-B7F5-3550C0******\n"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe specified parameter %s is invalid.指定的参数 %s 无效。
400OrderError.ArrearageYour account balance is less than CNY 100. Please add funds to your account and try again.账户余额不足100元,请您先充值后再重试。
400OrderError.InstHasUnpaidOrderYour account has an unpaid order.账户存在未支付订单,请您先支付后再重试。
400OrderError.InsufficientBalanceThe account balance is insufficient. Please add funds first and try again.账户已欠费,请您先充值后再重试。
400OrderError.InvalidPayMethodNo valid default payment method is specified for your account.没有有效的默认支付方式,请您查看支付方式是否正确。
400OrderError.NoCardNo credit card is bound to your account.未绑定卡,请您先绑定后再重试。
400OrderError.NoRealNameAuthenticationYou have not completed the real name authentication.未完成实名验证,请您先进行实名认证后重试。
400OrderError.NoRealNameRegistrationReal name registration is required for instances launched in mainland China.国际站用户购买中国内地地域云产品,未完成实名注册。
400OrderError.UserProfileIncompleteYou have not completed your user profile.国际站用户未完善个人信息。
400Cluster.NotSupportedCurrent cluster does not support this operation.当前集群不支持该操作。
403ConflictOptA conflicting operation is running.有冲突的操作在执行中,请您稍后再试。
403TooManyClustersThe number of user clusters exceeds the quota.用户集群数量超过配额限制,如需更多,请参考产品使用限制文档的方式提升配额。
404KeyPairNotFoundThe specified KeyPair does not exist.指定的密钥对不存在,请您检查该参数是否正确。
406DbErrorA database service error occurred.数据库请求失败
406OrderErrorAn order request error occurred.订单请求失败
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

访问错误中心查看更多错误码。