文档

AddNodes - 批量增加计算节点

更新时间:

调用AddNodes添加一个或多个计算节点到指定集群。

调试

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

授权信息

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

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

请求参数

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

待添加节点的集群 ID。

您可以通过调用 ListClusters 获取集群 ID。

ehpc-hz-FYUr32****
ImageOwnerAliasstring

镜像类型。取值范围:

  • system:公共镜像
  • self:自定义镜像
  • others:共享镜像
  • marketplace:镜像市场镜像

默认值:system

system
ImageIdstring

为待加入集群的计算节点指定的镜像,该镜像需满足以下条件:

  • 指定的镜像的操作系统应与集群中节点的操作系统保持一致。如:集群中节点的操作系统为 CentOS 时,只能指定 CentOS 镜像。
说明 如果集群为混合云集群,并且开启支持多系统功能,当集群中节点的操作系统为 Windows 时,指定的镜像可以为 Windows、CentOS。
  • 指定的镜像应与集群节点的镜像大版本号保持一致,如待加入集群为 CentOS 7.x,指定的镜像也应该为 CentOS 7.x。

您可以通过调用 ListImagesListCustomImages 接口获取镜像 ID。

centos_7_06_64_20G_alibase_20190711.vhd
Countinteger

添加的计算节点数量。取值范围:1~99,并且 MinCount<Count。

  • ECS 库存数量<MinCount,添加节点失败。

  • MinCount<ECS 库存数量<Count,按照 MinCount 指定的数量添加节点。

  • Count<ECS 库存数量,按照 Count 指定的数量添加节点。

10
InstanceTypestring

扩容的实例规格,默认使用上次扩容或者创建集群时的计算节点实例规格。

ecs.n1.tiny
ComputeSpotStrategystring

计算节点抢占策略。当参数 EcsChargeType 取值为 PostPaid 时才生效。取值范围:

  • NoSpot:正常按量付费实例。
  • SpotWithPriceLimit:设置上限价格的抢占式实例。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格的抢占式实例。

默认值:NoSpot

NoSpot
ComputeSpotPriceLimitstring

计算节点每小时最高价格,支持最多 3 位小数。参数 SpotStrategy 取值为 SpotWithPriceLimit 时生效。

0.68
EcsChargeTypestring

集群使用节点的付费类型。取值范围:

  • PostPaid:按量付费
  • PrePaid:包年包月

默认值:PostPaid

若选择包年包月类型,默认开启自动续费,集群释放后节点将关闭自动续费。

PostPaid
Periodinteger

购买资源的时长,单位由 PeriodUnit 指定。当参数 InstanceChargeType 取值为 PrePaid 时才生效且为必选值。取值范围:

  • PeriodUnit=Week 时,Period 取值:{“1”, “2”, “3”, “4”}。
  • PeriodUnit=Month 时,Period 取值:{“1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “12”, “24”, “36”, ”48”, ”60”}。

默认值:1

1
PeriodUnitstring

购买资源的时长。取值范围:

  • Week
  • Month

默认值:Month

Month
AutoRenewstring

是否自动续费,当参数 EcsChargeType 取值为 PrePaid 时才生效。取值范围:

  • true:自动续费
  • false:不自动续费

默认值:true

true
AutoRenewPeriodinteger

每次自动续费的时长。参数 AutoRenew 取值 true 时生效。

  • PeriodUnit 为 Week 时,AutoRenewPeriod 取值{"1", "2", "3"}。
  • PeriodUnit 为 Month 时,AutoRenewPeriod 取值{"1", "2", "3", "6", "12"}。

默认值:1

1
JobQueuestring

计算节点加入的队列名称。

workq
CreateModestring

节点创建方式。取值范围:

  • manual:手动扩容
  • autoscale:自动扩容

默认值:manual

manual
SystemDiskTypestring

系统盘的云盘类型。取值范围:

  • cloud_efficiency:高效云盘
  • cloud_ssd:SSD 云盘
  • cloud_essd:ESSD 云盘
  • cloud:普通云盘,已停售。

默认值:cloud_efficiency

cloud_ssd
SystemDiskSizeinteger

系统盘的大小。单位:GiB

取值范围:40~500

默认值:40

40
ZoneIdstring

可用区 ID。

cn-hangzhou-b
VSwitchIdstring

交换机 ID。

