1つ以上のサブスクリプション専用ホストの自動更新を有効または無効にします。

説明

  • サブスクリプション専用ホストの自動更新を有効にすると、有効期限の9日前に専用ホストが自動的に更新されます。 更新料金は08:00:00 (UTC + 8) に自動的に支払われます。 料金が支払われない場合、それらは翌日の同じ時点で支払われます。 自動支払いは、料金の支払い後、または専用ホストの有効期限が切れてロックされた後に停止します。 アカウント内に十分な残高があることを確認してください。
  • サブスクリプション専用ホストは、専用ホストでホストされているサブスクリプションElastic Compute Service (ECS) インスタンスとともに自動的に更新できます。 詳細については、AutoRenewWithEcsパラメーターの説明をご参照ください。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 ModifyDedicatedHostAutoRenewAttribute

実行する操作です。 値をModifyDedicatedHostAutoRenewAttributeに設定します。

DedicatedHostIds String 必須 dh-bp165p6xk2tlw61e ****

専用ホストのID。 最大100のサブスクリプション専用ホストIDを指定できます。 ID が複数ある場合は、カンマ (,) で区切ります。

RegionId String 必須 cn-hangzhou

専用ホストのリージョンID。

有効期間 Integer 任意 1

専用ホストの更新期間。 設定可能な値は以下のとおりです。

  • PeriodUnitパラメーターがWeekに設定されている場合、Durationパラメーターの有効な値は1、2、3です。
  • PeriodUnitパラメーターがMonthに設定されている場合、Durationパラメーターの有効な値は1、2、3、6、12です。
PeriodUnit String 任意 月

更新期間の単位。 設定可能な値は以下のとおりです。

  • 週
  • 月

デフォルト値：Month 。
AutoRenew Boolean 任意 false

サブスクリプション専用ホストを自動的に更新するかどうかを指定します。 設定可能な値は以下のとおりです。

  • true: サブスクリプション専用ホストを自動的に更新します。
  • false: サブスクリプション専用ホストを自動的に更新しません。

規定値: false
RenewalStatus String 任意 通常

サブスクリプション専用ホストを自動的に更新するかどうかを指定します。 RenewalStatusパラメーターは、AutoRenewパラメーターよりも優先されます。 設定可能な値は以下のとおりです。

  • AutoRenewal: サブスクリプション専用ホストを自動的に更新します。
  • Normal: サブスクリプション専用ホストを自動的に更新しませんが、更新の通知が送信されます。
  • NotRenewal: サブスクリプション専用ホストを自動的に更新せず、有効期限通知は送信されません。 更新の通知は、サブスクリプション専用ホストの有効期限の3日前に自動的に送信されます。 専用ホストのこのパラメーターの値をNotRenewalからNormalに変更し、RenewDedicatedHosts操作を呼び出して手動で更新できます。 または、このパラメーターをAutoRenewalに設定して更新することもできます。
AutoRenewWithEcs String 任意 StopRenewWithEcs

サブスクリプション専用ホストとそれにホストされているサブスクリプションECSインスタンスを自動的に更新するかどうかを指定します。

サブスクリプション専用ホストでホストされているサブスクリプションECSインスタンスに対して自動更新が有効になっている場合、このパラメーターを指定して、サブスクリプションECSインスタンスとともに専用ホストを自動的に更新できます。 専用ホストでホストされているサブスクリプションECSインスタンスが自動的に更新されると、専用ホストの有効期限が更新されたインスタンスの有効期限よりも前の場合、専用ホストも自動的に更新されます。

専用ホストが、ホストされているサブスクリプションECSインスタンスとともに自動的に更新されるように設定されている場合、専用ホストは、更新されたインスタンスの有効期限を決定し、Durationパラメーターの有効値から最小値を選択します。 サポートされている更新期間の詳細については、PeriodUnitおよびDurationパラメーターの説明をご参照ください。

たとえば、今年の1月15日に有効期限が切れるサブスクリプション専用ホストがあるとします。 専用ホストでホストされているサブスクリプションECSインスタンスは自動更新機能が有効になっており、同じ年の11月15日に自動的に更新されます。 専用ホストの有効期限は、ECSインスタンスの有効期限より10か月前です。 この場合、専用ホストは12か月の更新期間を選択します。これは、専用ホストがECSインスタンスより後に期限切れになることを許可するdurationパラメーター (PeriodUnit=Month) の最小値です。

設定可能な値は以下のとおりです。

  • AutoRenewWithEcs: サブスクリプション専用ホストとそれにホストされているサブスクリプションECSインスタンスを自動的に更新します。
  • StopRenewWithEcs: サブスクリプション専用ホストとそれにホストされているサブスクリプションECSインスタンスは自動的に更新されません。
  • NoOperation: 専用ホストの現在の設定は変更されません。
注 このパラメーターをAutoRenewWithEcsに設定した場合、AutoRenewがtrueに設定されていることを確認して、専用ホストの自動更新を有効にします。 それ以外の場合、パラメータ値のみが変更されます。 専用ホストは、ホストされているサブスクリプションECSインスタンスとともに自動的に更新されません。

デフォルト値: NoOperation。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String 2A4EA075-CB5B-41B7-B0EB-70D339F64DE7

リクエストの ID です。

サンプル

リクエストの例

https://ecs.aliyuncs.com/?Action=ModifyDedicatedHostAutoRenewAttribute
&DedicatedHostIds=dh-bp165p6xk2tlw61e ****
&RegionId=cn-hangzhou
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

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

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

JSON 形式 

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

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

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
403 MissingParameter.DedicatedHostId DedicatedHostIdはnullではありません。 DedicatedHostIdsパラメーターが指定されていない場合に返されるエラーメッセージ。
403 InvalidParameter.ToManyDedicatedHostIds DedicatedHostIdは100未満にする必要があります。 DedicatedHostIdsパラメーターに100を超える専用ホストIDが指定されている場合に返されるエラーメッセージ。
403 InvalidParameter.InvalidDedicatedHostId %s 指定されたDedicatedHostIdsパラメーターが無効な場合に返されるエラーメッセージ。
403 IncorrectHostStatus The current status of the resource does not support this operation. この操作が、現在のステータスにある専用ホストではサポートされていない場合に返されるエラーメッセージ。
403 ChargeTypeViolation 従量課金専用ホストはこの操作をサポートしていません。 従量課金の専用ホストがこの操作をサポートしていない場合に返されるエラーメッセージ。
403 InvalidParameter.Duration %s 指定されたDurationパラメーターが無効な場合に返されるエラーメッセージ。
403 InvalidParameter.RenewalStatus %s 指定されたRenewalStatusパラメーターが無効な場合に返されるエラーメッセージ。
403 InvalidPeriodUnit.ValueNotSupported The specified parameter PeriodUnit is not valid. 指定された PeriodUnit パラメーターが無効な場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。