AI 助理
备案控制台
文档
输入文档关键字查找
首页 云服务器 ECS 开发参考 API参考（ECS） API目录 资源保障 CreateElasticityAssurance - 创建弹性保障服务

CreateElasticityAssurance - 创建弹性保障服务

更新时间：
产品详情
我的收藏

通过指定弹性保障服务所属地域下的可用区、实例规格等参数创建弹性保障服务。

接口说明

弹性保障服务为您提供了兼顾灵活性和确定性的全新的资源购买和使用方式，是一种能够为按量付费的 ECS 实例提供确定性保障的资源预定服务。更多信息，请参见弹性保障概述。

  • 购买弹性保障服务后，不支持退款。
  • 弹性保障服务只能创建计费方式为按量付费的 ECS 实例。
  • 目前弹性保障次数只开放了无限次的模式，即AssuranceTimes参数只支持设置为Unlimited。无限次模式的弹性保障服务在保障生效后，将自动启动。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring是

弹性保障服务所属地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
ResourceGroupIdstring否

弹性保障服务所在的企业资源组 ID。

rg-bp67acfmxazb4p****
Tagarray<object>否

弹性保障服务的标签列表。

object否

标签对信息。

Keystring否

弹性保障服务的标签键。N 的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以aliyun和acs:开头，不能包含http://或者https://。

TestKey
Valuestring否

弹性保障服务的标签值。N 的取值范围：1~20。一旦传入该值，允许为空字符串。最多支持 128 个字符，不能以acs:开头，不能包含http://或者https://。

TestValue
Periodinteger否

购买时长。时长单位由PeriodUnit参数确定。取值范围：

  • 当PeriodUnit参数值为Month时，该参数的取值：1、2、3、4、5、6、7、8、9。
  • 当PeriodUnit参数值为Year时，该参数的取值：1、2、3、4、5。

默认值：1。

1
PeriodUnitstring否

时长单位。取值范围：

  • Month：月
  • Year：年

默认值：Year。

Year
ClientTokenstring否

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

0c593ea1-3bea-11e9-b96b-88e9fe637760
PrivatePoolOptions.Namestring否

弹性保障服务的名称。长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头，不能以http://和https://开头。可以包含数字、半角冒号（:）、下划线（_）或者连字符（-）。

eapTestName
Descriptionstring否

弹性保障服务的描述信息。长度为 2~256 个英文或中文字符，不能以http://和https://开头。

默认值：空。

This is description.
PrivatePoolOptions.MatchCriteriastring否

弹性保障服务的匹配模式。取值范围：

  • Open：开放模式的弹性保障服务。实例启动时将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量，则使用公共池资源启动。
  • Target：指定模式的弹性保障服务。实例启动时将使用指定的私有池容量，如果该私有池容量不可用，则实例会启动失败。

默认值：Open。

Open
AssuranceTimesstring否

弹性保障的总次数。取值：Unlimited，目前仅支持在服务生效期内的无限次模式。

默认值：Unlimited。

Unlimited
InstanceAmountinteger否

在一个实例规格内，需要预留的实例的总数量。

取值范围：1~1000。

2
InstanceCpuCoreCountinteger否
说明 该参数已废弃。
null
StartTimestring否

弹性保障服务生效时间。默认为调用该接口创建服务的时间。时间格式以 ISO 8601 为标准，需要使用 UTC +0 时间，格式为yyyy-MM-ddTHH:mm:ssZ。更多信息，请参见ISO 8601。

2020-10-30T06:32:00Z
ZoneIdarray是

弹性保障服务所属地域下的可用区 ID。目前仅支持在一个可用区下创建弹性保障服务。

string是

弹性保障服务所属地域下的可用区 ID。

cn-hangzhou-h
InstanceTypearray是

实例规格。目前仅支持为一个实例规格设置弹性保障服务。

string是

实例规格。

ecs.c6.xlarge

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PrivatePoolOptionsIdstring

弹性保障服务 ID。

eap-bp67acfmxazb4****
OrderIdstring

生成的订单 ID。

1234567890

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PrivatePoolOptionsId": "eap-bp67acfmxazb4****",
  "OrderId": "1234567890"
}

错误码

