CreateCluster_弹性高性能计算_API文档-阿里云OpenAPI开发者门户

接口说明

创建集群会涉及相关资源计费，建议您提前了解 E-HPC 的计费方式。更多信息，请参见计费方式。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

ehpc:CreateCluster	Write	全部资源 *	无	无

请求参数

字段名称	字段详情
ZoneIdstring	可用区 ID。展开详情示例值:cn-hangzhou-b
Namestring	集群名称，长度为 2~64 个字符。示例值:test
Descriptionstring	集群描述信息。长度为 2~256 个英文或中文字符，不能以`http://`和`https://`开头。示例值:TestDescription
EhpcVersionstring	E-HPC 产品版本，默认为最新版本。示例值:1.0.0
ClientVersionstring	集群客户端版本，默认为最新版本。展开详情示例值:1.0.64参考取值来源: ListCurrentClientVersion
OsTagstring	操作系统镜像标签。示例值:CentOS_7.2_64
AccountTypestring	域账号服务类型。取值范围：展开详情示例值:nis
Domainstring	本地集群域名。展开详情示例值:ldap
SchedulerTypestring	调度器类型。取值范围：展开详情示例值:pbs
SecurityGroupIdstring	指定新创建集群所属的安全组 ID。展开详情示例值:sg-bp13n61xsydodfyg****参考取值来源: AddSecurityGroup
SecurityGroupNamestring	如果不使用已有安全组，则使用此名称创建新安全组，应用默认安全组策略。示例值:ehpc-SecurityGroup
VpcIdstring	集群所属的 VPC ID。展开详情示例值:vpc-b3f3edefefeep0760yju****
VSwitchIdstring	VPC 中交换机 ID。E-HPC 当前仅支持 VPC 网络。展开详情示例值:vsw-bp1lfcjbfb099rrjn****
VolumeTypestring	共享存储类型，目前仅支持配置为`nas`，表示 NAS 文件系统。示例值:nas参考取值来源: ListVolumes GetClusterVolumes
VolumeIdstring	阿里云 NAS 实例 ID。如果该参数为空，创建集群的流程会默认创建一个性能型的 NAS 实例。展开详情示例值:008b64****参考取值来源: ListVolumes GetClusterVolumes
VolumeProtocolstring	共享存储的协议类型。取值范围：展开详情示例值:NFS参考取值来源: GetClusterVolumes ListVolumes
VolumeMountpointstring	NAS 的 VPC 挂载点。VolumeMountpoint 有以下限制：展开详情示例值:008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com参考取值来源: ListVolumes GetClusterVolumes
VolumeMountOptionstring	采用 mount 命令手动挂载 NFS 文件系统时的挂载参数。展开详情示例值:-t nfs -o vers=4
RemoteDirectorystring	挂载共享存储的远程目录。示例值:NasMountpoint:/RemoteDirectory
DeployModestring	集群部署模式。取值范围：展开详情示例值:Simple
HaEnableboolean	是否开启高可用。取值范围：展开详情示例值:true
EcsChargeTypestring	集群中所有节点的付费类型，取值范围：展开详情示例值:PostPaid
Passwordstring	登录节点的 root 密码。展开详情示例值:123****
KeyPairNamestring	登录节点绑定的密钥对名称。关于如何创建密钥对，请参见创建密钥对。展开详情示例值:test
ImageOwnerAliasstring	镜像类型。取值范围：展开详情示例值:self参考取值来源: ListCommunityImages
ImageIdstring	镜像 ID。展开详情示例值:centos_7_02_64_20G_alibase_20170818****参考取值来源: ListImages
EcsOrder.Manager.Countinteger<int32>	集群管控节点数量。取值范围：1~2。示例值:1
EcsOrder.Manager.InstanceTypestring	集群管控节点规格。展开详情示例值:ecs.n1.tiny参考取值来源: GetIfEcsTypeSupportHtConfig
EcsOrder.Compute.Countinteger<int32>	集群计算节点数量。取值范围：0~99。示例值:1
EcsOrder.Compute.InstanceTypestring	集群计算节点规格。展开详情示例值:ecs.n1.tiny参考取值来源: GetIfEcsTypeSupportHtConfig
EcsOrder.Login.Countinteger<int32>	集群登录节点数量，仅支持配置 1。示例值:1
EcsOrder.Login.InstanceTypestring	集群登录节点规格。展开详情示例值:ecs.n1.tiny参考取值来源: GetIfEcsTypeSupportHtConfig
SccClusterIdstring	SCC 实例 ID。展开详情示例值:00b648b****参考取值来源: DescribeCluster
ComputeSpotStrategystring	计算节点竞价策略。取值范围：展开详情示例值:NoSpot
ComputeSpotPriceLimitstring	计算节点每小时最高价格。最大支持 3 位小数，参数 ComputeSpotStrategy 取值为 SpotWithPriceLimit 时生效。示例值:0.034
ComputeEnableHtboolean	计算节点是否支持超线程。取值范围：展开详情示例值:true
Periodinteger<int32>	购买集群节点的时长。单位由`PeriodUnit`指定，取值范围：展开详情示例值:1
PeriodUnitstring	购买集群节点的时长单位。取值范围：展开详情示例值:Year
AutoRenewstring	是否自动续费。取值范围：展开详情示例值:false
AutoRenewPeriodinteger<int32>	每次自动续费的时长，当参数 AutoRenew 取值 true 时生效。示例值:1
InputFileUrlstring	上传到 OSS 的作业文件的 URL 地址。示例值:https://ehpc-tianshui.oss-cn-beijing.aliyuncs.com/test-u****/testlist_ehpc.sh
JobQueuestring	计算节点加入的队列名称。示例值:workq
SystemDiskTypestring	系统盘的云盘种类。取值范围：展开详情示例值:cloud_ssd
SystemDiskSizeinteger<int32>	系统盘大小。单位：GB。展开详情示例值:40
RemoteVisEnablestring	是否开启远程可视化。取值范围：展开详情示例值:false
ResourceGroupIdstring	资源组 ID。展开详情示例值:rg-acfmxazb4ph****
ClientTokenstring	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。示例值:123e4567-e89b-12d3-a456-426655440000
WithoutElasticIpboolean	登录节点是否使用弹性公网 IP。默认值：false。示例值:true枚举值:truefalse
SystemDiskLevelstring	创建 ESSD 云盘作为系统盘使用时，设置云盘的性能等级。取值范围：展开详情示例值:PL0
IsComputeEssboolean	是否启用自动伸缩。取值范围：展开详情示例值:false
ClusterVersionstring	集群版本号。展开详情示例值:1.0参考取值来源: DescribeCluster
Applicationarray<object>	应用软件信息。子级条数 <= 100
AdditionalVolumesarray<object>	挂载的共享存储信息。子级条数 <= 100
PostInstallScriptarray<object>	安装后脚本信息。子级条数 <= 16
Pluginstring	插件模式配置，仅当 SchedulerType 为 custom 生效。展开详情示例值:{"pluginMod": "oss","pluginLocalPath": "/opt/plugin","pluginOssPath": "https://bucket.oss-cn-hangzhou.aliyuncs.com/plugin/plugin.tgz"}
WithoutAgentboolean	是否不安装 Agent 客户端。展开详情示例值:false
WithoutNasboolean	是否不使用 NAS 作为共享存储。取值范围：展开详情示例值:false
RamRoleNamestring	实例 RAM 角色名称。展开详情示例值:testRamRoleName
NetworkInterfaceTrafficModestring	弹性网卡的通讯模式。取值范围：展开详情示例值:Standard
DeploymentSetIdstring	部署集 ID。展开详情示例值:ds-bp1frxuzdg87zh4pzq****
RamNodeTypesarray<string>	授权实例角色的节点名称详情。示例值:Standard子级条数 <= 5子级条数 >= 0
Tagarray<object>	标签数组。子级条数 <= 20
AddOnsarray<object>	自定义组件服务。子级条数 <= 20

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:F6757FA4-8FED-4602-B7F5-3550C084****
TaskIdstring	任务 ID。展开详情示例值:F6757FA4-8FED-4602-B7F5-3550C084****
ClusterIdstring	集群 ID。示例值:ehpc-hz-FYUr32****

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	InvalidParams	The specified parameter %s is invalid.	诊断
400	NotEnabled	You have not enabled this service	诊断
400	InDebt	Your account has overdue payments.	诊断
400	OrderError.InsufficientBalance	The account balance is insufficient. Please add funds first and try again.	诊断
400	OrderError.InstHasUnpaidOrder	Your account has an unpaid order.	诊断
400	OrderError.Arrearage	Your account balance is less than CNY 100. Please add funds to your account and try again.	诊断
400	OrderError.NoCard	No credit card is bound to your account.	诊断
400	OrderError.InvalidPayMethod	No valid default payment method is specified for your account.	诊断
400	OrderError.NoRealNameAuthentication	You have not completed the real name authentication.	诊断
400	OrderError.NoRealNameRegistration	Real name registration is required for instances launched in mainland China.	诊断
400	OrderError.UserProfileIncomplete	You have not completed your user profile.	诊断
400	InvalidVpc	The specified VPC is invalid.	诊断
400	InvalidVolume	The specified volume is invalid.	诊断
400	InvalidSoftware	The specified software is not supported.	诊断
400	InvalidVolumeProtocal	The specified volume protocol is invalid.	诊断
400	InvalidVolumeMountpoint	The specified volume mount point is invalid.	诊断
400	MissingParams	The %s parameter is required.	诊断
403	TooManyClusters	The number of user clusters exceeds the quota.	诊断
403	TooManyComputes	The number of computing nodes exceeds the quota.	诊断
403	TooManyLogins	The maximum number of logged on nodes is exceeded.	诊断
403	TooManyScc	The maximum number of SCC instances is exceeded.	诊断
403	QuotaExceeded.PrivateIpAddress	Insufficient private IP addresses in vSwitch: %s.	诊断
403	ConflictOpt	A conflicting operation is running.	诊断
403	ImageNotSupported	The specified image is not supported.	诊断
404	ImageNotFound	The specified image does not exist.	诊断
404	VolumeNotFound	The specified volume does not exist.	诊断
404	VpcNotFound	The specified VPC does not exist.	诊断
404	KeyPairNotFound	The specified KeyPair does not exist.	诊断
406	EcsError	An error occurred while calling the ECS API operation.	诊断
406	NasError	NAS API request failed.	诊断
406	NasServiceNotOpen	The NAS service is not activated.	诊断
406	EipError	The EIP API request failed.	诊断
406	OrderError	An order request error occurred.	诊断
406	FailToGenId	Generating cluster ID failed.	诊断
406	DbError	A database service error occurred.	诊断
406	AliyunError	An Alibaba Cloud product error occurred.	诊断
406	AckError	An error occurred while calling the ACK API operation.	诊断
407	NotAuthorized	No authorization is granted.	诊断
500	UnknownError	An unknown error occurred.	诊断
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	诊断

变更历史

	变更时间	变更内容概要	操作
	2023-07-07	变更请求参数EcsOrder.Compute.Count 变更请求参数EcsOrder.Login.Count
	2023-06-27	变更错误码400 变更错误码404 变更错误码406 变更请求参数OsTag 变更请求参数EcsOrder.Manager.InstanceType 变更请求参数EcsOrder.Compute.Count 变更请求参数EcsOrder.Compute.InstanceType 变更请求参数EcsOrder.Login.Count 变更请求参数EcsOrder.Login.InstanceType 新增请求参数WithoutNas 新增请求参数DeploymentSetId
	2023-05-26	变更请求参数Tag 新增请求参数AddOns
	2023-03-06	新增请求参数NetworkInterfaceTrafficMode 删除返回参数
	2023-01-04	变更请求参数RamNodeTypes 新增返回参数
	2022-06-24	新增请求参数Tag
	2022-01-21	变更请求参数RamNodeTypes

1
2
10 条/页

CreateCluster_弹性高性能计算_API文档

接口说明

流控信息

授权信息

请求参数

返回参数

返回示例

错误码

变更历史

相关示例