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

Serverless App Engine:ExecJob

最終更新日:Apr 22, 2026

ExecJob を呼び出してジョブを実行します。

今すぐお試しください

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

この例に基づくと、Commandecho で、CommandArgs["abc", ">", "file0"] です。

echo

CommandArgs

string

任意

Command パラメーターの引数。値は JSON 配列を表す文字列である必要があります。フォーマット:

["a","b"]

Command パラメーターの上記の例では、CommandArgs["abc", ">", "file0"] です。JSON 配列 ["abc", ">", "file0"] は文字列に変換する必要があります。このパラメーターはオプションです。

["a","b"]

Envs

string

任意

コンテナの環境変数。カスタム環境変数を指定するか、既存の ConfigMap を参照できます。ConfigMap の作成方法の詳細については、「CreateConfigMap」をご参照ください。

  • カスタム構成
    • name:環境変数の名前。

    • value:環境変数の値。

  • ConfigMap の参照
    • name:環境変数の名前。単一のキーまたはすべてのキーを参照できます。すべてのキーを参照するには、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

TraceId

string

呼び出しに関する詳細情報を取得するためのトレース ID。

0b87b7e716575071334387401e****

Data

object

返されるデータ。

Data

string

ジョブ ID。

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

Msg

string

返されるメッセージ。

  • リクエストが成功した場合、success が返されます。

  • リクエストが失敗した場合、エラーコードが返されます。

success

Success

string

ジョブが正常に実行されたかどうか。

  • true:実行は成功しました。

  • false:実行は失敗しました。

true

Code

string

HTTP ステータスコードまたは POP エラーコード。

  • 2xx:成功。

  • 3xx:リダイレクト。

  • 4xx:リクエストエラー。

  • 5xx:サーバーエラー。

200

ErrorCode

string

エラーコード。

  • このパラメーターは、成功したリクエストでは省略されます。

  • このパラメーターは、失敗したリクエストに含まれます。詳細については、このトピックの「エラーコード」セクションをご参照ください。

Code

string

HTTP ステータスコードまたは POP エラーコード。

  • 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.

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

変更履歴

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