ListDoctorJobs 呼び出しによる複数ジョブの基本実行情報の取得 - E-MapReduce

E-MapReduce (EMR) Doctor で、複数のジョブの基本的な実行情報を一度に取得します。

操作説明

YARN によってリアルタイムジョブを一覧表示します

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

emr:ListDoctorJobs

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。	cn-hangzhou
ClusterId	string	必須	クラスター ID。	c-b933c5aac8fe****
NextToken	string	任意	リクエストで使用されるページネーショントークン。新しい結果ページを取得するために使用されます。	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	任意	各ページで返すエントリの最大数。	20
StartRange	object	任意	開始時刻の範囲。指定した時間範囲内に開始時刻があるジョブをフィルターできます。
StartTime	integer	任意	ジョブが送信された時間範囲の開始時刻。この値は、協定世界時 (UTC) 1970年1月1日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。単位：ミリ秒。	1683340662016
EndTime	integer	任意	ジョブが送信された時間範囲の終了時刻。この値は、協定世界時 (UTC) 1970年1月1日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。単位：ミリ秒。	1683340662020
EndRange	object	任意	終了時刻の範囲。指定した時間範囲内に終了時刻があるジョブをフィルターできます。
StartTime	integer	任意	ジョブが終了した時間範囲の開始時刻。この値は、協定世界時 (UTC) 1970年1月1日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。単位：ミリ秒。	1679135111960
EndTime	integer	任意	ジョブが終了した時間範囲の終了時刻。この値は、協定世界時 (UTC) 1970年1月1日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。単位：ミリ秒。	1666865137099
AppIds	array	任意	YARN に送信されるジョブの ID。	null
	string	任意	YARN に送信されるジョブの ID。	application_1643475036865_******
Users	array	任意	ジョブを送信するユーザー。	null
	string	任意	ジョブを YARN に送信するために使用されるユーザー名。	DW
Queues	array	任意	ジョブが送信される YARN キュー。	null
	string	任意	ジョブが送信される YARN キューの名前。	DW
Types	array	任意	ジョブが送信される YARN エンジン。	null
	string	任意	ジョブが送信される YARN エンジンのタイプ。	SPARK
OrderType	string	任意	クエリ結果をソートする順序。有効な値： ASC：昇順 DESC：降順	ASC
OrderBy	string	任意	クエリ結果のソートに使用するフィールド。有効な値： vcoreSeconds：ジョブに割り当てられた vCPU の集計数に、ジョブの実行秒数を乗算した値 memSeconds：ジョブに割り当てられたメモリの集計量に、ジョブの実行秒数を乗算した値	vcoreSeconds

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
Data	array<object>	ジョブに関する情報。
	array<object>
AppId	string	YARN に送信されたジョブの ID。	application_1607584549220_*****
AppName	string	ジョブの名前。	tpcds
User	string	ジョブの送信に使用されたユーザー名。	DW
Queue	string	ジョブが送信された YARN キュー。	DW
State	string	ジョブの実行状態。有効な値： FINISHED FAILED KILLED	FINISHED
FinalStatus	string	ジョブの最終状態。有効な値： SUCCEEDED FAILED KILLED ENDED UNDEFINED	KILLED
Type	string	コンピュートエンジンのタイプ。	SPARK
StartTime	integer	ジョブが送信された時刻。この値は、協定世界時 (UTC) 1970年1月1日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。単位：ミリ秒。	1675180800000
LaunchTime	integer	ジョブが開始された時刻。この値は、協定世界時 (UTC) 1970年1月1日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。単位：ミリ秒。	1672148400000
ElapsedTime	integer	ジョブの合計実行時間。単位：ミリ秒。	242
FinishTime	integer	ジョブの終了時刻。この値は、協定世界時 (UTC) 1970年1月1日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。単位：ミリ秒。	1683690929000
Metrics	object	メトリックに関するデータ。
VcoreSeconds	object	CPU 使用量。
Name	string	メトリックの名前。	vcoreSeconds
Value	integer	メトリックの値。	11123
Unit	string	メトリックの単位。	VCores * Sec
Description	string	メトリックの説明。	Total vcore usage over time in seconds
MemSeconds	object	消費されたメモリ量。
Name	string	メトリックの名前。	memSeconds
Value	integer	メトリックの値。	12312312
Unit	string	メトリックの単位。	MB * Sec
Description	string	メトリックの説明。	Total memory usage over time in seconds
RequestId	string	リクエスト ID。	DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextToken	string	ページネーショントークン。	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	返されたエントリの最大数。	20
TotalCount	integer	返されたエントリの総数。	200

例

成功レスポンス

JSONJSON

{
  "Data": [
    {
      "AppId": "application_1607584549220_*****",
      "AppName": "tpcds",
      "User": "DW",
      "Queue": "DW",
      "State": "FINISHED",
      "FinalStatus": "KILLED",
      "Type": "SPARK",
      "StartTime": 1675180800000,
      "LaunchTime": 1672148400000,
      "ElapsedTime": 242,
      "FinishTime": 1683690929000,
      "Metrics": {
        "VcoreSeconds": {
          "Name": "vcoreSeconds\n",
          "Value": 11123,
          "Unit": "VCores * Sec\n",
          "Description": "Total vcore usage over time in seconds\n"
        },
        "MemSeconds": {
          "Name": "memSeconds",
          "Value": 12312312,
          "Unit": "MB * Sec\n",
          "Description": "Total memory usage over time in seconds\n"
        }
      }
    }
  ],
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "NextToken": "DD6B1B2A-5837-5237-ABE4-FF0C89568980",
  "MaxResults": 20,
  "TotalCount": 200
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ConflictParameters	Parameters that must not be used together. %s
400	IncompleteSignature	The request signature is invalid.
400	InvalidAction	The action %s requested is invalid.
400	InvalidParameter	The specified parameter %s is not valid.
400	InvalidParameterValue	The input parameter %s is invalid or out of range.
400	MissingAction	The action %s requested is missing.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
400	NotAuthorized	You do not have permission to perform this action. %s
400	ThrottlingException	The request was denied due to request throttling. %s
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
404	ResourceNotFound	The resource not found by %s.
503	ServiceFailure	The request has failed due to a temporary failure of %s service.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

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

変更履歴

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