HTTP status code错误码错误信息描述
400OperationDeniedThe specified InstanceType or Zone is not available or not authorized.指定的实例规格或可用区不可用或者未授权。
400MissingParameter.RegionIdThe specified RegionId should not be null.RegionId是必选参数。
400InvalidStartTime.NotSupportedThe specified StartTime should be within 180 calendar days from the current date, and you must specify a precision to hour.指定的 StartTime 参数不在有效取值范围内。
400InvalidStartTime.MalFormedThe specified StartTime is out of the permitted range.指定的 StartTime 参数超出了最大有效取值。
400Invalid.PrivatePoolOptionsName.MalFormedThe specified PrivatePoolOptions.Name is not valid.-
400Invalid.ZoneIdThe specified ZoneId is not valid.-
400Invalid.InstanceTypeThe specified InstanceType is not valid.-
400DedicatedHostNotSupportedDedicatedHost is not supported for PrivatePool.私有池不支持专有宿主机。
400SpotNotSupportedSpot is not supported for PrivatePool.私有池不支持抢占式实例。
400ClassicNetworkNotSupportedClassic network is not supported for PrivatePool.私有池不支持经典网络类型实例。
400Invalid.InstanceIdInstance does not exist.实例不存在。
400Invalid.PrivatePoolOptions.MatchCriteriaTarget mode does not support this operation.Target模式不支持本次操作。
400MissingParameter.PrivatePoolOptions.IdThe specified PrivatePoolOptions.Id should not be null.PrivatePoolOptions.Id 参数不能为空。
400Invalid.PrivatePoolOptions.IdThe PrivatePool does not exist.私有池不存在。
400Invalid.InstanceTypeThe InstanceType does not match the PrivatePool.实例类型与私有池不匹配。
400Invalid.InstanceChargeTypeThe InstanceChargeType does not match the PrivatePool.实例计费类型与私有池不匹配。
400Invalid.ZoneIdThe ZoneId does not match the PrivatePool.可用区与私有池不匹配。
400Invalid.PrivatePoolOptions.statusThe PrivatePool has been used up.-
400Invalid.PrivatePoolOptions.MatchCriteriaThe PrivatePoolOptions.MatchCriteria does not match the PrivatePool.指定的PrivatePoolOptions.MatchCriteria参数与私有池不匹配。
400InvalidPlatform.ValueNotSupportedThe Platform does not match the PrivatePool.指定的Platform参数与私有池不匹配。
400Invalid.PrivatePoolOptions.statusThe PrivatePool is expired or inactive.-
400Invalid.PrivatePoolOptions.statusThe PrivatePool status is not valid.-
400Invalid.PrivatePoolOptions.statusThe Instance should be created within 48 hours once the PrivatePool is started.-
400InvalidAliUidThe PrivatePool does not belong to the user of the Instance.私有池不属于创建实例的用户。
400Invalid.InstanceIdThe Instance dose not attached to a PrivatePool.实例未与私有池匹配。
400MissingParameter.PackageTypeThe specified parameter "PackageType" can not be empty.-
400MissingParameter.PrivatePoolOptions.IdsThe specified parameter "PrivatePoolOptions.Ids" can not be empty.-
400MissingParameter.PrivatePoolOptions.IdThe specified parameter "PrivatePoolOptions.Id" can not be empty.-
400MissingParameter.InstanceCpuCoreCountThe specified parameter "InstanceCpuCoreCount" can not be empty.-
400MissingParameter.InstanceAmountThe specified parameter "InstanceAmount" can not be empty.-
400MissingParameter.InstanceCpuCoreCountOrInstanceAmountThe specified parameter "InstanceCpuCoreCount" and "InstanceAmount" must not be empty at the same time.-
400Invalid.TooManyPrivatePoolOptions.IdsToo many PrivatePoolOptions.Ids in this request.PrivatePoolOptions.Ids参数超过上限。
400Invalid.TooManyZoneIdsToo many ZoneIds in the request.ZoneIds参数超过上限。
400Invalid.TooManyInstanceTypesToo many InstanceTypes in the request.InstanceTypes参数超过上限。
400Invalid.TooManyUnpaidPrivatePoolToo many PrivatePools create but still unpaid.多个私有池未支付。
400Invalid.InstanceCpuCoreCountOrInstanceAmountBoth InstanceCpuCoreCount and InstanceAmount are provided.InstanceCpuCoreCount和InstanceAmount两个参数不需要同时提供。
400Invalid.PrivatePoolOptions.IdsThe specified parameter "PrivatePoolOptions.Ids" exist invalid element Id.-
400Invalid.PackageTypeThe specified parameter "PackageType" is invalid.-
400Invalid.PrivatePool.PurchaseThe PrivatePool has already paid.私有池已经支付。
400Invalid.AssuranceTimes.NotSupportedThe value of AssuranceTimes is not supported.AssuranceTimes参数值不支持。
400Invalid.TooManyInstanceTypesThe specified parameter "InstanceType" should only has one item.-
400Invalid.PrivatePoolOptions.MatchCriteriaThe specified parameter "PrivatePoolOptions.MatchCriteria" is invalid.-
400RepeatStartPrivatePoolPrivatePool has already been started.私有池已经启动。
400Invalid.PrivatePoolOptions.IdThe specified parameter "PrivatePoolOptions.Id" should be empty.-
400Invalid.InstanceIdModify DedicatedHost Instance's attachment attributes is not supported.-
400Invalid.InstanceIdModify Spot Instance's attachment attributes is not supported.-
400Invalid.InstanceIdModify Classic Network Instance's attachment attributes is not supported.-
400Invalid.PeriodUnitOnly Month or Year is supported for PeriodUnit.-
400AccountForbidden.ProductCreationLimitedThe commodity must be officially operated by Aliyun and in pay-as-you-go billing method.集团上云客户只能购买按量付费的 ECS，且不能购买第三方的商品比如由镜像市场提供的镜像。请检查参数，传入符合条件的参数重试。
400RegionUnauthorizedThere is no authority to create private pool in the specified region.在指定的地域内没有创建私有池的权限
400PriceNotFoundThe price of your queried resource is not available now, please try other resources.未找到价格，请修改相应的参数值重试。
403Zone.NotOpenThe specified zone is not granted to you to buy resources yet.用户未被授权购买指定的可用区的资源。
403InvalidResourceType.NotSupported%s-
403OperationDenied.NoStockThe resource is out of stock in the specified zone. Please try other types, or choose other regions and zones.指定的资源在指定可用区中无货。请尝试其他类型，或选择其他可用区和地域。
403InvalidInstanceType.NotSupportedThe specified InstanceType is invalid.指定的参数“InstanceType”无效。
403Invalid.ZoneIdsAt least one of the specified ZoneIds are invalid.-
403Zone.NotOnSaleThe specified zone is not available for purchase.指定可用区已经售罄，请您更换实例规格或者更换地域创建。
404InvalidZoneId.NotFoundThe specified zoneId does not exist.指定的可用区 ID 不存在。
404InvalidResourceGroup.NotFoundThe ResourceGroup provided does not exist in our records.资源组并不在记录中。
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误，请重试。

访问错误中心查看更多错误码。
上一篇：资源保障下一篇：DescribeElasticityAssurances - 查询弹性保障服务的信息
文档推荐