文档

ModifyInstanceAutoRenewAttribute - 设置包年包月实例的自动续费状态

更新时间:

调用ModifyInstanceAutoRenewAttribute设置一台或多台包年包月实例的自动续费状态。为了减少您的资源到期维护成本,包年包月ECS实例可以设置自动续费。

接口说明

请确保在使用该接口前,您已充分了解云服务器 ECS的计费方式和产品定价。

  • 自动续费扣款日为实例到期前第 9 天,扣费在北京时间(UTC +8)08:00:00 开始执行。

  • 如果新建实例的购买时长为一周,则会在创建成功的第一天自动扣款续费。

  • 如果前一日执行自动扣费失败,将会继续下一日定时继续执行,直到扣费成功或者 9 天之后实例到期锁定。您只需要保证自己的账号的余额或者信用额度充足即可。

调试

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

授权信息

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

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

请求参数

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

实例 ID。支持批量设置最多 100 个包年包月实例,多个实例 ID 以英文逗号分隔。

i-bp67acfmxazb4ph****,i-bp67acfmxazb4pi****
RegionIdstring

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

cn-hangzhou
Durationinteger

设置实例自动续费时长。

  • PeriodUnitYear(年)时,Duration的取值范围为:{"1", "2", "3", "4", "5"}
  • PeriodUnitMonth(月)时,Duration的取值范围为:{"1", "2", "3", "6", "12", "24", "36", "48", "60"}
  • PeriodUnitWeek(周)时,Duration的取值范围为:{"1", "2", "3", "4"}
1
AutoRenewboolean

实例到期前是否自动续费。

默认值:false

true
RenewalStatusstring

实例的自动续费状态。取值范围:

  • AutoRenewal:设置为自动续费。

  • Normal:取消自动续费。

  • NotRenewal:不再续费。传入该值后,系统不再发送到期提醒,只在到期前第三天发送不续费提醒。不再续费的 ECS 实例可以更改成待续费(Normal)后,再自行续费或设置为自动续费。

说明 参数RenewalStatus的优先级高于参数AutoRenew。如果不传入参数RenewalStatus,则默认以参数AutoRenew为准。
AutoRenewal
PeriodUnitstring

续费时长的时间单位,即参数Duration的单位。取值范围:

  • Week
  • Month(默认)
  • Year
Month

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400OperationDenied.StarterPackageInstance created with a Starter Package plan can not set auto renew.-
403MissingParameter.InstanceIdInstanceId should not be null.参数 InstanceId 不能为空。
403InvalidParameter.ToManyInstanceIdsInstanceId should be less than 100.实例数应小于100。
403InvalidParameter.InvalidInstanceId%s指定的参数 InstanceId 无效。
403IncorrectInstanceStatusThe current status of the resource does not support this operation.该资源目前的状态不支持此操作。
403ChargeTypeViolationPay-As-You-Go instances do not support this operation.按量付费实例不支持该操作,检查实例的付费类型是否与该操作冲突。
403InvalidParameter.Duration%s参数 Duration 无效。
403InvalidParameter.RenewalStatus%s指定的参数 RenewalStatus 无效。
403InvalidPeriodUnit.ValueNotSupportedThe specified parameter PeriodUnit is not valid.参数 PeriodUnit 无效。
403InvalidPeriod.StarterPackageThis instance was created by using a Starter Package plan and can only be renewed monthly, not yearly.参加了入门级套餐活动的实例,只能设置成每月自动续费。
500InternalErrorThe request processing has failed due to some unknown error.内部错误,请重试。

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

变更历史

变更时间变更内容概要操作
暂无变更历史