AI 助理
备案控制台
文档
输入文档关键字查找
首页 云服务器 ECS 开发参考 API参考（ECS） API目录 预留实例券 ModifyReservedInstances - 修改预留实例券配置

ModifyReservedInstances - 修改预留实例券配置

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

本接口的主要功能是通过修改实例规格、数量、可用区等预留实例券的配置来对预留实例券进行拆分、合并或范围变更操作。

接口说明

本接口为异步接口，接口调用成功后会返回新产生的预留实例券 ID，原来的预留实例券会进入更新中状态，最终变为失效状态，与此同时，会有一张创建中状态的预留实例券产生，最终变为已生效状态，您可以通过 DescribeReservedInstances 进行查询。

  • 预留实例券只有在已生效状态下才可以修改配置。
  • 请确保修改配置前后预留实例券的计算力不会改变，否则修改请求会失败。
  • 预留实例券的拆分、合并、范围变更不能同时进行。

更多信息，请参见拆分、合并或修改预留实例券。

请求示例

  • 拆分：将一张杭州地域、实例规格为 ecs.g5.xlarge、匹配数量为 2 的预留实例券拆分为两张实例规格为 ecs.g5.large、匹配数量为 1 的预留实例券。
"RegionId":"cn-hangzhou", //设置地域为杭州
"ReservedInstanceId":["ecsri-bp1hd03e9uv19e75****"], //需要拆分的预留实例券 ID
"Configuration":[
  {
    "ReservedInstanceName":"testReservedInstanceName1", //修改后的预留实例券名称
    "InstanceType":"ecs.g5.large", //设置修改后的实例规格
    "Scope":"Region", //预留实例券的范围不可改变
    "InstanceAmount":1 //表示预留实例券可以同时匹配同规格按量付费实例的数量为 1 台
  },
  {
    "ReservedInstanceName":"testReservedInstanceName2",
    "InstanceType":"ecs.g5.large",
    "Scope":"Region",
    "InstanceAmount":1
  }
]
  • 合并：将两张杭州地域可用区 H 、实例规格为 ecs.g5.xlarge、匹配数量为 4 的预留实例券合并为一张实例规格为 ecs.g5.4xlarge、匹配数量为 2 的预留实例券。
"RegionId":"cn-hangzhou", //设置地域为杭州
"ReservedInstanceId":["ecsri-bp1hd03e9uv16b75****",""ecsri-bp1hd03e9uv16b76****""], //需要合并的预留实例券 ID
"Configuration":[
  {
    "ReservedInstanceName":"testReservedInstanceName", //修改后的预留实例券名称
    "InstanceType":"ecs.g5.4xlarge", //设置修改后的实例规格
    "Scope":"Zone", //预留实例券的范围不可改变
    "ZoneId":"cn-hangzhou-h", //
    "InstanceAmount":2 //表示预留实例券可以同时匹配同规格按量付费实例的数量为 2 台
  }
]
  • 变更范围：将一张杭州地域可用区 H 、实例规格为 ecs.g5.xlarge、匹配数量为 6 的预留实例券变更为一张杭州地域、实例规格为 ecs.g5.2xlarge、匹配数量为 3 的预留实例券。
"RegionId":"cn-hangzhou", //设置地域为杭州
"ReservedInstanceId":["ecsri-bp1hd03e9uv16b77****"], //需要变更范围的预留实例券 ID
"Configuration":[
  {
    "ReservedInstanceName":"testReservedInstanceName", //变更范围后的预留实例券名称
    "InstanceType":"ecs.g5.2xlarge", //设置修改后的实例规格
    "Scope":"Region", //变更后预留实例券的范围
    "InstanceAmount":3 //表示预留实例券可以同时匹配同规格按量付费实例的数量为 3 台
  }
]

调试

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

授权信息

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

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

请求参数

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

预留实例券所属的地域 ID。

您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
ReservedInstanceIdarray是

预留实例券 ID 数组。数组长度：1~20。

string是

预留实例券 ID。

ecsri-bp15xx2****
Configurationarray<object>否

预留实例券的配置信息数组。数组长度：1~100。

object否

预留实例券的配置信息。

ReservedInstanceNamestring否

预留实例券的名称。

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

testReservedInstanceName
ZoneIdstring否

预留实例券所属的可用区编号。

Scope参数值为Zone时，该参数为必填参数。

您可以调用 DescribeZones 获取可用区列表。

cn-hangzhou-i
Scopestring是

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

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

默认值：Region。

Zone
InstanceTypestring是

预留实例券可以匹配的实例规格。

说明 适用的实例规格持续更新，详情请参见预留实例券概述。
ecs.c5.4xlarge
InstanceAmountinteger是

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

1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

ED9E4A5F-FF4D-4C96-BE80-6B4227060DD7
ReservedInstanceIdSetsarray

预留实例券 ID 列表。

ReservedInstanceIdstring

预留实例券 ID。

"ecsri-bp1cx3****"

示例

正常返回示例

JSON格式