vsw-bp1lfcjbfb099rrjn****
HostNamePrefixstring

主机名前缀。方便您分类管理节点。

compute
HostNameSuffixstring

主机名后缀。方便您分类管理节点。

01
ComputeEnableHtboolean

计算节点是否支持超线程。取值范围:

  • true:支持超线程
  • false:不支持超线程

默认值:true

true
AllocatePublicAddressboolean

是否分配公网地址。取值范围:

  • true:分配公网地址
  • false:不分配公网地址

默认值:false

false
InternetChargeTypestring

弹性公网 IP 付费类型。取值范围:

  • PayByBandwidth:按固定带宽收费
  • PayByTraffic:按使用流量计费
PayByTraffic
InternetMaxBandWidthIninteger

公网入带宽最大值,单位为 Mbit/s。取值范围:

  • 当所购公网出带宽小于等于 10Mbit/s 时:1~10,默认为 10。
  • 当所购公网出带宽大于 10Mbit/s 时:1~InternetMaxBandWidthOut 的取值,默认为 InternetMaxBandWidthOut 的取值。
10
InternetMaxBandWidthOutinteger

公网出带宽最大值,单位为 Mbit/s。取值范围:0~100

默认值:0

10
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

123e4567-e89b-12d3-a456-426655440000
SystemDiskLevelstring

创建 ESSD 云盘作为系统盘使用时,设置云盘的性能等级。取值范围:

  • PL0:单盘最高随机读写 IOPS 1 万
  • PL1:单盘最高随机读写 IOPS 5 万
  • PL2:单盘最高随机读写 IOPS 10 万
  • PL3:单盘最高随机读写 IOPS 100 万

默认值:PL1

更多 ESSD 性能参数,请参见 ESSD 云盘

PL0
MinCountinteger

指定最小添加的节点数量。取值范围:1~99,并且 MinCount<Count。

  • ECS 库存数量<MinCount,添加节点失败。

  • MinCount<ECS 库存数量<Count,按照 MinCount 指定的数量添加节点。

  • Count<ECS 库存数量,按照 Count 指定的数量添加节点。

默认值:1

1
Syncboolean

是否设置该接口为同步接口。取值范围:

  • true:是

  • false:否

默认值:false

false
DataDisksobject []

随节点创建的数据盘信息列表。

DataDiskSizeinteger

第 N 个随节点创建的数据盘容量大小。单位:GB

取值范围:40~500

默认值:40

N 的取值范围:0~16

40
DataDiskCategorystring

第 N 个随节点创建的数据盘类型。可能值:

  • cloud_efficiency:高效云盘

  • cloud_ssd:SSD 云盘

  • cloud_essd:ESSD 云盘

  • cloud:普通云盘

默认值:cloud_efficiency

N 的取值范围:0~16

cloud_efficiency
DataDiskDeleteWithInstanceboolean

第 N 个随节点创建的数据盘是否随实例释放。取值范围:

  • true:是

  • false:否

默认值:true

N 的取值范围:0~16

true
DataDiskPerformanceLevelstring

第 N 个随节点创建的数据盘类型为 ESSD 云盘时,区分性能等级。仅当 DataDisks.N.DataDiskCategory=cloud_essd 时该参数有效。取值范围:

  • PL0:单盘最高随机读写 IOPS 1 万
  • PL1:单盘最高随机读写 IOPS 5 万
  • PL2:单盘最高随机读写 IOPS 10 万
  • PL3:单盘最高随机读写 IOPS 100 万

默认值:PL1

N 的取值范围:0~16

PL1
DataDiskEncryptedboolean

第 N 个随节点创建的数据盘是否加密。取值范围:

  • true:是

  • false:否

默认值:false

N 的取值范围:0~16

false
DataDiskKMSKeyIdstring

第 N 个随节点创建的数据盘使用的 KMS 密钥 ID。

N 的取值范围:0~16

0e478b7a-4262-4802-b8cb-00d3fb40826X
ComputeSpotDurationinteger

抢占式实例的保护期,单位为小时。取值范围为 0~1,设置为 0 表示无保护期,默认为 1。

1
ComputeSpotInterruptionBehaviorstring

抢占实例中断模式。目前仅支持 Terminate(默认)直接释放实例。

Terminate
NetworkInterfaceTrafficModestring

