调用 ModifyReservedInstances 接口更改预留实例券，包括更改预留实例券属性、拆分/合并预留实例券等。

注意事项

请先参考更改预留实例券，了解该功能存在的约束限制。

为便于描述，本文将待更改的预留实例券称为原预留实例券，更改后得到的预留实例券称为目标预留实例券。

请求说明

调用该接口时，如不传入可选参数，则保持原有配置。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：ModifyReservedInstances

要执行的操作，取值：ModifyReservedInstances。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

AutoRenew boolean 可选示例值：true

目标预留实例券到期后是否自动续费，取值：

true：自动续费

false（默认）：不自动续费

说明

启用自动续费后，本次生成的所有目标券在到期前，平台将自动扣除续费费用，无需手动续费。

AutoRenewPeriod integer 可选示例值：1

每次自动续费的时长。

仅当参数AutoRenew取值为true时，该参数有效。

PeriodUnit取值为Month时，该参数取值为1、2、3、6、12，默认值为1。

ClientToken string 可选示例值：333456899ff****

保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。

取值：仅支持ASCII字符，且不能超过64个字符。

Configurations.N.ReservedInstanceName string[] 必选示例值：Configurations.1.ReservedInstanceName=reserved-instance-test

目标预留实例券的名称。

参数 -N：表示目标预留实例券的序号，N的取值范围：1～50。

多个预留实例券之间用&分隔。

Configurations.N.HpcClusterId string[] 可选示例值：Configurations.1.HpcClusterId=hpcCluster-1

高性能计算集群ID。

参数 -N：表示预留实例券的序号。

多个预留实例券之间用&分隔。

说明

仅当预留实例券对应的实例规格为高性能计算GPU型时，该参数生效。

Configurations.N.InstanceCount integer[] 可选示例值：Configurations.1.InstanceCount=2

目标预留实例券可以抵扣的按量计费实例数量，最多支持100台。传入0时或者不传，会默认为1。

参数 -N：表示目标预留实例券的序号，N的取值范围：1～50。

多个预留实例券之间用&分隔。

Configurations.N.InstanceTypeId string[] 可选示例值：Configurations.1.InstanceTypeId=ecs.g3i.xlarge

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

参数 -N：表示目标预留实例券的序号，N的取值范围：1～50。

多个预留实例券之间用&分隔。

Configurations.N.Scope string[] 可选示例值：Configurations.1.Scope=ZonalRI

目标预留实例券的类型，取值：

ZonalRI：可用区级预留实例券。

RegionalRI：地域级预留实例券。地域级预留实例券正在邀测中，如需试用，请联系客户经理申请。

说明

参数 -N：表示预留实例券的序号，N的取值范围：1～50。

多个预留实例券之间用&分隔。

Configurations.N.ZoneId string[] 可选示例值：Configurations.1.ZoneId=cn-beijing-a

目标预留实例券所在的可用区ID。

您可以调用DescribeZones查询一个地域下的可用区信息。

参数 -N：表示预留实例券的序号，N的取值范围：1～50。

多个预留实例券之间用&分隔。

说明

Configurations.N.Scope取值为ZonalRI时，该参数必填。

Description string 可选示例值：testDescription

预留实例券的描述。

必须以字母或中文开头。

只能包含中文、字母、数字、点“.”、空格、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、中文逗号“，”和中文句号“。”

长度限制在255个字符以内。

说明

传入空字符串时，将清空原有描述信息。

ProjectName string 可选示例值：project_a

资源所属项目，一个资源只能归属于一个项目。

只能包含字母、数字、下划线“_”、点“.”和中划线“-”。

长度限制在64个字符以内。

RegionId string 可选示例值：cn-beijing

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

您可以调用DescribeRegions接口查看地域ID。

ReservedInstanceIds.N string[] 必选示例值：ReservedInstanceIds.1=ecsri-ycsimi9g465p****&ReservedInstanceIds.2=ecsri-ycsimi2db0l8j0wr****

原预留实例券ID，最多支持10个。

参数 -N：表示原预留实例券的序号。

多个ID之间用&分隔。

Tags.N.Key string[] 必选示例值：Tags.1.Key=k1&Tags.2.Key=k2

用户标签的标签键。

参数 - N：表示标签键的序号，取值范围：1～20。

