GetRunningJobs API による実行中ジョブの取得 - MaxCompute

指定された期間において、実行中のジョブの実行状態データを取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

odps:GetRunningJobs

list

*All Resource

*

なし

リクエスト構文

GET /api/v1/jobs/runningJobs HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
from	integer	必須	クエリの開始時刻。このパラメーターは、ジョブが送信された時刻を指定します。 from および to リクエストパラメーターで指定される時間範囲は閉区間です。開始時刻と終了時刻は範囲に含まれます。 from の値が to の値と同じ場合、時間範囲は無効となり、null 値が返されます。値は、1970年1月1日 00:00:00 UTC から経過した秒数を表す UNIX タイムスタンプです。	1683785928
to	integer	必須	クエリの終了時刻。このパラメーターは、ジョブが送信された時刻を指定します。 from および to リクエストパラメーターで指定される時間間隔は閉区間です。開始時刻と終了時刻は間隔に含まれます。 from の値が to の値と同じ場合、間隔は無効となり、null 値が返されます。値は、1970年1月1日 00:00:00 UTC から経過した秒数を表す UNIX タイムスタンプです。	1683612946
jobOwnerList	array	任意	ジョブの実行者のリスト。
	string	任意	ジョブの実行者のリスト。	ALIYUN$xxx@test.aliyunid.com
quotaNicknameList	array	任意	ジョブが使用するクォータのニックネームのリスト。
	string	任意	ジョブが使用するクォータのニックネームのリスト。	my_quota
pageNumber	integer	任意	ページ番号。	1
pageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値：10。最大値：20。	10

レスポンスフィールド

フィールド	型	説明	例
	object	PopResult
requestId	string	リクエストの ID。	0bc3b4ab16684833172127321e2c25
httpCode	integer	リクエストが成功したかどうかを示します。このパラメーターが空でなく、かつ値が 200 でない場合、リクエストは失敗です。	200
errorCode	string	success の値が false の場合、エラーコードが返されます。 success の値が true の場合、null 値が返されます。	success
errorMsg	string	エラーメッセージ。	0A3B1FD2006A24C8D8BE65CDAC028298
data	object	返されたデータ。
runningJobInfoList	array<object>	実行状態のジョブのリスト。
	object
instanceId	string	インスタンス ID。	2023050206371544gomgtp3ljcr4
jobOwner	string	ジョブを送信するアカウント。	ALIYUN$xxx@test.aliyunid.com
project	string	MaxCompute プロジェクトの名前。	project_20221021123044_981b
quotaNickname	string	ジョブが使用するクォータのニックネーム。	my_quota
cuSnapshot	number	ジョブの計算ユニット (CU) のスナップショットの割合。	0.45
memorySnapshot	number	ジョブのメモリのスナップショットの割合。	0.45
submittedAtTime	integer	ジョブが送信された時刻。	1689746864
runningAtTime	integer	ジョブの実行が開始された時刻。	1689746864
progress	number	ジョブの進捗。	0
totalCount	integer	返されたエントリの総数。	64
pageNumber	integer	ページ番号。	2
pageSize	integer	1 ページあたりのエントリ数。	10

例

成功レスポンス

JSONJSON

{
  "requestId": "0bc3b4ab16684833172127321e2c25",
  "httpCode": 200,
  "errorCode": "success",
  "errorMsg": "0A3B1FD2006A24C8D8BE65CDAC028298",
  "data": {
    "runningJobInfoList": [
      {
        "instanceId": "2023050206371544gomgtp3ljcr4",
        "jobOwner": "ALIYUN$xxx@test.aliyunid.com",
        "project": "project_20221021123044_981b",
        "quotaNickname": "my_quota",
        "cuSnapshot": 0.45,
        "memorySnapshot": 0.45,
        "submittedAtTime": 1689746864,
        "runningAtTime": 1689746864,
        "progress": 0
      }
    ],
    "totalCount": 64,
    "pageNumber": 2,
    "pageSize": 10
  }
}

エラーコード

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

変更履歴

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