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

1 つ以上の Elastic Compute Service (ECS) インスタンスの完全なステータス情報を照会します。完全なステータス情報には、インスタンスステータスとインスタンスのシステムイベントのステータスが含まれます。インスタンスステータスはインスタンスのライフサイクルステータスであり、インスタンスのシステムイベントのステータスはメンテナンスイベントのヘルスステータスです。

操作説明

注意事項

応答には、インスタンスステータスと、スケジュール済み状態のインスタンスシステムイベントが含まれます。

期間を指定して、その期間内に発生したイベントを照会できます。

今すぐお試しください

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

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	インスタンスが属するリージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
RegionId	string	必須	インスタンスが属するリージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
Status	string	任意	インスタンスのライフサイクルステータス。有効な値： Starting Running Stopped	Running
HealthStatus	string	任意	インスタンスのヘルスステータス。有効な値： Impaired Warning：メンテナンスや技術的な問題により、インスタンスのパフォーマンスが低下する可能性があります。 Maintaining Initializing InsufficientData NotApplicable すべての値で大文字と小文字が区別されます。	Initializing
EventType	string	任意	システムイベントのタイプ。このパラメーターは、InstanceEventType.N が指定されていない場合にのみ有効です。有効な値： SystemMaintenance.Reboot：システムメンテナンスのためインスタンスが再起動されます。 SystemFailure.Reboot：システム障害のためインスタンスが再起動されます。 InstanceFailure.Reboot：インスタンス障害のためインスタンスが再起動されます。 InstanceExpiration.Stop：サブスクリプションインスタンスの有効期限が切れたため停止されます。 InstanceExpiration.Delete：サブスクリプションインスタンスの有効期限が切れたためリリースされます。 AccountUnbalanced.Stop：支払い遅延のため従量課金インスタンスが停止されます。 AccountUnbalanced.Delete：支払い遅延のため従量課金インスタンスがリリースされます。	InstanceExpiration.Stop
NotBefore.Start	string	任意	スケジュールされたシステムイベントに関連する運用保守タスクが実行される期間の開始時刻。時刻は、ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時刻は協定世界時 (UTC) である必要があります。	2017-12-07T00:00:00Z
NotBefore.End	string	任意	スケジュールされたシステムイベントに関連する運用保守タスクが実行される期間の終了時刻。時刻は、ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時刻は協定世界時 (UTC) である必要があります。	2017-11-30T00:00:00Z
EventPublishTime.Start	string	任意	システムイベントが公開される期間の開始時刻。時刻は、ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時刻は協定世界時 (UTC) である必要があります。	2017-11-30T00:00:00Z
EventPublishTime.End	string	任意	システムイベントが公開される期間の終了時刻。時刻は、ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時刻は協定世界時 (UTC) である必要があります。	2017-12-07T00:00:00Z
PageNumber	integer	任意	ページ番号。値は正の整数である必要があります。デフォルト値：1。	1
PageSize	integer	任意	ページあたりのエントリ数。有効な値：1～100。デフォルト値：10。	10
InstanceId	array	任意	インスタンスの ID。1 回のリクエストで最大 100 個のインスタンス ID を指定できます。	i-bp67acfmxazb4p****
	string	任意	インスタンス N の ID。	i-bp67acfmxazb4p****
EventId	array	任意	システムイベントの ID。1 回のリクエストで最大 100 個のイベント ID を指定できます。	e-bp1hygp5b04o56l0****
	string	任意	システムイベントの ID。	e-bp1hygp5b04o56l0****