网卡的通讯模式。参数取值范围:

  • Standard:使用 TCP 通讯模式。

  • HighPerformance:开启 ERI(Elastic RDMA Interface)接口,使用 RDMA 通讯模式。

Standard
DnsConfigstring

DNS 配置信息。

"{\"DnsType\":\"PrivateZone\",\"DnsName\":\"xxxxx\"}"

返回参数

名称类型描述示例值
object
TaskIdstring

任务 ID。

B745C159-3155-4B94-95D0-4B73D4D2****
RequestIdstring

请求 ID。

B745C159-3155-4B94-95D0-4B73D4D2****
InstanceIdsarray

实例 ID

string

实例 ID。

说明 由于 AddNodes 是异步操作,请求成功就会立即返回结果,不会等待实例创建成功,因此 InstanceIds 内容为空。您可以通过 ListNodes 获取 InstanceId。
null

示例

正常返回示例

JSON格式

{
  "TaskId": "B745C159-3155-4B94-95D0-4B73D4D2****",
  "RequestId": "B745C159-3155-4B94-95D0-4B73D4D2****",
  "InstanceIds": {
    "InstanceId": [
      "null"
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe specified parameter %s is invalid.无效的参数:%s
400NotEnabledYou have not enabled this service您的账户还未开通此服务
400InDebtYour account has overdue payments.您的账户已欠费
400InvaildSystemDiskSizeThe system disk size must be greater than or equal to image size.系统盘大小必须大于或等于镜像大小
403TooManyComputesThe number of computing nodes exceeds the quota.计算节点数超过用户配额
403TooManyLoginsThe maximum number of logged on nodes is exceeded.登录节点数超过配额,默认不超过2个。如需更多,请参考使用限制文档中的提升配额方式。
403TooManySccThe maximum number of SCC instances is exceeded.SCC实例数量超过配额,默认不超过15个。如需更多,请参考使用限制文档中的提升配额方式。
403InvalidClusterStatusThe operation failed due to invalid cluster status.集群状态不允许执行本次操作。
403ConflictOptA conflicting operation is running.有冲突的操作在执行中,请您稍后再试。
403ImageNotSupportedThe specified image is not supported.暂不支持所选的镜像,请您更换镜像后重试。
403InvalidOptThe specified operation is invalid. Please try again later.未知的操作,请检查相关参数是否合理,检查后稍后重试。
404ImageNotFoundThe specified image does not exist.指定的镜像不存在,请您检查该参数是否正确。
404ClusterNotFoundThe specified cluster does not exist.指定的集群不存在,请您检查该参数是否正确。
404VolumeNotFoundThe specified volume does not exist.指定的存储不存在,请您检查该参数是否正确。
404ManagerNotFoundThe manager nodes do not exist or their status is abnormal.管理节点不存在或状态异常。
404ObjectNotFoundThe specified object is not found.指定的对象未找到,请您检查该参数是否正确。
404KeyPairNotFoundThe specified KeyPair does not exist.指定的密钥对不存在,请您检查该参数是否正确。
406EcsErrorAn error occurred while calling the ECS API operation.ECS API调用出错
406EipErrorThe EIP API request failed.请求弹性IP失败
406DbErrorA database service error occurred.数据库请求失败
406AliyunErrorAn Alibaba Cloud product error occurred.阿里云产品错误
407NotAuthorizedYou are not authorized by RAM for this request.此请求未获得RAM授权
409PartFailurePart of the batch operation failed.批量操作部分失败
500UnknownErrorAn unknown error occurred.未知错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

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

变更历史

变更时间变更内容概要操作
2023-06-29OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:406
    删除错误码:407
    删除错误码:409
    删除错误码:500
    删除错误码:503
入参OpenAPI 入参发生变更
    新增入参:DnsConfig
2023-06-27OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
    删除错误码:403
    删除错误码:406
    删除错误码:407
    删除错误码:409
    删除错误码:500
    删除错误码:503
2023-03-06OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    删除错误码:400
    删除错误码:404
    删除错误码:406
    删除错误码:407
    删除错误码:409
    删除错误码:500
    删除错误码:503
入参OpenAPI 入参发生变更
    新增入参:NetworkInterfaceTrafficMode
2021-12-23OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:406
    删除错误码:407
    删除错误码:409
    删除错误码:500
    删除错误码:503
入参OpenAPI 入参发生变更
    新增入参:DataDisks