すべてのプロダクト
Search
ドキュメントセンター

:ExecJob

最終更新日:Mar 17, 2026

ジョブを実行します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sae:ExecJob

*All Resource

*

なし なし

リクエスト構文

GET /pop/v1/sam/job/execJob HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

AppId

string

必須

ジョブテンプレートの ID です。

ee1a7a07-abcb-4652-a1d3-2d57f415****

EventId

string

任意

イベント ID です。このパラメーターは、同一のイベント ID に対して 1 つのジョブのみが作成されるよう、冪等性を保証するためにユーザーが定義するものです。

custom

Command

string

任意

コンテナイメージを起動するコマンドです。このコマンドは、コンテナ内に存在する実行可能オブジェクトである必要があります。例:

command:
      - echo
      - abc
      - >
      - file0

この例では、Command="echo"、CommandArgs=["abc", ">", "file0"] と設定されます。

echo

CommandArgs

string

任意

イメージ起動コマンドの引数です。Command パラメーターで指定したコマンドに必要な引数を CommandArgs パラメーターで指定します。値の形式は以下のとおりです:

["a","b"]

上記の例では、CommandArgs=["abc", ">", "file0"] と設定されます。["abc", ">", "file0"] のデータの型は、JSON 形式の文字列配列である必要があります。このパラメーターは任意です。

["a","b"]

Envs

string

任意

環境変数です。カスタム環境変数を設定するか、ConfigMap を参照できます。ConfigMap を参照する場合は、事前に ConfigMap を作成しておく必要があります。詳細については、「CreateConfigMap」をご参照ください。有効な値は以下のとおりです:

  • カスタム環境変数の設定

    • name:環境変数の名前です。

    • value:環境変数の値です。

  • ConfigMap の参照

    • name:環境変数の名前です。1 つのキーまたはすべてのキーを参照できます。すべてのキーを参照する場合は、sae-sys-configmap-all-<ConfigMap 名> を指定します(例:sae-sys-configmap-all-test1)。

    • valueFrom:環境変数の参照先です。configMapRef を指定します。

    • configMapId:ConfigMap の ID です。

    • key:キーです。すべてのキーを参照する場合は、このパラメーターを設定しないでください。

[{"name":"envtmp","value":"0"}]

JarStartOptions

string

任意

JAR パッケージのオプション設定です。この設定はジョブの起動に使用されます。デフォルトの起動コマンドは $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArg です。

-Xms4G -Xmx4G

JarStartArgs

string

任意

JAR パッケージの引数です。この引数はジョブの起動に使用されます。デフォルトの起動コマンドは $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs です。

custom-args

WarStartOptions

string

任意

WAR パッケージの起動コマンドです。起動コマンドの設定方法については、「起動コマンドの設定」をご参照ください。

CATALINA_OPTS=\"$CATALINA_OPTS $Options\" catalina.sh run

Time

string

任意

ジョブがトリガーされる時刻です。フォーマットは yyyy-MM-dd'T'HH:mm:ss'Z' です。

2023-09-14T14:25:02Z

Replicas

string

任意

同時実行インスタンス数です。

3

レスポンスフィールド

フィールド

説明

object

応答です。

RequestId

string

リクエスト ID です。

67DD9A98-9CCC-5BE8-8C9E-B45E72F4****

Message

string

返されたメッセージです。有効な値は以下のとおりです:

  • success:呼び出しが成功した場合、success が返されます。

  • エラーコード:呼び出しが失敗した場合、エラーコードが返されます。

success

TraceId

string

トレース ID です。このパラメーターは、正確な呼び出し情報を照会するために使用されます。

0b87b7e716575071334387401e****

Data

object

返されたデータです。

Data

string

ジョブ ID です。

manual-3db7a8fa-5d40-4edc-92e4-49d50eab****

Msg

string

返されたメッセージです。有効な値は以下のとおりです:

  • success:呼び出しが成功した場合、success が返されます。

  • エラーコード:呼び出しが失敗した場合、エラーコードが返されます。

success

Success

string

リクエストが成功したかどうかを示します。有効な値は以下のとおりです:

  • true

  • false

true

Code

string

HTTP ステータスコードです。有効な値は以下のとおりです:

  • 2xx:呼び出しが成功しました。

  • 3xx:呼び出しがリダイレクトされました。

  • 4xx:呼び出しが失敗しました。

  • 5xx:サーバーエラーが発生しました。

200

ErrorCode

string

エラーコードです。有効な値は以下のとおりです:

  • 呼び出しが成功した場合、ErrorCode パラメーターは返されません。

  • 呼び出しが失敗した場合、ErrorCode パラメーターが返されます。詳細については、本トピックの「エラーコード」セクションをご参照ください。

Code

string

HTTP ステータスコードです。有効な値は以下のとおりです:

  • 2xx:呼び出しが成功しました。

  • 3xx:呼び出しがリダイレクトされました。

  • 4xx:呼び出しが失敗しました。

  • 5xx:サーバーエラーが発生しました。

200

Success

boolean

リクエストが成功したかどうかを示します。有効な値は以下のとおりです:

  • true

  • false

true

成功レスポンス

JSONJSON

{
  "RequestId": "67DD9A98-9CCC-5BE8-8C9E-B45E72F4****",
  "Message": "success",
  "TraceId": "0b87b7e716575071334387401e****",
  "Data": {
    "Data": "manual-3db7a8fa-5d40-4edc-92e4-49d50eab****",
    "Msg": "success",
    "Success": "true",
    "Code": "200"
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidApplication.NotFound The current application does not exist.
400 JobForbidPolicy You cannot execute new jobs because ongoing jobs exist.
400 JobSuspend The job is suspended.
400 user.indebt The user has an outstanding payment.

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

変更履歴

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