InstanceEventType	array	任意	システムイベントのタイプ。1 回のリクエストで最大 30 個のイベントタイプを指定できます。	InstanceExpiration.Stop
	string	任意	システムイベントのタイプ。有効な値： SystemMaintenance.Reboot：システムメンテナンスのためインスタンスが再起動されます。 SystemMaintenance.Redeploy：システムメンテナンスのためインスタンスが再デプロイされます。 SystemFailure.Reboot：システムエラーのためインスタンスが再起動されます。 SystemFailure.Redeploy：システムエラーのためインスタンスが再デプロイされます。 SystemFailure.Delete：インスタンス作成の失敗によりインスタンスがリリースされます。 InstanceFailure.Reboot：インスタンスエラーのためインスタンスが再起動されます。 InstanceExpiration.Stop：サブスクリプションインスタンスの有効期限が切れたため停止されます。 InstanceExpiration.Delete：サブスクリプションインスタンスの有効期限が切れたためリリースされます。 AccountUnbalanced.Stop：支払い遅延のため従量課金インスタンスが停止されます。 AccountUnbalanced.Delete：支払い遅延のため従量課金インスタンスがリリースされます。説明詳細については、「概要」をご参照ください。このパラメーターの値は、インスタンスのシステムイベントにのみ適用され、ディスクのシステムイベントには適用されません。	SystemMaintenance.Reboot

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	ページあたりのエントリ数。	1
RequestId	string	リクエストの ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	ページ番号。	1
TotalCount	integer	返されたエントリの総数。	2
InstanceFullStatusSet	object
InstanceFullStatusType	array<object>	照会されたインスタンス。説明インスタンスが存在しない場合、このパラメーターは空になります。
	array<object>
InstanceId	string	インスタンス ID。	i-bp67acfmxazb4p****
ScheduledSystemEventSet	object
ScheduledSystemEventType	array<object>	スケジュール済みまたは問い合わせ中状態のシステムイベント。
	array<object>
EventPublishTime	string	システムイベントが公開された時刻。時刻は協定世界時 (UTC) で表示されます。	2017-11-30T06:32:31Z
EventId	string	システムイベント ID。	e-bp1hygp5b04o56l0****
NotBefore	string	システムイベントに関連する運用保守タスクを実行するスケジュール時刻。時刻は協定世界時 (UTC) で表示されます。	2017-12-07T00:00:00Z
ImpactLevel	string	システムイベントの影響レベル。説明ユーザーがホワイトリストに登録されていない場合、このパラメーターは空になります。	100
Reason	string	システムイベントがスケジュールされた理由。説明異常原因が検出されない場合、このパラメーターは空になります。	A simulated event.
EventCycleStatus	object	システムイベントの状態。
Name	string	システムイベントの状態名。	Scheduled
Code	integer	システムイベントの状態コード。	24
EventType	object	システムイベントのタイプ。
Name	string	システムイベントのタイプ名。	SystemMaintenance.Reboot
Code	integer	システムイベントのタイプコード。	1
ExtendedAttribute	object	ローカルディスクがアタッチされているインスタンスに対して生成されたシステムイベントの拡張属性。戻り値はシステムイベントのタイプによって異なります。システムイベントのタイプが次のいずれでもない場合、このパラメーターは空になります： SystemMaintenance.StopAndRepair SystemMaintenance.CleanInactiveDisks SecurityPunish.Locked SecurityPunish.WebsiteBanned SystemUpgrade.Migrate SystemMaintenance.RebootAndIsolateErrorDisk SystemMaintenance.RebootAndReInitErrorDisk SystemMaintenance.ReInitErrorDisk SystemMaintenance.IsolateErrorDisk
Device	string	ローカルディスクのデバイス名。	/dev/vdb
DiskId	string	ローカルディスクの ID。	d-bp67acfmxazb4p****
InactiveDisks	object
InactiveDisk	array<object>	リリース済みでクリアする必要がある非アクティブなディスク。
	object
CreationTime	string	ディスクが作成された時刻。時刻は、ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式に従います。時刻は協定世界時 (UTC) で表示されます。	2018-07-27T13:53:25Z
DeviceSize	string	ディスクのサイズ。単位：GiB。	80
DeviceCategory	string	ディスクのカテゴリ。有効な値： cloud：基本ディスク cloud_efficiency：Ultra ディスク cloud_ssd：標準 SSD cloud_essd：ESSD (エンタープライズ SSD) local_ssd_pro：I/O 集中型ローカルディスク local_hdd_pro：スループット集中型ローカルディスク ephemeral：廃止されたローカルディスク ephemeral_ssd：廃止されたローカル SSD	cloud_ssd
DeviceType	string	ディスクのタイプ。有効な値： system data	system
ReleaseTime	string	ディスクがリリースされた時刻。時刻は、ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式に従います。時刻は協定世界時 (UTC) で表示されます。	2019-07-27T13:53:25Z
Status	object	インスタンスのライフサイクル状態。
Name	string	インスタンスのライフサイクル状態名。	Running
Code	integer	インスタンスのライフサイクル状態コード。	1
HealthStatus	object	インスタンスのヘルス状態。
Name	string	ヘルス状態名。	Warning
Code	integer	ヘルス状態コード。	64

