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

DescribeTasks を呼び出して、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:DescribeTasks

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。有効な値：1～100。デフォルト値：10。	10
RegionId	string	必須	リージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
TaskIds	string	任意	タスク ID。一度に最大 100 個のタスク ID を指定できます。タスク ID はコンマ (,) で区切ります。	t-bp1hvgwromzv32iq**,t-bp179lofu2pv768w**
TaskAction	string	任意	タスクを生成する操作の名前。有効な値： ImportImage ExportImage RedeployInstance ModifyDiskSpec ArchiveSnapshot	ImportImage
TaskStatus	string	任意	タスクステータス。有効な値： Finished Processing Failed デフォルトでは、このパラメーターは空のままです。説明システムは、Finished、Processing、および Failed 状態のタスクのみをクエリし、他の値は無視します。	Finished
StartTime	string	任意	クエリする期間の開始時刻。期間とは、タスクが作成された期間を指します。時刻は、ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時刻は協定世界時 (UTC) である必要があります。	2020-11-23T15:10:00Z
EndTime	string	任意	クエリする期間の終了時刻。期間とは、タスクが作成された期間を指します。時刻は、ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時刻は協定世界時 (UTC) である必要があります。	2020-11-23T15:16:00Z
ResourceIds	array	任意	タスクに関連付けられているリソースの ID。 N の有効な値：1～100。
	string	任意	リソース N の ID。 N の有効な値：1～100。 TaskAction を ImportImage または ExportImage に設定した場合は、イメージ ID をリソース ID として指定します。 TaskAction を RedeployInstance に設定した場合は、Elastic Compute Service (ECS) インスタンスの ID をリソース ID として指定します。 TaskAction を ModifyDiskSpec に設定した場合は、ディスク ID をリソース ID として指定します。	m-bp1i8huqm5u7****
TaskGroupId	string	任意	タスクグループ ID。説明このパラメーターは招待プレビューです。このパラメーターを使用すると、他のクエリ条件は無効になります。	g-2ze2op2grqpclwu7****

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	1 ページあたりのエントリ数。	10
PageNumber	integer	ページ番号。	1
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	返されたエントリの総数。	1
RegionId	string	リージョン ID。	cn-hangzhou
TaskSet	object
Task	array<object>	タスクの詳細。
	object
CreationTime	string	タスクが作成された時刻。	2020-11-24T12:50Z
TaskStatus	string	タスクステータス。	Finished
FinishedTime	string	タスクが終了した時刻。	2020-11-24T12:50Z
SupportCancel	string	タスクをキャンセルできるかどうかを示します。	true
TaskId	string	タスク ID。	t-bp1hvgwromzv32iq****
TaskAction	string	タスクを生成する操作の名前。	ImportImage
ResourceId	string	リソース ID。	m-bp1i8huqm5u7****

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "RegionId": "cn-hangzhou",
  "TaskSet": {
    "Task": [
      {
        "CreationTime": "2020-11-24T12:50Z",
        "TaskStatus": "Finished",
        "FinishedTime": "2020-11-24T12:50Z",
        "SupportCancel": "true",
        "TaskId": "t-bp1hvgwromzv32iq****",
        "TaskAction": "ImportImage",
        "ResourceId": "m-bp1i8huqm5u7****"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	MissingParameter	An input parameter "RegionId" that is mandatory for processing the request is not supplied.
400	InvalidRegionId.NotFound	The specified RegionId does not exist.

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

変更履歴

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