多个标签键之间用&分隔。

命名规则如下：

不能以volc:或sys:的任意大小写组合开头。

只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。

长度限制在1～128个字符之间。

说明

同一资源的标签键不允许重复。

Tags.N.Value string[] 可选示例值：Tags.1.Value=v1&Tags.2.Value=v2

用户标签的标签值。

参数 - N：表示标签值的序号，取值范围：1～20。

多个标签值之间用&分隔。

命名规则如下：

只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。

允许为空，长度限制在0～256个字符之间。

说明

如果传入该参数，则必须先传入Tags.N.Key。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

ReservedInstanceIds string[] 示例值：["ecsri-ycspipybqpl8j084****","ecsri-ecsri-yccazceloyf80n48****"]

预留实例券的ID。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.	幂等参数不一致。
400	InvalidClientToken.Malformed	The specified ClientToken is malformed.	指定的ClientToken不合法。
400	InvalidInstanceDescription.Malformed	The specified InstanceDescription is malformed.	指定的实例描述不合法。
400	InvalidInstanceStatus	The status of the specified instance does not support this request.	当前实例的状态不支持此操作。
400	InvalidInstanceTypeAndInstanceCount	The specified InstanceType And InstanceCount is invalid.	指定的实例规格和实例数量不合法。
400	InvalidInstanceTypeForCreateReservedInstance.Unsupported	The specified InstanceType does not support creation of reserved instances.	指定的实例规格不支持创建预留实例券。
400	InvalidPeriod	The specified period is not valid.	指定的计费周期个数不合法。
400	InvalidReservedInstanceIds.ZoneMismatch	The specified ReservedInstanceIds are in different Availability Zones.	指定预留实例券不属于同一个可用区。
400	InvalidReservedInstanceModifyStatus.Unsupported	The modify status of the specified reserved instance does not support this request.	当前预留实例的更改状态不支持此操作。
400	InvalidReservedInstanceName.Malformed	The specified ReservedInstanceName is malformed.	指定的ReservedInstanceName不合法。
400	InvalidReservedInstanceStatus	The status of the specified reserved instance does not support this request.	当前预留实例的状态不支持此操作。
400	InvalidScope.Malformed	The specified Scope is malformed.	指定的预留实例券级别不合法。
400	InvalidTagKey.Malformed	The specified TagKey is malformed.	指定的标签的键不合法。
400	InvalidTagValue.Malformed	The specified TagValue is malformed.	指定的标签的值不合法。
400	LimitExceeded.MaximumConfigurations	The number of specified Configurations exceeds the maximum limit.	指定的Configurations超过最大限制。
400	LimitExceeded.MaximumInstanceCount	The number of specified InstanceCount exceeds the maximum limit.	指定的InstanceCount超过最大限制。
400	LimitExceeded.MaximumReservedInstanceIds	The number of specified ReservedInstanceIds exceeds the maximum limit.	指定的ReservedInstanceIds超过最大限制。
400	LimitExceeded.MaximumTags	You've reached the limit on the number of tags that you can create.	指定的标签数量超过最大限制。
400	LimitExceeded.MinimumInstanceCount	The number of specified InstanceCount exceeds the minimum limit.	指定的InstanceCount超过最小限制。
400	MissingParameter.Configurations	The required parameter Configurations is not supplied.	预留实例券配置不能为空。
400	MissingParameter.ReservedInstanceIds	The required parameter ReservedInstanceIds is not supplied.	参数ReservedInstanceIds不能为空。
400	MissingParameter.ReservedInstanceName	The required parameter ReservedInstanceName is not supplied.	参数ReservedInstanceName不能为空。
400	MissingParameter.ZoneId	The required parameter ZoneId is not supplied.	可用区ID不能为空。
400	QuotaExceeded.MaximumGeneralCpus	You've reached the limit on the number of general instances CPU that you can create, please submit ticket or sign-on to the Console to request an increase in [general_vcpu] quota.	通用型实例CPU数量配额不足，请提工单或前往控制台申请提高配额。
400	QuotaExceeded.MaximumGpuBasicNums	You've reached the limit on the GPU number of GPU-accelerated instances that you can create, please submit ticket or sign-on to the Console to request an increase in [gpu_basic] quota.	GPU计算型实例卡数配额不足，请提工单或前往控制台申请提高配额。
400	QuotaExceeded.MaximumHighPerformanceGpus	You've reached the limit on the GPU number of High Performance Computing GPU instances that you can create, please submit ticket or sign-on to the Console to request an increase in [gpu_high_performance] quota.	高性能计算GPU型实例卡数配额不足，请提工单或前往控制台申请提高配额。
400	QuotaExceeded.MaximumLocalVolumeCpus	You've reached the limit on the number of local volume instances CPU that you can create, please submit ticket or sign-on to the Console to request an increase in [local_volume_vcpu] quota.	本地盘实例CPU数量配额不足，请提工单或前往控制台申请提高配额。
400	QuotaExceeded.MaximumReservedInstanceCpus	You've reached the limit on the number of reserved instance CPU that you can create, please submit ticket to request an increase in quota.	预留实例CPU数量配额不足，请提工单申请提高配额。
400	QuotaExceeded.MaximumReservedInstanceGeneralCpus	You've reached the limit on the number of general reserved instances CPU that you can create, please submit ticket or sign-on to the Console to request an increase in [general_vcpu_ri_regional] quota.	通用型实例地域级RI CPU数量配额不足，请提工单或前往控制台申请提高配额。
400	QuotaExceeded.MaximumReservedInstanceGpuBasicNums	You've reached the limit on the GPU number of GPU-accelerated reserved instances that you can create, please submit ticket or sign-on to the Console to request an increase in [gpu_basic_ri_regional] quota.	GPU计算型实例地域级RI卡数配额不足，请提工单或前往控制台申请提高配额。
400	QuotaExceeded.MaximumReservedInstanceHighPerformanceGpus	You've reached the limit on the GPU number of High Performance Computing GPU reserved instances that you can create, please submit ticket or sign-on to the Console to request an increase in [gpu_high_performance_ri_regional] quota.	高性能计算GPU型实例地域级RI卡数配额不足，请提工单或前往控制台申请提高配额。
400	QuotaExceeded.MaximumReservedInstanceLocalVolumeCpus	You've reached the limit on the number of local volume reserved instances CPU that you can create, please submit ticket or sign-on to the Console to request an increase in [local_volume_vcpu_ri_regional] quota.	本地盘实例地域级RI CPU数量配额不足，请提工单或前往控制台申请提高配额。
400	QuotaExceeded.MaximumReservedInstanceTypeInstances	You've reached the limit on the number of reserved instance type instances that you can create, please submit ticket to request an increase in quota.	预留规格实例数量配额不足，请提工单申请提高配额。
404	InvalidHpcCluster.NotFound	The specified HpcCluster does not exist.	指定的高性能集群不存在。
404	InvalidInstance.NotFound	The specified instance does not exist.	指定的实例不存在。
404	InvalidInstanceType.NotFound	The specified InstanceType does not exist.	指定的实例规格不存在。
404	InvalidProject.NotFound	The specified Project does not exist.	指定的Project不存在。
404	InvalidRegion.NotFound	The specified region does not exist.	指定的Region不存在。
404	InvalidReservedInstance.NotFound	The specified reserved instance does not exist.	指定的预留实例不存在。
404	InvalidZone.NotFound	The specified zone does not exist.	指定的可用区不存在。
409	InvalidTagKey.Conflict	The specified TagKey already exists.	指定的标签键已存在。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	先前的幂等请求仍在处理中，请稍后重试。
412	InvalidReservedInstance.ProjectMismatch	The specified reserved instances are in different project.	指定的预留实例券不属于同一个Project。
412	InvalidReservedInstanceModifyStatus.ComputeFactorMismatch	The compute factor of the specified reserved instances does not match.	变更前后预留实例计算力因子不相等。
412	InvalidReservedInstanceModifyStatus.ExpiredTimeMismatch	The expired time of the specified reserved instances does not match.	预留实例到期时间不相等。
412	InvalidReservedInstanceModifyStatus.InstanceTypeFamilyMismatch	The instancetype family of the specified reserved instances does not match.	预留实例规格族不相等。
500	Insufficient.InstanceCapacity	There is not enough capacity to fulfill your request.	当前资源不足，请稍后重试或选择其它实例规格。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

云服务器