本接口用于修改一台或多台包年包月实例的自动续费属性,可以帮助您减少资源到期的维护成本。
接口说明
请确保在使用该接口前,您已充分了解云服务器 ECS 的计费方式和价格。
-
请确保您的账号余额或者信用额度充足。
-
仅支持包年包月的实例,按量付费的实例调用该接口会报错。
-
自动续费扣款日为实例到期前第 9 天,扣费在北京时间(UTC +8)08:00:00 开始执行。
-
若前一日执行自动扣费失败,将会在下一日定时继续执行,直到扣费成功或者 9 天之后实例到期锁定。
-
若新建实例的购买时长为一周,则会在创建成功的第一天自动扣款续费。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:ModifyInstanceAutoRenewAttribute | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 ID。支持批量设置最多 100 个包年包月实例,多个实例 ID 以英文逗号分隔。 | i-bp67acfmxazb4ph****,i-bp67acfmxazb4pi**** |
RegionId | string | 是 | 实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
Duration | integer | 否 | 设置实例自动续费时长。
| 1 |
AutoRenew | boolean | 否 | 实例到期前是否自动续费。
默认值:false。 | true |
RenewalStatus | string | 否 | 实例的自动续费状态。取值范围:
说明
参数 RenewalStatus 的优先级高于参数AutoRenew 。如果不传入参数RenewalStatus ,则默认以参数AutoRenew 为准。
| AutoRenewal |
PeriodUnit | string | 否 | 续费时长的时间单位,即参数
| Month |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | OperationDenied.StarterPackage | Instance created with a Starter Package plan can not set auto renew. | - |
403 | MissingParameter.InstanceId | InstanceId should not be null. | 参数 InstanceId 不能为空。 |
403 | InvalidParameter.ToManyInstanceIds | InstanceId should be less than 100. | 实例数应小于100。 |
403 | InvalidParameter.InvalidInstanceId | %s | 指定的参数 InstanceId 无效。 |
403 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | 该资源目前的状态不支持此操作。 |
403 | ChargeTypeViolation | Pay-As-You-Go instances do not support this operation. | 按量付费实例不支持该操作,检查实例的付费类型是否与该操作冲突。 |
403 | InvalidParameter.Duration | %s | 参数 Duration 无效。 |
403 | InvalidParameter.RenewalStatus | %s | 指定的参数 RenewalStatus 无效。 |
403 | InvalidPeriodUnit.ValueNotSupported | The specified parameter PeriodUnit is not valid. | 参数 PeriodUnit 无效。 |
403 | InvalidPeriod.StarterPackage | This instance was created by using a Starter Package plan and can only be renewed monthly, not yearly. | 参加了入门级套餐活动的实例,只能设置成每月自动续费。 |
500 | InternalError | The request processing has failed due to some unknown error. | 内部错误,请重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史