建立一個隨用隨付或者預付費(訂用帳戶)叢集。
介面說明
介面說明
建立叢集會涉及相關資源計費,建議您提前瞭解 E-HPC 的計費方式。更多資訊,請參見計費方式。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ehpc:CreateCluster |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ZoneId |
string |
否 |
可用性區域 ID。 您可以調用 ListRegions 和 DescribeZones 介面擷取可以使用 E-HPC 的可用性區域 ID。 |
cn-hangzhou-b |
| Name |
string |
是 |
叢集名稱,長度為 2~64 個字元。 |
test |
| Description |
string |
否 |
叢集描述資訊。長度為 2~256 個英文或中文字元,不能以 |
TestDescription |
| EhpcVersion |
string |
否 |
E-HPC 產品版本,預設為最新版本。 |
1.0.0 |
| ClientVersion |
string |
否 |
叢集用戶端版本,預設為最新版本。 您可以調用 ListCurrentClientVersion 查詢當前最新用戶端版本號碼。 |
1.0.64 |
| OsTag |
string |
否 |
作業系統鏡像標籤。 |
CentOS_7.2_64 |
| AccountType |
string |
否 |
域帳號服務類型。取值範圍:
預設值:nis。 |
nis |
| Domain |
string |
否 |
本地叢集網域名稱。 僅當 AccoutType 取值為 Idap 時,支援配置該參數。 |
ldap |
| SchedulerType |
string |
否 |
調度器類型。取值範圍:
預設值:pbs。 |
pbs |
| SecurityGroupId |
string |
否 |
指定新建立叢集所屬的安全性群組 ID。 您可以調用 DescribeSecurityGroups 查詢當前地區可以使用的安全性群組。 |
sg-bp13n61xsydodfyg**** |
| SecurityGroupName |
string |
否 |
如果不使用已有安全性群組,則使用此名稱建立新安全性群組,應用預設安全性群組策略。 |
ehpc-SecurityGroup |
| VpcId |
string |
否 |
叢集所屬的 VPC ID。 您可以調用 DescribeVpcs 查詢已建立的 VPC 資訊。 |
vpc-b3f3edefefeep0760yju**** |
| VSwitchId |
string |
否 |
VPC 中交換器 ID。E-HPC 當前僅支援 VPC 網路。 您可以調用 DescribeVSwitches 查詢已建立的交換器的相關資訊。 |
vsw-bp1lfcjbfb099rrjn**** |
| VolumeType |
string |
否 |
共用儲存類型,目前僅支援配置為 |
nas |
| VolumeId |
string |
否 |
阿里雲 NAS 執行個體 ID。如果該參數為空白,建立叢集的流程會預設建立一個效能型的 NAS 執行個體。 您可以調用 ListFileSystemWithMountTargets 查詢可用的 NAS 的 VPC 掛載點。 |
008b64**** |
| VolumeProtocol |
string |
否 |
共用儲存的協議類型。取值範圍:
預設值:NFS。 |
NFS |
| VolumeMountpoint |
string |
否 |
NAS 的 VPC 掛載點。VolumeMountpoint 有以下限制:
|
008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com |
| VolumeMountOption |
string |
否 |
採用 mount 命令手動掛載 NFS 檔案系統時的掛載參數。
具體請參見手動掛載 NFS 檔案系統。 |
-t nfs -o vers=4 |
| RemoteDirectory |
string |
否 |
掛載共用儲存的遠程目錄。 |
NasMountpoint:/RemoteDirectory |
| DeployMode |
string |
否 |
叢集部署模式。取值範圍:
預設值:Standard。 |
Simple |
| HaEnable |
boolean |
否 |
是否開啟高可用。取值範圍:
預設值:false。 說明
若開啟高可用則叢集中的每種管控角色將會使用主備 2 個節點。 |
true |
| EcsChargeType |
string |
否 |
叢集中所有節點的付費類型,取值範圍:
若選擇訂用帳戶類型,預設開啟自動續約。 |
PostPaid |
| Password |
string |
否 |
登入節點的 root 密碼。 說明
建議使用 HTTPS 協議調用 API 避免密碼泄露。 密碼格式要求:
說明
叢集的登入憑證支援密碼和金鑰組兩種,Password 和 KeyPairName 二者必選其一,如果二者都指定,則 Password 優先順序高。 |
123**** |
| KeyPairName |
string |
否 |
登入節點綁定的金鑰組名稱。關於如何建立金鑰組,請參見建立金鑰組。 說明
叢集的登入憑證支援密碼和金鑰組兩種,Password 和 KeyPairName 二者必選其一,如果二者都指定,則 Password 優先順序高。 |
test |
| ImageOwnerAlias |
string |
否 |
鏡像類型。取值範圍:
預設值:system。 |
self |
| ImageId |
string |
否 |
鏡像 ID。 您可以調用 ListImages 和 ListCustomImages 查詢 E-HPC 可以使用的鏡像 ID。 |
centos_7_02_64_20G_alibase_20170818**** |
| EcsOrder.Manager.Count |
integer |
否 |
叢集管控節點數量。取值範圍:1~2。 |
1 |
| EcsOrder.Manager.InstanceType |
string |
否 |
叢集管控節點規格。 您可以調用 ListPreferredEcsTypes 介面擷取推薦的節點規格資訊。 |
ecs.n1.tiny |
| EcsOrder.Compute.Count |
integer |
否 |
叢集計算節點數量。取值範圍:0~99。 |
1 |
| EcsOrder.Compute.InstanceType |
string |
否 |
叢集計算節點規格。 您可以調用 ListPreferredEcsTypes 介面擷取推薦的節點規格資訊。 |
ecs.n1.tiny |
| EcsOrder.Login.Count |
integer |
否 |
叢集登入節點數量,僅支援配置 1。 |
1 |
| EcsOrder.Login.InstanceType |
string |
否 |
叢集登入節點規格。 您可以調用 ListPreferredEcsTypes 介面擷取推薦的節點規格資訊。 |
ecs.n1.tiny |
| SccClusterId |
string |
否 |
SCC 執行個體 ID。 如果配置該參數,則將已有的 SCC 執行個體納管到新建立的 SCC 叢集中。 |
00b648b**** |
| ComputeSpotStrategy |
string |
否 |
計算節點競價策略。取值範圍:
預設值:NoSpot。 |
NoSpot |
| ComputeSpotPriceLimit |
string |
否 |
計算節點每小時最高價格。最大支援 3 位小數,參數 ComputeSpotStrategy 取值為 SpotWithPriceLimit 時生效。 |
0.034 |
| ComputeEnableHt |
boolean |
否 |
計算節點是否支援超執行緒。取值範圍:
預設值:true。 |
true |
| Period |
integer |
否 |
購買叢集節點的時間長度。單位由
預設值:1。 |
1 |
| PeriodUnit |
string |
否 |
購買叢集節點的時間長度單位。取值範圍:
預設值:Month。 |
Year |
| AutoRenew |
string |
否 |
是否自動續約。取值範圍:
預設值:false。 |
false |
| AutoRenewPeriod |
integer |
否 |
每次自動續約的時間長度,當參數 AutoRenew 取值 true 時生效。 |
1 |
| InputFileUrl |
string |
否 |
上傳到 OSS 的作業檔案的 URL 地址。 |
https://ehpc-tianshui.oss-cn-beijing.aliyuncs.com/test-u****/testlist_ehpc.sh |
| JobQueue |
string |
否 |
計算節點加入的隊列名稱。 |
workq |
| SystemDiskType |
string |
否 |
系統硬碟的雲端硬碟種類。取值範圍:
預設值:cloud_ssd。 |
cloud_ssd |
| SystemDiskSize |
integer |
否 |
系統硬碟大小。單位:GB。 取值範圍:40~500。 預設值:40。 |
40 |
| RemoteVisEnable |
string |
否 |
是否開啟遠程可視化。取值範圍:
預設值:false。 |
false |
| ResourceGroupId |
string |
否 |
資源群組 ID。 您可以調用 ListResourceGroups 查詢資源群組 ID。 |
rg-acfmxazb4ph**** |
| ClientToken |
string |
否 |
保證請求等冪性。從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元,且不能超過 64 個字元。更多資訊,請參見如何保證等冪性。 |
123e4567-e89b-12d3-a456-426655440000 |
| WithoutElasticIp |
boolean |
否 |
登入節點是否使用彈性公網 IP。預設值:false。 |
true |
| SystemDiskLevel |
string |
否 |
建立 ESSD 雲端硬碟作為系統硬碟使用時,設定雲端硬碟的效能等級。取值範圍:
預設值:PL1。 關於如何選擇 ESSD 效能等級,請參見 ESSD 雲端硬碟。 |
PL0 |
| IsComputeEss |
boolean |
否 |
是否啟用自動調整。取值範圍:
預設值:false。 |
false |
| ClusterVersion |
string |
否 |
叢集版本號碼。 預設值:1.0。 |
1.0 |
| Application |
array<object> |
否 |
應用軟體資訊。 |
|
|
object |
否 |
應用軟體資訊。 |
||
| Tag |
string |
否 |
應用軟體的標籤。 N 的取值範圍:0~100 您可以調用 ListSoftwares 查詢應用軟體標籤。 |
OpenMPI_11.1 |
| AdditionalVolumes |
array<object> |
否 |
掛載的共用儲存資訊。 |
|
|
array<object> |
否 |
掛載的共用儲存資訊。 |
||
| JobQueue |
string |
否 |
掛載共用儲存的節點作業所處隊列。 N 的取值範圍:1~10。 |
high |
| VolumeId |
string |
否 |
掛載的 NAS 執行個體 ID。 N 的取值範圍:1~10。 |
extreme-00b88**** |
| Roles |
array<object> |
否 |
共用儲存掛載到新 NAS 上的節點資訊。 |
|
|
object |
否 |
共用儲存掛載到新 NAS 上的節點資訊。 |
||
| Name |
string |
否 |
共用儲存掛載到新 NAS 上的節點類型。 AdditionalVolumes.N.Roles 中 N 的取值範圍:1~10。 Roles.N.Name 中 N 的取值範圍:0~8。 |
["Compute"] |
| VolumeMountpoint |
string |
否 |
掛載的 NAS 的 VPC 掛載點。 N 的取值範圍:1~10。 |
0088****-sihc.cn-hangzhou.extreme.nas.aliyuncs.com |
| VolumeMountOption |
string |
否 |
NAS 的掛載選項。 N 的取值範圍:1~10。 |
-t nfs -o vers=4.0 |
| RemoteDirectory |
string |
否 |
掛載的共用儲存的遠程目錄。 N 的取值範圍:1~10。 |
/test |
| VolumeType |
string |
否 |
掛載的共用儲存類型。目前僅支援 NAS。 N 的取值範圍:1~10 |
nas |
| LocalDirectory |
string |
否 |
掛載的共用儲存的本地掛載目錄。 N 的取值範圍:1~10。 |
/ff |
| VolumeProtocol |
string |
否 |
掛載的共用儲存協議類型。取值範圍:
N 的取值範圍:1~10。 預設值:NFS。 |
NFS |
| Location |
string |
否 |
掛載的共用儲存的叢集類型,只能配置 PublicCloud。 N 的取值範圍:1~10。 |
PublicCloud |
| PostInstallScript |
array<object> |
否 |
安裝後指令碼資訊。 |
|
|
object |
否 |
安裝後指令碼資訊。 |
||
| Args |
string |
否 |
安裝後指令碼的執行參數。 N 的取值範圍:0~16。 |
bashfile.sh |
| Url |
string |
否 |
安裝後指令碼的下載地址。 N 的取值範圍:0~16。 |
/opt/job.sh |
| Plugin |
string |
否 |
外掛程式模式配置,僅當 SchedulerType 為 custom 生效。 格式為 JSON 字串,包含 pluginMod、pluginLocalPath、pluginOssPath 三個參數,具體參數說明如下:
|
{"pluginMod": "oss","pluginLocalPath": "/opt/plugin","pluginOssPath": "https://bucket.oss-cn-hangzhou.aliyuncs.com/plugin/plugin.tgz"} |
| WithoutAgent |
boolean |
否 |
是否不安裝 Agent 用戶端。
預設值:false。 |
false |
| WithoutNas |
boolean |
否 |
是否不使用 NAS 作為共用儲存。取值範圍:
預設值:false。 |
false |
| RamRoleName |
string |
否 |
執行個體 RAM 角色名稱。 您可以使用 RAM API ListRoles 查詢您已建立的執行個體 RAM 角色。 |
testRamRoleName |
| NetworkInterfaceTrafficMode |
string |
否 |
彈性網卡的通訊模式。取值範圍:
|
Standard |
| DeploymentSetId |
string |
否 |
部署集 ID。 您可以通過 DescribeDeploymentSets 擷取部署集 ID,當前僅支援網路低時延策略的部署集。 |
ds-bp1frxuzdg87zh4pzq**** |
| RamNodeTypes |
array |
否 |
授權執行個體角色的節點名稱詳情。 |
Standard |
|
string |
否 |
授權執行個體角色的節點名稱。 N 的取值範圍:0~4。
|
manager |
|
| Tag |
array<object> |
否 |
標籤數組。 |
|
|
object |
否 |
標籤數組。 |
scheduler |
|
| Key |
string |
否 |
標籤鍵。 |
TestKey |
| Value |
string |
否 |
標籤值。 |
TestValue |
| AddOns |
array<object> |
否 |
自訂群組件服務。 |
|
|
object |
否 |
自訂群組件服務。 |
||
| Name |
string |
否 |
組件名稱。 |
cromwell |
| Version |
string |
否 |
組件版本號碼。 |
85 |
| DeployMode |
string |
否 |
部署模式。取值範圍:local,ecs。 |
local |
| DBType |
string |
否 |
資料庫類型。取值範圍:Mysql,null。 |
Mysql |
| ConfigFile |
string |
否 |
設定檔路徑。 |
/usr/local/addon/cromwell/cromwell.conf |
| Port |
number |
否 |
自訂群組件訪問連接埠。 |
10000 |
| DefaultStart |
boolean |
否 |
自訂群組件是否自啟動。取值範圍:true,false。 |
true |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
F6757FA4-8FED-4602-B7F5-3550C084**** |
| TaskId |
string |
任務 ID。 說明
由於 CreateCluster 是非同步作業,請求成功就會立即返回結果,不會等待節點建立成功。您可以調用 ListTasks 查詢任務運行結果。 |
F6757FA4-8FED-4602-B7F5-3550C084**** |
| ClusterId |
string |
叢集 ID。 |
ehpc-hz-FYUr32**** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "F6757FA4-8FED-4602-B7F5-3550C084****",
"TaskId": "F6757FA4-8FED-4602-B7F5-3550C084****",
"ClusterId": "ehpc-hz-FYUr32****"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParams | The specified parameter %s is invalid. | 指定的參數 %s 無效。 |
| 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. | 賬戶餘額不足100元,請您先儲值後再重試。 |
| 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. | VPC資訊無效,請您檢查該參數是否正確。 |
| 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. | 參數缺失:%s |
| 500 | UnknownError | An unknown error occurred. | 未知錯誤 |
| 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. | 登入節點數超過配額,預設不超過2個。如需更多,請參考使用限制文檔中的提升配額方式。 |
| 403 | TooManyScc | The maximum number of SCC instances is exceeded. | SCC執行個體數量超過配額,預設不超過15個。如需更多,請參考使用限制文檔中的提升配額方式。 |
| 403 | QuotaExceeded.PrivateIpAddress | Insufficient private IP addresses in vSwitch: %s. | vSwitch可用私網IP不足量: %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. | 指定的VPC不存在,請您檢查該參數是否正確。 |
| 404 | KeyPairNotFound | The specified KeyPair does not exist. | 指定的金鑰組不存在,請您檢查該參數是否正確。 |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server | 請求失敗,服務暫時不可用 |
| 406 | EcsError | An error occurred while calling the ECS API operation. | ECS API調用出錯. %s |
| 406 | NasError | NAS API request failed. | NAS介面請求失敗 |
| 406 | NasServiceNotOpen | The NAS service is not activated. | NAS服務未開通 |
| 406 | EipError | The EIP API request failed. | 請求彈性IP失敗 |
| 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. | 阿里雲產品錯誤。%s |
| 406 | AckError | An error occurred while calling the ACK API operation. | ACK API調用出錯 |
| 407 | NotAuthorized | No authorization is granted. | 未授權 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。