文档

ModifyPrepayInstanceSpec - 升级或降低实例规格

更新时间:

调用ModifyPrepayInstanceSpec升级或者降低一台包年包月ECS实例的实例规格,新实例规格将会覆盖实例的整个生命周期。

接口说明

请确保在使用该接口前,您已充分了解云服务器 ECS的计费方式、产品定价以及降配退款规则

升级或者降低包年包月实例规格前,您可以通过 DescribeResourcesModification 查询当前实例支持变配的实例规格。详情请参见 Python SDK 示例查询 ECS 变配的可用资源实践

调用该接口时,您需要注意:

  • 已过期实例无法修改实例规格,您可以续费后重新操作。

  • 降低实例规格时,您需要注意:

    • 实例必须处于已停止Stopped)状态。
    • 降低前后的实例规格价格差退款会退还到您的原付费方式中,已使用的代金券不退回。
  • 本接口属于异步操作,等待约 5~10 秒后配置变更完成。随后,您必须调用 API 或者在控制台重启一次实例,否则规格变更不会生效,重启操作系统无效。

    • 若实例处于已停止状态,仅需启动实例,无需重启。
    • 若实例设置了RebootWhenFinished=true,则无需单独重启。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

i-bp67acfmxazb4ph****
RegionIdstring

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

cn-hangzhou
InstanceTypestring

需要变配的目标实例规格。取值请参见实例规格族或者调用 DescribeInstanceTypes

ecs.g5.xlarge
OperatorTypestring

操作类型。取值范围:

说明 该参数可无需上传,系统可自动判断升配还是降配;如要上传,请按照下面的逻辑规则操作。
  • upgrade:升级实例规格。请确保您的账户支付方式余额充足。

  • downgrade:降配实例规格。当InstanceType设置的实例规格低于当前实例规格时,设置OperatorType=downgrade

说明 升级或降低实例规格的注意事项请参见上文接口说明章节。
upgrade
ClientTokenstring

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

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

升级实例规格时,是否自动支付。取值范围:

  • true:自动支付。

    说明 自动支付时,您需要确保支付方式余额充足,否则会生成异常订单,只能作废订单。如果您的支付方式余额不足,可以将参数AutoPay置为false,此时会生成未支付订单,您可以登录 ECS 管理控制台自行支付。
  • false:只生成订单不扣费。

默认值:true。

当参数OperatorType被置为downgrade时,将忽略参数AutoPay

true
MigrateAcrossZoneboolean

是否支持跨集群升级实例规格。取值范围:

  • true:是。
  • false:否。

默认值:false。

当参数MigrateAcrossZone取值为true时,一旦您根据返回信息升级了云服务器,请留意以下注意事项:

经典网络类型实例:

  • 对于已停售的实例规格,非 I/O 优化实例变配到 I/O 优化实例时,实例私网 IP 地址、磁盘设备名和软件授权码会发生变化。对于 Linux 实例,普通云盘(cloud)会被识别为 xvda 或者 xvdb 等,高效云盘(cloud_efficiency)和 SSD 云盘(cloud_ssd)会被识别为 vda 或者 vdb 等。
  • 对于正常售卖的实例规格族,实例的私网 IP 地址会发生变化。

专有网络 VPC 类型实例:对于已停售的实例规格,非 I/O 优化实例变配到 I/O 优化实例时,云服务器磁盘设备名和软件授权码会发生变化。Linux 实例的普通云盘(cloud)会被识别为 xvda 或者 xvdb 等,高效云盘(cloud_efficiency)和 SSD 云盘(cloud_ssd)会被识别为 vda 或者 vdb 等。

false
SystemDisk.Categorystring

更换系统盘类型。取值范围:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
说明 该参数仅支持从已停售的实例规格升级到正常售卖的实例规格族,并将非 I/O 优化实例规格升级为 I/O 优化实例规格时有效。
cloud_efficiency
RebootTimestring

实例的重启时间。按照ISO 8601标准表示,使用 UTC+0 时间。格式为:yyyy-MM-ddTHH:mmZ。

2018-01-01T12:05Z
EndTimestring

临时变更的终止时间。按照ISO 8601标准表示,使用 UTC+0 时间。格式为:yyyy-MM-ddTHH:mmZ。

2018-01-01T12:05Z
RebootWhenFinishedboolean

实例变配结束后是否立即重启。取值范围:

  • true:是。
  • false:否。

默认值为 false。

说明 若实例处于停止中状态,即使您设置了RebootWhenFinished=true,也会保持原状态不变,并不会执行任何操作。
false
ModifyModestring
说明 该参数暂未开放使用。
null
Diskobject []
说明 该参数暂未开放使用。
DiskIdstring
说明 该参数暂未开放使用。
null
Categorystring
说明 该参数暂未开放使用。
null
PerformanceLevelstring
说明 该参数暂未开放使用。
null

返回参数

名称类型描述示例值
object
OrderIdstring

生成的订单 ID。

