DescribeDedicatedHostAutoRenew - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

1 つ以上のサブスクリプション方式の専用ホストの自動更新ステータスを照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeDedicatedHostAutoRenew

get

*DedicatedHost

acs:ecs:{#regionId}:{#accountId}:ddh/{#ddhId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DedicatedHostIds	string	必須	専用ホストの ID。最大 100 個のサブスクリプション方式の専用ホスト ID を指定できます。複数の ID はコンマ (,) で区切ります。	dh-bp165p6xk2tlw61e**,dh-bp1f9vxmno**
RegionId	string	必須	専用ホストが存在するリージョンの ID。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	04F0F334-1335-436C-A1D7-6C044FE73368
DedicatedHostRenewAttributes	object
DedicatedHostRenewAttribute	array<object>	専用ホストの自動更新属性で構成される配列。
	object
PeriodUnit	string	自動更新期間の単位。有効な値： Week Month	Month
Duration	integer	自動更新期間。	0
DedicatedHostId	string	専用ホストの ID。	dh-bp165p6xk2tlw61e****
RenewalStatus	string	サブスクリプション方式の専用ホストが自動更新されるかどうかを示します。有効な値： AutoRenewal: 専用ホストは自動的に更新されます。 Normal: 専用ホストは自動更新されませんが、更新通知は送信されます。 NotRenewal: 専用ホストは自動更新されず、有効期限通知も送信されません。Alibaba Cloud は、ホストの有効期限が切れる 3 日前に、更新しない旨の通知のみを送信します。専用ホストの更新ステータスが NotRenewal の場合、値を Normal に変更してから RenewDedicatedHosts を呼び出して専用ホストを手動で更新するか、値を直接 AutoRenewal に変更できます。	Normal
AutoRenewEnabled	boolean	自動更新が有効かどうかを示します。有効な値： true false	false
AutoRenewWithEcs	string	ホストされているサブスクリプション方式の ECS インスタンスが自動更新された後、その新しい有効期限が専用ホストの有効期限よりも後になる場合に、専用ホストが自動的に更新されるかどうかを示します。有効な値： AutoRenewWithEcs: 専用ホストは ECS インスタンスと共に自動的に更新されます。 StopRenewWithEcs: 専用ホストは ECS インスタンスと共に自動的に更新されません。	StopRenewWithEcs

例

成功レスポンス

JSONJSON

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "DedicatedHostRenewAttributes": {
    "DedicatedHostRenewAttribute": [
      {
        "PeriodUnit": "Month",
        "Duration": 0,
        "DedicatedHostId": "dh-bp165p6xk2tlw61e****",
        "RenewalStatus": "Normal",
        "AutoRenewEnabled": false,
        "AutoRenewWithEcs": "StopRenewWithEcs"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
403	ChargeTypeViolation	Pay-As-You-Go dedicated host does not support this operation.
403	MissingParameter.DedicatedHostId	DedicatedHostId should not be null.
403	InvalidParameter.ToManyDedicatedHostIds	DedicatedHostId should be less than 100.
403	InvalidParameter.InvalidDedicatedHostId	%s
403	IncorrectDedicatedHostStatus	The current status of the resource does not support this operation.
403	MissingParamter.InstanceId	InstanceId should not be null.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。