文档

ModifyDedicatedHostAutoRenewAttribute - 为专有宿主机设置或取消自动续费

更新时间:

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

接口说明

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

调试

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

授权信息

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

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

请求参数

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

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

dh-bp165p6xk2tlw61e****
RegionIdstring

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

cn-hangzhou
Durationinteger

续费周期。取值范围:

  • PeriodUnit=Week 时:1、2、3、4。
  • PeriodUnit=Month 时:1、2、3、6、12、24、36、48、60。
  • PeriodUnit=Year 时:1、2、3、4、5。
1
PeriodUnitstring

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

  • Week
  • Month
  • Year

默认值:Month。

Month
AutoRenewboolean

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

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

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

默认值:false

false
RenewalStatusstring

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

  • AutoRenewal:自动续费。

  • Normal:待续费。

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

Normal
AutoRenewWithEcsstring

设置是否跟随专有宿主机内的包年包月 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

StopRenewWithEcs

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
403MissingParameter.DedicatedHostIdDedicatedHostId should not be null.参数 DedicatedHostId 不能为空。
403InvalidParameter.ToManyDedicatedHostIdsDedicatedHostId should be less than 100.参数 DedicatedHostIds 包含的专有宿主机 ID 应该少于 100 个。
403InvalidParameter.InvalidDedicatedHostId%s指定的参数 DedicatedHostId 无效。
403IncorrectHostStatusThe current status of the resource does not support this operation.当前资源的状态不支持此操作。
403ChargeTypeViolationPay-As-You-Go dedicated host do not support this operation.-
403InvalidParameter.Duration%s参数 Duration 无效。
403InvalidParameter.RenewalStatus%s指定的参数 RenewalStatus 无效。
403InvalidPeriodUnit.ValueNotSupportedThe specified parameter PeriodUnit is not valid.参数 PeriodUnit 无效。
403InvalidParameter.AutoRenewWithEcsThe value of parameter AutoRenewWithEcs is invalid.参数是否随ECS自动续费无效

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

变更历史

变更时间变更内容概要操作
2023-11-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
  • 本页导读 (1)