例

成功レスポンス

JSONJSON

{
  "PageSize": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 2,
  "InstanceFullStatusSet": {
    "InstanceFullStatusType": [
      {
        "InstanceId": "i-bp67acfmxazb4p****",
        "ScheduledSystemEventSet": {
          "ScheduledSystemEventType": [
            {
              "EventPublishTime": "2017-11-30T06:32:31Z",
              "EventId": "e-bp1hygp5b04o56l0****",
              "NotBefore": "2017-12-07T00:00:00Z",
              "ImpactLevel": "100",
              "Reason": "A simulated event.",
              "EventCycleStatus": {
                "Name": "Scheduled",
                "Code": 24
              },
              "EventType": {
                "Name": "SystemMaintenance.Reboot",
                "Code": 1
              },
              "ExtendedAttribute": {
                "Device": "/dev/vdb",
                "DiskId": "d-bp67acfmxazb4p****",
                "InactiveDisks": {
                  "InactiveDisk": [
                    {
                      "CreationTime": "2018-07-27T13:53:25Z",
                      "DeviceSize": "80",
                      "DeviceCategory": "cloud_ssd",
                      "DeviceType": "system",
                      "ReleaseTime": "2019-07-27T13:53:25Z"
                    }
                  ]
                }
              }
            }
          ]
        },
        "Status": {
          "Name": "Running",
          "Code": 1
        },
        "HealthStatus": {
          "Name": "Warning",
          "Code": 64
        }
      }
    ]
  }
}

エラーレスポンス

JSONJSON

{
  "InstanceFullStatusSet": {
    "InstanceFullStatusType": [
      {
        "InstanceId": "i-instance1",
        "Status": {
          "Code": 1,
          "Name": "Running"
        },
        "HealthStatus": {
          "Code": 0,
          "Name": "Maintaining"
        },
        "ScheduledSystemEventSet": {
          "ScheduledSystemEventType": [
            {
              "EventId": "e-event1",
              "EventCycleStatus": {
                "Code": 24,
                "Name": "Scheduled"
              },
              "EventType": {
                "Code": 1,
                "Name": "SystemMaintenance.Reboot"
              },
              "EventPublishTime": "2017-11-30T06:32:31Z",
              "NotBefore": "2017-12-01T06:32:31Z"
            },
            {
              "EventId": "e-event2",
              "EventCycleStatus": {
                "Code": 24,
                "Name": "Scheduled"
              },
              "EventType": {
                "Code": 34,
                "Name": "InstanceExpiration.Stop"
              },
              "EventPublishTime": "2017-11-30T00:00:00Z",
              "NotBefore": "2017-12-07T00:00:00Z"
            }
          ]
        }
      },
      {
        "InstanceId": "i-instance2",
        "Status": {
          "Code": 1,
          "Name": "Running"
        },
        "HealthStatus": {
          "Code": 64,
          "Name": "Warning"
        },
        "ScheduledSystemEventSet": {
          "ScheduledSystemEventType": [
            {
              "EventId": "e-event3",
              "EventCycleStatus": {
                "Code": 24,
                "Name": "Scheduled"
              },
              "EventType": {
                "Code": 65,
                "Name": "SystemFailure.Reboot"
              },
              "EventPublishTime": "2017-11-30T06:32:31Z",
              "NotBefore": "2017-12-01T06:32:31Z"
            }
          ]
        }
      }
    ]
  },
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 2,
  "RequestId": "AAC49D3E-ED6F-4F00-XXXX-377C551B1DD4"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
403	InvalidParameter	%s
403	InvalidParameter.TimeEndBeforeStart	%s
403	OperationDenied.NotInWhiteList	%s
403	InstanceIdLimitExceeded	%s
403	EventIdLimitExceeded	%s
404	MissingParameter	%s

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

変更履歴

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