{
  "RequestId": "ED9E4A5F-FF4D-4C96-BE80-6B4227060DD7",
  "ReservedInstanceIdSets": {
    "ReservedInstanceId": [
      "\"ecsri-bp1cx3****\""
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidInstanceType.ValueUnauthorizedThe specified InstanceType is not authorized.指定的实例规格未授权使用。
400InvalidParameter.ConflictThe specified region and cluster do not match.指定的地域与指定的集群不匹配。
400InvalidTagKey.MalformedThe specified Tag.n.Key is not valid.指定的标签键参数有误。
400RegionUnauthorized%s该地域未被授权。%s为变量，将根据调用API的实际情况动态返回错误信息。
400Zone.NotOnSale%s该可用区暂时关闭了售卖。%s为变量，将根据调用API的实际情况动态返回错误信息。
400InvalidPeriodUnit.ValueNotSupportedThe specified parameter PeriodUnit is not valid.参数 PeriodUnit 无效。
400InvalidTagValue.MalformedThe specified Tag.n.Value is not valid.指定的标签值参数有误。
400InvalidChargeType.ValueNotSupportedChargeType is not valid.该计费方式不支持，请您重新选择计费方式。
400OperationDeniedThe specified InstanceType or Zone is not authorized for current user.-
403OperationDenied.NoStockThe requested resource is sold out in the specified zone; try other types of resources or other regions and zones.库存不足。
403OperationDeniedSales of this resource are temporarily suspended in the specified region; please try again later.指定的地域暂时关闭了此资源的售卖，请稍后重试。
403NodeControllerUnavailableThe Node Controller is temporarily unavailable.节点控制器暂不可用。
403OperationDeniedThe resource is out of usage.该实例不在运行状态，请您启动实例或检查操作是否合理。
403InvalidParameter.ResourceOwnerAccountResourceOwnerAccount is Invalid.指定的 ResourceOwnerAccount 不合法。
403Zone.NotOpenThe specified zone is not granted to you to buy resources yet.用户未被授权购买指定的可用区的资源。
403Zone.NotOnSaleThe specified zone is not available for purchase.指定可用区已经售罄，请您更换实例规格或者更换地域创建。
403InvalidResourceType.NotSupported%s-
403InvalidParameter.NotMatch%s您输入的参数无效，请检查参数之间是否冲突。
403Account.ArrearageYour account has been in arrears.账户余额不足，请先充值再操作。
403InvalidReservedInstanceName.MalformedThe specified parameter ReservedInstanceName is invalid.-
403InvalidParameter.ScopeThe specified parameter 'Scope' is invalid.-
403InvalidReservedInstanceStatus.ValueNotSupportedReservedInstance status is not supported.-
403InvalidReservedInstanceOfferingType.ValueNotSupportedThe OfferingType is not supported.-
403InvalidReservedInstanceOfferingClass.ValueNotSupportedThe OfferingClass is not supported.-
403MissingParameter.ZoneIdThe specified zoneId should be not empty.-
403MissingParameter.InstanceTypeThe instanceType should be not empty.-
403MissingParameter.ReservedInstanceIdThe ids of reservedInstance can not be empty.-
403MissingParameter.ReservedInstanceConfigurationThe configurations of reservedInstance can not be empty.-
403InvalidParameter.SplitOrMergeThe Many-to-many of modification is not supported.-
403MissingParameter.InstanceTypeAndAmountBothEmptyThe instanceType and amount can not be both empty.-
403InvalidReservedInstancePlatform.ValueNotSupportedThe Platform is not supported.-
403InvalidParameter.ReservedInstanceNameThe reservedInstanceName is invalid.reservedInstanceName字段值不合法
403InvalidReservedInstanceZone.ValueNotSupportedThe zoneId is not exist.-
403InvalidParameter.ValueNotSupportedThe instanceTypeFamily of the instance to be changed must be consistent.-
403InvalidParameter.ValueNotSupportedThe expiration time of the instance to be changed must be consistent.-
403InvalidParameter.ValueNotSupportedThe factor of instanceType is not equal.-
403InvalidParameter.ValueNotSupportedThe offeringClass of instance is not same.-
403InvalidParameter.ValueNotSupportedThe offeringType of instance is not same.-
403IncorrectInstanceStatusThe status of specified reservedInstance must be active.预留实例券状态不正确导致续费失败
403IncorrectInstanceStatusThe current status of the resource does not support this operation.该资源目前的状态不支持此操作。
403InvalidPlatform.ValueNotSupportedThe platform of reservedInstance is invalid.-
403InvalidScope.ValueNotSupportedThe scope of reservedInstance is invalid. The valid value is Zone or Region.-
403InvalidConfiguration.ValueNotSupportedThe modification Configuration should not be empty.-
403InvalidZoneId.ValueNotSupportedThe specified zoneId should be same.-
403InvalidParameterThe parameter is invalid.Please check it.-
403InvalidInstanceAmount.ValueNotSupportedThe instanceAmount is invalid.-
403OperationDenied.OnlyModifyNameIt is not allowed to modify the ReservedInstanceName only.不允许只修改预留实例券的名称。
403InvalidReservedInstanceId.NotFoundThe specified parameter ReservedInstanceId is invalid.-
404InvalidZoneId.NotFoundThe ZoneId provided does not exist in our records.指定的可用区 ID 不存在。
404InvalidZoneId.NotFoundThe specified ZoneId does not exist.指定的可用区 ID 不存在。
500InternalErrorThe request processing has failed due to some unknown error.内部错误，请重试。
500InternalError%s内部错误。

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

变更历史

变更时间变更内容概要操作
2023-07-28OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
2023-05-09OpenAPI 错误码发生变更查看变更详情
上一篇：DescribeReservedInstances - 查询预留实例券详细信息列表下一篇：ModifyReservedInstanceAttribute - 修改预留实例券属性
文档推荐