全部产品
Search
文档中心

专有宿主机:ModifyDedicatedHostAutoRenewAttribute

更新时间:Sep 11, 2023

调用ModifyDedicatedHostAutoRenewAttribute为一台或多台包年包月专有宿主机设置自动续费,也可以取消已设定的自动续费。

接口说明

  • 当您的包年包月专有宿主机开启自动续费功能后,到期前九天将自动续费,扣费在08:00:00(UTC +8)时间点自动执行。如果前一日扣费失败,次日继续定时执行。扣费成功或者九天之后专有宿主机到期被锁定后停止自动扣费。期间,您需要保证自己的支付方式使用额度充足即可。
  • 包年包月的专有宿主机支持跟随宿主机内的包年包月ECS实例自动续费。详细信息,请参见AutoRenewWithEcs参数说明。

请求参数

名称

类型

是否必选

示例值

描述

Action String ModifyDedicatedHostAutoRenewAttribute

系统规定参数。取值:ModifyDedicatedHostAutoRenewAttribute

DedicatedHostIds String dh-bp165p6xk2tlw61e****

专有宿主机ID。最多可以输入100个包年包月专有宿主机ID,ID之间用半角逗号(,)隔开。

RegionId String cn-hangzhou

专有宿主机所属的地域ID。

Duration Integer 1

续费周期。取值范围:

  • PeriodUnit=Month时:1、12。
  • PeriodUnit=Year时:1、12。
PeriodUnit String Month

续费时长单位。取值范围:

  • Month
  • Year

默认值:Month。

AutoRenew Boolean false

是否自动续费包年包月专有宿主机。取值范围:

  • true:自动续费包年包月专有宿主机。
  • false:不自动续费包年包月专有宿主机。

默认值:false。

RenewalStatus String Normal

是否自动续费包年包月专有宿主机,参数RenewalStatus的优先级高于AutoRenew。取值范围:

  • AutoRenewal:自动续费。
  • Normal:待续费。
  • NotRenewal:不续费,也不发送到期提醒。到期前第三天系统会自动发送不续费提醒。不续费的专有宿主机可以设置成待续费(Normal),再自行续费(RenewDedicatedHosts)或设置为自动续费(AutoRenewal)。
AutoRenewWithEcs String StopRenewWithEcs

设置是否跟随专有宿主机内的包年包月ECS实例自动续费。

如果您的专有宿主机(简称DDH)为包年包月计费方式,且该DDH内包年包月ECS实例开启了自动续费。您可以通过该参数设置DDH跟随ECS实例自动续费。当DDH内ECS实例自动续费时,如果DDH的到期时间比该ECS实例续费后的到期时间短,则DDH也会自动续费。DDH跟随ECS实例自动续费的原则说明:

DDH会自动判断对应ECS实例续费后的到期时间,然后在自动续费DDH时长时,选择大于ECS实例到期时间,且满足DDH续费周期的最小续费时长进行续费。DDH支持的续费周期详情,请参见PeriodUnitDuration参数说明。

例如:包年包月DDH在当年01月15日到期,DDH内的包年包月ECS实例在自动续费后,将时长延长至当年11月15日到期,则DDH生命周期比ECS实例的生命周期少10个月。此时,DDH在自动续费时,会选择大于10个月,且符合DDH续费周期的最小续费时长12个月(即PeriodUnit=MonthDuration=12)进行续费。

取值范围:

  • AutoRenewWithEcs:跟随专有宿主机内包年包月ECS实例自动续费。
  • StopRenewWithEcs:不跟随专有宿主机内包年包月ECS实例自动续费。
  • NoOperation:不改变专有宿主机当前的设置。
说明 如果您设置该参数为AutoRenewWithEcs,需要确保专有宿主机已开启自动续费(即AutoRenew=true)。否则,该参数只是改变了参数值,实际的跟随ECS实例自动续费功能并不生效。

默认值:NoOperation。

返回数据

名称

类型

示例值

描述

RequestId String 2A4EA075-CB5B-41B7-B0EB-70D339F6****

请求ID。

示例

请求示例

https://ecs.aliyuncs.com/?Action=ModifyDedicatedHostAutoRenewAttribute
&DedicatedHostIds=dh-bp165p6xk2tlw61e****
&Duration=1
&PeriodUnit=Month
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyDedicatedHostAutoRenewAttributeResponse>
    <RequestId>2A4EA075-CB5B-41B7-B0EB-70D339F6****</RequestId>
</ModifyDedicatedHostAutoRenewAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "2A4EA075-CB5B-41B7-B0EB-70D339F6****"
}

错误码

HttpCode

错误码

错误信息

描述

403 MissingParameter.DedicatedHostId DedicatedHostId should not be null. 参数 DedicatedHostId 不能为空。
403 InvalidParameter.ToManyDedicatedHostIds DedicatedHostId should be less than 100. 参数 DedicatedHostIds 包含的专有宿主机 ID 应该少于 100 个。
403 InvalidParameter.InvalidDedicatedHostId %s 指定的参数 DedicatedHostId 无效。
403 IncorrectHostStatus The current status of the resource does 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 无效。

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