1234567890
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidInstanceType.ValueUnauthorizedThe specified InstanceType is not authorized.指定的实例规格未授权使用。
400InvalidInstanceType.ValueNotSupportedThe specified InstanceType does not exist or beyond the permitted range.您指定的实例规格不存在,或者您没有权限操作此规格的实例。
400InvalidBillingMethod.ValueNotSupportedThe operation is not permitted due to an invalid billing method of the instance.由于实例的计费方式无效,该操作不允许。
400InvalidInstance.PurchaseNotFoundThe specified instance has no purchase history.该实例的订购记录不存在。
400InvalidInstance.UnpaidOrderThe specified instance has unpaid order.指定的实例有未支付的订单,请您先支付再进行操作。
400InvalidInstanceType.NotSupportedThe specified InstanceType is not Supported.不支持指定的InstanceType。
400OrderCreationFailedOrder creation failed, please check your params and try it again later.订单创建失败,请修改参数后重试。
400ThrottlingYou have made too many requests within a short time; your request is denied due to request throttling.请求被流控,请稍后重试。
400Account.ArrearageYour account has an outstanding payment.您的账号存在未支付的款项。
400InvalidInstanceId.NotFoundThe specified InstanceId does not exist.指定的实例ID未找到。
400InvalidRebootTime.MalFormedThe specified rebootTime is not valid.指定的 RebootTime 不合法。
400InvalidRebootTime.ValueNotSupportedThe specified RebootTime is not valid.指定的重启时间不合法。
400IdempotenceParamNotMatchRequest uses a client token in a previous request but is not identical to that request.与相同 ClientToken 的请求参数不符合。
400IdempotenceParamNotMatch%s幂等参数不匹配。
400InvalidInstanceChargeType.ValueNotSupported%s暂不支持此付款类型,请核对相关信息后重试。
400InvalidStatus.NotStoppedInstance status must be stopped.实例只有在已停止的状态下,才能进行此操作。
400InvalidAction%s操作无效。
400InstanceDowngrade.QuotaExceedQuota of instance downgrade is exceed.您的实例降配已超额度,无法进行此操作。
400InvalidInstanceType.ValueNotSupported%s该操作暂不支持指定的实例类型。
400InvalidParameter%s无效的参数。
400OperationDeniedThe current user does not support this operation.您使用的账号暂不支持此操作。
400LastOrderProcessingThe previous order is still processing, please try again later.订单正在处理中,稍后重试。
400InvalidOperation.VpcHasEnabledAdvancedNetworkFeatureThe specified vpc has enabled advanced network feature.该VPC开启了高阶特性,不能创建低规格的ECS。
400InvalidAction.WithActiveElasticUpgradeThe instance has active Elastic Upgrade.指定的实例为临时升级中(即调用ModifyPrepayInstanceSpec时设置了EndTime参数)的实例,暂不支持查询。
400InstanceTypeNotSupported.TooManyDisksAttached%s-
400QuotaExceed.DiskCapacityThe used capacity of disk type has exceeded the quota in the zone, %s.指定磁盘类型的已用容量超出可用区配额限制,您可以前往配额中心查询和申请提升磁盘容量配额。
400MissingParameter.DiskCategoryThe specified parameter Disk.Category can not be null when Disk.DiskId is specified.-
400InvalidParameter.DiskCategoryThe specified parameter Disk.Category is not valid.-
400InvalidPerformanceLevel.MalformedThe specified parameter Disk.n.PerformanceLevel is not valid.-
400InvalidSystemDiskCategory.NotMatchInstanceTypeThe system disk category does not match the instance type.-
400QuotaExceed.RufundVcpuThe maximum number of refunded vcpu is exceeded: %s .退款规则中vCPU配额超过了最大数量限制,具体限制请参见错误信息中%s占位符的实际信息。
400NoPermission.PriceThe operation requires price permission. Please either apply for permission from your main account, or set the parameter AutoPay as true.-
400NoPermission.RefundThe operation requires refund permission. Please apply for permission from your main account.-
400InvalidInstanceStatusThe current status of the instance does not support this operation.当前实例的状态不支持此操作。
400InvalidOperation.InstanceRenewWithDowngradeInPlanThe operation is denied due to the specified instance has renew with downgrade record in plan.存在未生效的续费降配订单。订单生效前不允许此操作。
400InvalidOperation.OnlineModificationUnsupportedOnline modification of instance type is not supported for the specified instance due to its CPU topology.当前CPU拓扑类型不支持热变配
403OperationDenied.NoStockThe specified instance is out of usage.指定的实例库存不足。
403InvalidUser.PassRoleForbiddenThe RAM user does not have privilege to pass a role.RAM子账号不具备授予ECS RAM角色的权限。
403ImageNotSupportInstanceTypeThe specified image does not support the specified InstanceType.指定的镜像不支持指定的实例规格。
403InstanceType.Offline%s实例规格因停售、供货不足等原因,不支持该操作。
403IncorrectInstanceStatusThe current status of the resource does not support this operation.该资源目前的状态不支持此操作。
403InvalidParameter.InstanceId%s指定的参数 InstanceId 无效。
403OperationDenied%s拒绝操作。
403ImageNotSupportInstanceTypeThe specified instanceType is not supported by instance with marketplace image.指定的市场镜像不支持该实例规格。
403InvalidOperation.StarterPackageStarterPackage not support modification.-
403InvalidInstance.PreInstanceExpiredInstance business status is not Expired.-
403InvalidInstance.EipNotSupportThe special instance with eip not support operate, please unassociate eip first.已绑定 EIP 的实例不支持该操作,请优先解绑EIP。
403OperationDenied.ImageNotValidThe specified image is not authorized.您没有使用此镜像的权限。
403OperationDenied.LocalDiskUnsupportedThe configuration change is not allowed when the specified instance has local disks mounted.实例挂载本地盘后不支持规格变配。
403OperationDenied.NoStockThe resource is out of stock in the specified zone. Please try other types, or choose other regions and zones.指定的资源在指定可用区中无货。请尝试其他类型,或选择其他可用区和地域。
403InvalidOperation.EniCountExceeded%s-
403InvalidOperation.Ipv4CountExceeded%sIPv4 数量达到上限,导致该操作无效。
403InvalidOperation.Ipv6CountExceeded%sIPv6 数量达到上限,导致该操作无效。
403InvalidOperation.Ipv6NotSupport%sIPv6不支持当前操作。
403InvalidOperation.Ipv4NotSupport%s-
403InvalidInstance.NotFoundSystemDiskThe specified instance has no system disk.指定的实例没有挂载系统盘。请确保指定的实例已挂载了系统盘。您可以调用 DescribeInstances 查询指定实例的信息。
403InvalidInstanceType.NotSupportDiskCategoryThe instanceType of the specified instance does not support this disk category.指定的实例规格(InstanceType)不支持当前实例的云盘类别。请尝试更换其它实例规格。关于实例规格支持的云盘类型,请参见实例规格族文档。
403QuotaExceed.ElasticQuotaNo additional quota is available for the specified ECS instance type.您在当前地域选择的实例规格所要创建的台数超出系统限额,您可以选择其他地域、实例规格或减少台数重新购买,也可以前往ECS管理控制台或配额中心申请提高限额。
403QuotaExceed.ElasticQuotaThe number of the specified ECS instances has exceeded the quota of the specified instance type.您在当前地域选择的实例规格所要创建的台数超出系统限额,您可以选择其他地域、实例规格或减少台数重新购买,也可以前往ECS管理控制台或配额中心申请提高限额。
403QuotaExceed.ElasticQuotaThe number of vCPUs assigned to the ECS instances has exceeded the quota in the zone.您的全实例规格vCPU配额超出系统限额,您可以前往ECS管理控制台或配额中心申请提高限额。
403QuotaExceed.ElasticQuotaThe number of the specified ECS instances has exceeded the quota of the specified instance type, or the number of vCPUs assigned to the ECS instances has exceeded the quota in the zone.您在当前地域选择的实例规格所要创建的台数超出系统限额,或者全实例规格vCPU配额超出系统限额,您可以前往ECS管理控制台或配额中心申请提高限额。
403InvalidResourceType.NotSupported%s-
403InvalidOperation.MaxEniQueueNumberExceeded%s弹性网卡队列数超过上限,具体信息请参见错误信息%s占位符的实际返回结果。
403InvalidOperation.ExceedInstanceTypeQueueNumber%s弹性网卡队列总数超过上限,具体信息请参见错误信息%s占位符的实际返回结果。
403InvalidParameter.InvalidEniQueueNumber%s弹性网卡队列数有误,具体信息请参见错误信息%s占位符的实际返回结果。
403HibernationConfigured.InstanceOperationForbiddenThe operation is not permitted due to limit of the hibernation configured instance.不符合开启休眠选项的实例的相关限制,操作不被允许。
403InvalidOperation.MaxModifyOnlineNumberExceededThe specified instance has reached the maximum number of modify online attempts and needs to be rebooted.-
403InvalidOperation.RebootingRequiredThe specified instance needs to be rebooted.-
403InvalidOperation.OSTypeNotSupportedThe specified OS type is not supported.-
403OperationDenied.UnpaidOrderThe specified instance has unpaid order.指定的实例ID已存在未支付订单,您可以登录ECS管理控制台支付。
404InvalidRegionId.NotFoundThe specified RegionId does not exist.指定的地域 ID 不存在。
404BillingMethodNotFoundThe account has not chosen any billing method.该阿里云账号没有选择任何计费方法。
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误,请重试。
500InternalErrorThe request processing has failed due to some unknown error.内部错误,请重试。
500ImageOrderFailedCreate marketplace image order failed.创建云市场订单失败,请提交工单处理。

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

变更历史

变更时间变更内容概要操作
2023-12-14OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
    删除错误码:500
2023-10-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
    删除错误码:500
2023-07-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 500 变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
2023-07-21OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
    删除错误码:500
2023-06-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
    删除错误码:500
2023-06-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
    删除错误码:500
2023-05-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
    删除错误码:500
2023-04-13OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 403 变更
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:Disk
2023-04-07OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    删除错误码:400
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:ModifyMode
  • 本页导读 (1)