调用AddNodes添加一个或多个计算节点到指定集群。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ehpc:AddNodes | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClusterId | string | 是 | 待添加节点的集群 ID。 您可以通过调用 ListClusters 获取集群 ID。 | ehpc-hz-FYUr32**** |
ImageOwnerAlias | string | 否 | 镜像类型。取值范围:
默认值:system | system |
ImageId | string | 否 | 为待加入集群的计算节点指定的镜像,该镜像需满足以下条件:
说明
如果集群为混合云集群,并且开启支持多系统功能,当集群中节点的操作系统为 Windows 时,指定的镜像可以为 Windows、CentOS。
您可以通过调用 ListImages 和 ListCustomImages 接口获取镜像 ID。 | centos_7_06_64_20G_alibase_20190711.vhd |
Count | integer | 是 | 添加的计算节点数量。取值范围:1~99,并且 MinCount<Count。
| 10 |
InstanceType | string | 否 | 扩容的实例规格,默认使用上次扩容或者创建集群时的计算节点实例规格。 | ecs.n1.tiny |
ComputeSpotStrategy | string | 否 | 计算节点抢占策略。当参数 EcsChargeType 取值为 PostPaid 时才生效。取值范围:
默认值:NoSpot | NoSpot |
ComputeSpotPriceLimit | string | 否 | 计算节点每小时最高价格,支持最多 3 位小数。参数 SpotStrategy 取值为 SpotWithPriceLimit 时生效。 | 0.68 |
EcsChargeType | string | 否 | 集群使用节点的付费类型。取值范围:
默认值:PostPaid 若选择包年包月类型,默认开启自动续费,集群释放后节点将关闭自动续费。 | PostPaid |
Period | integer | 否 | 购买资源的时长,单位由 PeriodUnit 指定。当参数 InstanceChargeType 取值为 PrePaid 时才生效且为必选值。取值范围:
默认值:1 | 1 |
PeriodUnit | string | 否 | 购买资源的时长。取值范围:
默认值:Month | Month |
AutoRenew | string | 否 | 是否自动续费,当参数 EcsChargeType 取值为 PrePaid 时才生效。取值范围:
默认值:true | true |
AutoRenewPeriod | integer | 否 | 每次自动续费的时长。参数 AutoRenew 取值 true 时生效。
默认值:1 | 1 |
JobQueue | string | 否 | 计算节点加入的队列名称。 | workq |
CreateMode | string | 否 | 节点创建方式。取值范围:
默认值:manual | manual |
SystemDiskType | string | 否 | 系统盘的云盘类型。取值范围:
默认值:cloud_efficiency | cloud_ssd |
SystemDiskSize | integer | 否 | 系统盘的大小。单位:GiB 取值范围:40~500 默认值:40 | 40 |
ZoneId | string | 否 | 可用区 ID。 | cn-hangzhou-b |
VSwitchId | string | 否 | 交换机 ID。 | vsw-bp1lfcjbfb099rrjn**** |
HostNamePrefix | string | 否 | 主机名前缀。方便您分类管理节点。 | compute |
HostNameSuffix | string | 否 | 主机名后缀。方便您分类管理节点。 | 01 |
ComputeEnableHt | boolean | 否 | 计算节点是否支持超线程。取值范围:
默认值:true | true |
AllocatePublicAddress | boolean | 否 | 是否分配公网地址。取值范围:
默认值:false | false |
InternetChargeType | string | 否 | 弹性公网 IP 付费类型。取值范围:
| PayByTraffic |
InternetMaxBandWidthIn | integer | 否 | 公网入带宽最大值,单位为 Mbit/s。取值范围:
| 10 |
InternetMaxBandWidthOut | integer | 否 | 公网出带宽最大值,单位为 Mbit/s。取值范围:0~100 默认值:0 | 10 |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-426655440000 |
SystemDiskLevel | string | 否 | 创建 ESSD 云盘作为系统盘使用时,设置云盘的性能等级。取值范围:
默认值:PL1 更多 ESSD 性能参数,请参见 ESSD 云盘。 | PL0 |
MinCount | integer | 否 | 指定最小添加的节点数量。取值范围:1~99,并且 MinCount<Count。
默认值:1 | 1 |
Sync | boolean | 否 | 是否设置该接口为同步接口。取值范围:
默认值:false | false |
DataDisks | object [] | 否 | 随节点创建的数据盘信息列表。 | |
DataDiskSize | integer | 否 | 第 N 个随节点创建的数据盘容量大小。单位:GB 取值范围:40~500 默认值:40 N 的取值范围:0~16 | 40 |
DataDiskCategory | string | 否 | 第 N 个随节点创建的数据盘类型。可能值:
默认值:cloud_efficiency N 的取值范围:0~16 | cloud_efficiency |
DataDiskDeleteWithInstance | boolean | 否 | 第 N 个随节点创建的数据盘是否随实例释放。取值范围:
默认值:true N 的取值范围:0~16 | true |
DataDiskPerformanceLevel | string | 否 | 第 N 个随节点创建的数据盘类型为 ESSD 云盘时,区分性能等级。仅当 DataDisks.N.DataDiskCategory=cloud_essd 时该参数有效。取值范围:
默认值:PL1 N 的取值范围:0~16 | PL1 |
DataDiskEncrypted | boolean | 否 | 第 N 个随节点创建的数据盘是否加密。取值范围:
默认值:false N 的取值范围:0~16 | false |
DataDiskKMSKeyId | string | 否 | 第 N 个随节点创建的数据盘使用的 KMS 密钥 ID。 N 的取值范围:0~16 | 0e478b7a-4262-4802-b8cb-00d3fb40826X |
ComputeSpotDuration | integer | 否 | 抢占式实例的保护期,单位为小时。取值范围为 0~1,设置为 0 表示无保护期,默认为 1。 | 1 |
ComputeSpotInterruptionBehavior | string | 否 | 抢占实例中断模式。目前仅支持 Terminate(默认)直接释放实例。 | Terminate |
NetworkInterfaceTrafficMode | string | 否 | 网卡的通讯模式。参数取值范围:
| Standard |
DnsConfig | string | 否 | DNS 配置信息。 | "{\"DnsType\":\"PrivateZone\",\"DnsName\":\"xxxxx\"}" |
返回参数
示例
正常返回示例
JSON
格式
{
"TaskId": "B745C159-3155-4B94-95D0-4B73D4D2****",
"RequestId": "B745C159-3155-4B94-95D0-4B73D4D2****",
"InstanceIds": {
"InstanceId": [
"null"
]
}
}
错误码
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 | InvaildSystemDiskSize | The system disk size must be greater than or equal to image size. | 系统盘大小必须大于或等于镜像大小 |
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 | InvalidClusterStatus | The operation failed due to invalid cluster status. | 集群状态不允许执行本次操作。 |
403 | ConflictOpt | A conflicting operation is running. | 有冲突的操作在执行中,请您稍后再试。 |
403 | ImageNotSupported | The specified image is not supported. | 暂不支持所选的镜像,请您更换镜像后重试。 |
403 | InvalidOpt | The specified operation is invalid. Please try again later. | 未知的操作,请检查相关参数是否合理,检查后稍后重试。 |
404 | ImageNotFound | The specified image does not exist. | 指定的镜像不存在,请您检查该参数是否正确。 |
404 | ClusterNotFound | The specified cluster does not exist. | 指定的集群不存在,请您检查该参数是否正确。 |
404 | VolumeNotFound | The specified volume does not exist. | 指定的存储不存在,请您检查该参数是否正确。 |
404 | ManagerNotFound | The manager nodes do not exist or their status is abnormal. | 管理节点不存在或状态异常。 |
404 | ObjectNotFound | The specified object is not found. | 指定的对象未找到,请您检查该参数是否正确。 |
404 | KeyPairNotFound | The specified KeyPair does not exist. | 指定的密钥对不存在,请您检查该参数是否正确。 |
406 | EcsError | An error occurred while calling the ECS API operation. | ECS API调用出错 |
406 | EipError | The EIP API request failed. | 请求弹性IP失败 |
406 | DbError | A database service error occurred. | 数据库请求失败 |
406 | AliyunError | An Alibaba Cloud product error occurred. | 阿里云产品错误 |
407 | NotAuthorized | You are not authorized by RAM for this request. | 此请求未获得RAM授权 |
409 | PartFailure | Part of the batch operation failed. | 批量操作部分失败 |
500 | UnknownError | An unknown error occurred. | 未知错误 |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server | 请求失败,服务暂时不可用 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-06-29 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||||||||||
| ||||||||||||||||||||||||
2023-06-27 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||||||||||
| ||||||||||||||||||||||||
2023-03-06 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||||||||||
| ||||||||||||||||||||||||
2021-12-23 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||||||||||
|