调用PurchaseReservedInstancesOffering购买一张预留实例券。预留实例券可以自动匹配对应的ECS实例,抵扣按量付费实例账单。

接口说明

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String PurchaseReservedInstancesOffering

系统规定参数。取值:PurchaseReservedInstancesOffering

RegionId String cn-hangzhou

实例所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

Tag.N.Key String TestKey

预留实例券的标签键。N的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以aliyunacs:开头,不能包含http://或者https://

Tag.N.Value String TestValue

预留实例券的标签值。N的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以aliyunacs:开头,不能包含http://或者https://

ResourceGroupId String rg-bp199lyny9b3****

资源组ID。

ZoneId String cn-hangzhou-g

实例所属的可用区编号,当ScopeZone时必填。更多信息,请参见DescribeZones获取可用区列表。

ReservedInstanceName String testReservedInstanceName

预留实例券的名称。长度为2~128个英文或中文字符。必须以大小写字母或中文开头,不能以 http:// 和 https:// 开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

InstanceType String ecs.g5.large

实例的资源规格。更多信息,请参见实例规格族

Scope String Zone

预留实例券的范围。取值范围:

  • Region:地域级别。
  • Zone:可用区级别。

默认值:Region。

InstanceAmount Integer 3

预留实例券可以同时匹配同规格按量付费实例的数量。取值范围:1~50。

例如,实例规格设置为ecs.g5.large,预留实例数量设置为3时,该预留实例券就可以同时匹配3台规格为ecs.g5.large的按量付费实例。

OfferingType String All Upfront

预留实例券的付款类型。取值范围:

  • No Upfront:零预付。
  • Partial Upfront:部分预付。
  • All Upfront:全预付。

默认值:All Upfront。

Description String testDescription

预留实例券的描述。长度为2~256个英文或中文字符,不能以http://和https://开头。

默认值:空。

Platform String Linux

实例使用的镜像的操作系统类型。取值范围:

  • Windows:Windows Server类型的操作系统。
  • Linux:Linux及类Unix类型的操作系统。

默认值:Linux。

Period Integer 1

购买预留实例券的时长。

取值范围:1、3。

默认值:1。

PeriodUnit String Year

购买预留实例券的时长单位。

取值范围:Year。

默认值:Year。

ClientToken String 123e4567-e89b-12d3-a456-426655440000

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

AutoRenew Boolean true

是否要自动续费。

true:自动续费。 false(默认):不自动续费。

AutoRenewPeriod Integer 1

每次自动续费的时长,单位为月。当参数AutoRenew取值True时,该参数才生效。

AutoRenewPeriod取值范围:1,12,36,60。

PeriodUnit=Month, 默认值为1。

PeriodUnit=Year,默认值为12。

返回数据

名称 类型 示例值 描述
RequestId String 8C314443-AF0D-4766-9562-C83B7F1A3C8B

请求ID。

ReservedInstanceIdSets Array of String ecsri-2ze53qonjqxg7r****

预留实例券ID列表。

示例

请求示例

https://ecs.aliyuncs.com/?Action=PurchaseReservedInstancesOffering
&RegionId=cn-hangzhou
&Scope=Zone
&ZoneId=cn-hangzhou-a
&ReservedInstanceName=test
&InstanceType=ecs.g5.2xlarge
&InstanceAmount=1
&OfferingType=AllUpfront
&Period=1
&PeriodUnit=Year
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<PurchaseReservedInstancesOfferingResponse>
    <RequestId>8C314443-AF0D-4766-9562-C83B7F1A3C8B</RequestId>
    <ReservedInstanceIdSets>
        <ReservedInstanceId>ecsri-2ze53qonjqxg7r****</ReservedInstanceId>
    </ReservedInstanceIdSets>
</PurchaseReservedInstancesOfferingResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ReservedInstanceIdSets" : {
    "ReservedInstanceId" : [ "ecsri-2ze53qonjqxg7r****" ]
  },
  "RequestId" : "8C314443-AF0D-4766-9562-C83B7F1A3C8B"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidInstanceType.ValueUnauthorized The specified InstanceType is not authorized. 指定的实例规格未授权使用。
400 InvalidDescription.Malformed The specified parameter "Description" is not valid. 指定的资源描述格式不合法。长度为2-256个字符,不能以http://和https://开头。
400 InvalidParameter.Conflict The specified region and cluster do not match. 指定的地域与指定的集群不匹配。
400 InvalidTagKey.Malformed The specified Tag.n.Key is not valid. 指定的标签键参数有误。
400 RegionUnauthorized %s 该地域未被授权。%s为变量,将根据调用API的实际情况动态返回错误信息。
400 Zone.NotOnSale %s 该可用区暂时关闭了售卖。%s为变量,将根据调用API的实际情况动态返回错误信息。
400 InvalidPeriodUnit.ValueNotSupported The specified parameter PeriodUnit is not valid. 参数 PeriodUnit 无效。
400 InvalidTagValue.Malformed The specified Tag.n.Value is not valid. 指定的标签值参数有误。
400 InvalidChargeType.ValueNotSupported ChargeType is not valid. 该计费方式不支持,请您重新选择计费方式。
400 InvalidInstanceType.ValueNotSupported The specified InstanceType beyond the permitted range. 指定的实例规格不合法(超出可选范围)。
400 InvalidInstanceType.ValueNotSupported The specified InstanceType does not exist or beyond the permitted range. 您指定的实例规格不存在,或者您没有权限操作此规格的实例。
403 OperationDenied The creation of Host to the specified Zone is not allowed. 无法在指定可用区创建专用宿主机。
403 OperationDenied.NoStock The requested resource is sold out in the specified zone; try other types of resources or other regions and zones. 请求的资源在指定的可用区已售完,请您更换实例规格或者可用区重试,调用 DescribeZones 接口可以获得库存结果。
403 OperationDenied Sales of this resource are temporarily suspended in the specified region; please try again later. 指定的地域暂时关闭了此资源的售卖,请稍后重试。
403 NodeControllerUnavailable The Node Controller is temporarily unavailable. 节点控制器暂不可用。
403 OperationDenied The resource is out of usage. 该实例不在运行状态,请您启动实例或检查操作是否合理。
403 InvalidParameter.ResourceOwnerAccount ResourceOwnerAccount is Invalid. 指定的 ResourceOwnerAccount 不合法。
403 Zone.NotOpen The specified zone is not granted to you to buy resources yet. 用户未被授权购买指定的可用区的资源。
403 Zone.NotOnSale The specified zone is not available for purchase. 指定可用区已经售罄,请您更换实例规格或者更换地域创建。
403 InvalidParameter.NotMatch %s 您输入的参数无效,请检查参数之间是否冲突。
403 Account.Arrearage Your account has been in arrears. 账户余额不足,请先充值再操作。
404 PaymentMethodNotFound No payment method has been registered on the account. 账户尚未注册支付方式。
500 InternalError The request processing has failed due to some unknown error. 内部错误,请重试。如果多次尝试失败,请提交工单。
500 InternalError %s 内部错误。
500 InternalError The request processing has failed due to some unknown error, exception or failure. 内部错误,请重试。如果多次尝试失败,请提交工单。

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