调用CreateHybridCluster创建一个混合云集群。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ehpc:CreateHybridCluster | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ZoneId | string | 否 | 可用区 ID。 | cn-hangzhou-b |
Name | string | 是 | 集群名称。长度 2~64 字符,只允许包含中文、字母、数字、短划线(-)和下划线(_),必须以字母或中文开头。 | hybridcluster |
Description | string | 否 | 集群描述信息。长度为 2~256 个英文或中文字符,不能以 http://和 https://开头。 默认值:空 | TestDescription |
EhpcVersion | string | 否 | E-HPC 产品版本号。默认使用最新版本。 | 1.0.0 |
ClientVersion | string | 否 | 集群客户端版本。默认使用最新版本。 | 1.0.64 |
OsTag | string | 是 | 操作系统镜像标签,您可以调用 ListImages 接口查询。 | CentOS_7.2_64 |
Domain | string | 否 | 域账号服务类型。取值范围:
默认值:nis | nis |
Location | string | 否 | 集群所在的位置。位置固定为混合云集群,取值:OnPremise。 | OnPremise |
SecurityGroupId | string | 否 | 使用已有安全组 ID 创建集群。 说明
当指定该参数时,不能同时指定 SecurityGroupName 参数。
| sg-bp13n61xsydodfyg**** |
SecurityGroupName | string | 否 | 如果不使用已有安全组,则使用此名称创建新安全组,应用默认策略。 说明
当指定该参数时,不能同时指定 SecurityGroupId 参数。
| ehpc-SecurityGroup |
VpcId | string | 是 | 集群所属的 VPC ID。 | vpc-b3f3edefefeep0760yju**** |
VSwitchId | string | 是 | 交换机 ID。 | vsw-bp1lfcjbfb099rrjn**** |
EcsOrder.Manager.InstanceType | string | 否 | 混合云集群云上管理节点规格。目前仅支持代理模式。 | ecs.n1.tiny |
EcsOrder.Compute.InstanceType | string | 是 | 集群计算节点实例规格。 | ecs.n1.tiny |
VolumeType | string | 否 | 文件系统类型。目前仅支持 NAS。 | NAS |
VolumeId | string | 否 | 存储实例 ID。目前不支持自动创建阿里云 NAS 实例。 | 008b64**** |
VolumeProtocol | string | 否 | 共享存储的协议类型。目前仅支持 NFS。 | NFS |
VolumeMountpoint | string | 否 | NAS 的 VPC 挂载点。目前不支持自动创建阿里云 NAS 挂载点。 | 008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com |
RemoteDirectory | string | 否 | 挂载文件系统的远程目录。 | /RemoteDirectory |
OnPremiseVolumeProtocol | string | 否 | 本地共享存储协议。目前仅支持 NFS。 | NFS |
OnPremiseVolumeMountPoint | string | 否 | 本地文件系统挂载点。 | RemoteNasDomain.com |
OnPremiseVolumeRemotePath | string | 否 | 本地文件系统挂载路径。 | /RemoteDirectory |
OnPremiseVolumeLocalPath | string | 否 | 本地文件系统挂载到云上节点的路径。 | /OnCloudDirectory |
Password | string | 否 | 登录节点的 root 密码。长度为 8 至 30 个字符,必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是:
说明
建议使用 HTTPS 协议调用 API 避免密码泄露。
| 123**** |
KeyPairName | string | 否 | 密钥对名称。长度为 2~128 个英文或中文字符。必须以大小字母或中文开头,不能以 http://和 https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。 说明
如果您要使用 ECS 密钥对功能,具体操作,请参见创建密钥对。
| test |
JobQueue | string | 否 | 扩容节点默认加入的队列。 | workq |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-acfmxazb4ph**** |
HybridClusterOpMode | string | 否 | 代理节点管理线下节点模式。取值范围:
| SSH |
SchedulerPreInstall | boolean | 否 | 业务镜像是否已预安装调度器。取值范围:
| true |
ComputeSpotStrategy | string | 否 | 计算节点抢占策略。取值范围:
默认值:NoSpot | NoSpot |
ComputeSpotPriceLimit | float | 否 | 计算节点下 ECS 实例的每小时最高价格。支持最多 3 位小数,参数 ComputeSpotStrategy 取值为 SpotWithPriceLimit 时生效。 | 0.034 |
ImageOwnerAlias | string | 否 | 镜像类型。取值范围:
| system |
ImageId | string | 否 | 镜像 ID。 | wi_1607_x64_dtc_zh_40G_alibase**** |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-426655440000 |
MultiOs | boolean | 否 | 集群是否支持多操作系统。取值范围:
默认值:false | false |
Nodes | object [] | 否 | 本地集群节点信息。 | |
SchedulerType | string | 否 | 本地集群节点的调度器类型。取值范围:
默认值:pbs | pbs |
IpAddress | string | 否 | 本地集群节点的 IP 地址。 | 00b648b**** |
HostName | string | 否 | 本地集群节点的主机名称。 | test1 |
Role | string | 否 | 本地集群节点的角色。取值范围:
| Compute |
AccountType | string | 否 | 本地集群节点的域账号服务类型。取值范围:
默认值:nis | nis |
Dir | string | 否 | 本地集群节点的配置目录。 | /opt/sge/default/ |
Application | object [] | 否 | 应用软件信息列表。 | |
Tag | string | 否 | 应用软件的标签。 | OpenMPI_11.1 |
PostInstallScript | object [] | 否 | 安装后脚本信息列表。 | |
Args | string | 否 | 安装后脚本的执行参数。 | bash file.sh |
Url | string | 否 | 安装后脚本的全路径。 | /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"} |
OpenldapPar | object | 否 | 对接 OpenLDAP 服务器参数。 | |
LdapServerIp | string | 否 | LDAP 服务器 IP。 | 192.168.1.2 |
BaseDn | string | 否 | LDAP 服务器 BaseDN。 | ehpctest |
FallbackHomeDir | string | 否 | Linux 服务器 home 目录。 | /home |
WinAdPar | object | 否 | 对接 Windows AD 服务器参数。 | |
AdUser | string | 否 | AD 用户。 | Administrator |
AdUserPasswd | string | 否 | AD 用户密码。 | xxxxxx |
AdDc | string | 否 | AD 域名称。 | ad-hybrid001.ehpcad.com |
AdIp | string | 否 | AD 域 IP。 | 192.168.1.2 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "F6757FA4-8FED-4602-B7F5-3550C0842122",
"TaskId": "F6757FA4-8FED-4602-B7F5-3550C0842122",
"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. | 挂载点无效,请您检查该参数是否正确。 |
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不存在,请您检查该参数是否正确。 |
406 | EcsError | An error occurred while calling the ECS API operation. | ECS API调用出错 |
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. | 生成集群ID失败,请您再重试该操作。 |
406 | DbError | A database service error occurred. | 数据库请求失败 |
406 | AliyunError | An Alibaba Cloud product error occurred. | 阿里云产品错误 |
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-05-19 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||||||||||||
| ||||||||||||||||||||||||||
2023-03-21 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||||||||||||
| ||||||||||||||||||||||||||
2022-11-15 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||||||||||||
|