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

インスタンスのメンテナンス属性をクエリします。

操作説明

この操作は、インスタンスの指定されたメンテナンスポリシーをクエリするために使用されます。これには、次のメンテナンス属性が含まれます：

メンテナンスウィンドウ：メンテナンスのために指定する期間。
メンテナンス操作：インスタンスのシャットダウンに応答して指定する操作。

今すぐお試しください

この 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:DescribeInstanceMaintenanceAttributes

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	インスタンスのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1。	1
PageSize	integer	任意	1ページあたりのエントリ数。有効値の範囲：1～100。デフォルト値：10。	10
InstanceId	array	任意	インスタンス ID。最大 100 個のインスタンス ID を指定できます。	i-bp67acfmxazb4p****
	string	任意	インスタンス ID。	i-bp67acfmxazb4p****

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	1ページあたりのエントリ数。	10
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	ページ番号。	1
TotalCount	integer	クエリされたメンテナンス属性の総数。	100
MaintenanceAttributes	object
MaintenanceAttribute	array<object>	メンテナンス属性。
	array<object>
NotifyOnMaintenance	boolean	メンテナンス前にイベント通知が送信されたかどうかを示します。	false
InstanceId	string	インスタンス ID。	i-bp67acfmxazb4p****
MaintenanceWindows	object
MaintenanceWindow	array<object>	メンテナンスウィンドウ。
	object
EndTime	string	メンテナンスウィンドウの終了時刻。	18:00:00
StartTime	string	メンテナンスウィンドウの開始時刻。	02:00:00
ActionOnMaintenance	object	インスタンスのメンテナンス操作の属性。
DefaultValue	string	デフォルトのメンテナンス操作。	AutoRecover
Value	string	現在のメンテナンス操作。有効な値： Stop：インスタンスを停止します。 AutoRecover：インスタンスを自動的に回復します。 AutoRedeploy：インスタンスを再デプロイします。これにより、インスタンスにアタッチされているデータディスクが破損する可能性があります。	Stop
SupportedValues	object
SupportedValue	array	サポートされているメンテナンス操作。
	string	サポートされているメンテナンス操作。	Stop

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 100,
  "MaintenanceAttributes": {
    "MaintenanceAttribute": [
      {
        "NotifyOnMaintenance": false,
        "InstanceId": "i-bp67acfmxazb4p****",
        "MaintenanceWindows": {
          "MaintenanceWindow": [
            {
              "EndTime": "18:00:00",
              "StartTime": "02:00:00"
            }
          ]
        },
        "ActionOnMaintenance": {
          "DefaultValue": "AutoRecover",
          "Value": "Stop",
          "SupportedValues": {
            "SupportedValue": [
              "Stop"
            ]
          }
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParameter	%s
403	InvalidParameter	%s
403	InstanceIdLimitExceeded	%s
403	OperationDenied.NotInWhiteList	%s
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.

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

変更履歴

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