ジョブを実行します。
今すぐお試しください
テスト
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"、 |
echo |
| CommandArgs |
string |
任意 |
イメージ起動コマンドの引数です。Command パラメーターで指定したコマンドに必要な引数を CommandArgs パラメーターで指定します。値の形式は以下のとおりです:
上記の例では、 |
["a","b"] |
| Envs |
string |
任意 |
環境変数です。カスタム環境変数を設定するか、ConfigMap を参照できます。ConfigMap を参照する場合は、事前に ConfigMap を作成しておく必要があります。詳細については、「CreateConfigMap」をご参照ください。有効な値は以下のとおりです:
|
[{"name":"envtmp","value":"0"}] |
| JarStartOptions |
string |
任意 |
JAR パッケージのオプション設定です。この設定はジョブの起動に使用されます。デフォルトの起動コマンドは |
-Xms4G -Xmx4G |
| JarStartArgs |
string |
任意 |
JAR パッケージの引数です。この引数はジョブの起動に使用されます。デフォルトの起動コマンドは |
custom-args |
| WarStartOptions |
string |
任意 |
WAR パッケージの起動コマンドです。起動コマンドの設定方法については、「起動コマンドの設定」をご参照ください。 |
CATALINA_OPTS=\"$CATALINA_OPTS $Options\" catalina.sh run |
| Time |
string |
任意 |
ジョブがトリガーされる時刻です。フォーマットは |
2023-09-14T14:25:02Z |
| Replicas |
string |
任意 |
同時実行インスタンス数です。 |
3 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答です。 |
||
| RequestId |
string |
リクエスト ID です。 |
67DD9A98-9CCC-5BE8-8C9E-B45E72F4**** |
| Message |
string |
返されたメッセージです。有効な値は以下のとおりです:
|
success |
| TraceId |
string |
トレース ID です。このパラメーターは、正確な呼び出し情報を照会するために使用されます。 |
0b87b7e716575071334387401e**** |
| Data |
object |
返されたデータです。 |
|
| Data |
string |
ジョブ ID です。 |
manual-3db7a8fa-5d40-4edc-92e4-49d50eab**** |
| Msg |
string |
返されたメッセージです。有効な値は以下のとおりです:
|
success |
| Success |
string |
リクエストが成功したかどうかを示します。有効な値は以下のとおりです:
|
true |
| Code |
string |
HTTP ステータスコードです。有効な値は以下のとおりです:
|
200 |
| ErrorCode |
string |
エラーコードです。有効な値は以下のとおりです:
|
空 |
| Code |
string |
HTTP ステータスコードです。有効な値は以下のとおりです:
|
200 |
| Success |
boolean |
リクエストが成功したかどうかを示します。有効な値は以下のとおりです:
|
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。