DescribeJob API を呼び出して、ジョブテンプレートの設定を取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sae:DescribeJob |
get |
*All Resource
|
なし | なし |
リクエスト構文
GET /pop/v1/sam/job/describeJob HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AppId |
string |
必須 |
ジョブテンプレート ID。 |
7171a6ca-d1cd-4928-8642-7d5cfe69**** |
| JobId |
string |
任意 |
ジョブ ID。 |
event-b798157b-40a2-4388-b578-71fb897103**-** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返されるデータ。 |
||
| RequestId |
string |
リクエスト ID。 |
01CF26C7-00A3-4AA6-BA76-7E95F2A3**** |
| Message |
string |
呼び出し結果に関する追加情報。 |
success |
| TraceId |
string |
リクエストの詳細を照会するために使用されるトレース ID。 |
ac1a0b2215622246421415014e**** |
| Data |
object |
ジョブテンプレート情報。 |
|
| VpcId |
string |
VPC ID。 |
vpc-2ze0i263cnn311nvj**** |
| ConfigMapMountDesc |
array<object> |
マウントされた ConfigMap に関する情報。 |
|
|
object |
ConfigMap 情報。 |
||
| Key |
string |
ConfigMap 内のキーと値のペアのキー。 |
k1 |
| ConfigMapName |
string |
ConfigMap の名前。 |
test |
| MountPath |
string |
コンテナのマウントパス。 |
/tmp |
| ConfigMapId |
integer |
ConfigMap ID。 |
1 |
| SecurityGroupId |
string |
セキュリティグループ ID。 |
sg-wz969ngg2e49q5i4**** |
| Jdk |
string |
デプロイメントパッケージが必要とする JDK バージョン。次のバージョンがサポートされています:
このパラメーターは、パッケージタイプがイメージに設定されている場合は適用されません。 |
Open JDK 8 |
| ImageUrl |
string |
イメージ URL。このパラメーターは、パッケージタイプがイメージに設定されている場合に必要です。 |
docker.io/library/nginx:1.14.2 |
| SlsConfigs |
string |
Log Service (SLS) にログを収集するための設定。
パラメーターは次のとおりです:
再デプロイ時に Log Service の設定が変更されない場合、このパラメーターは省略できます。ログ収集を無効にするには、このパラメーターを空の文字列 ( |
[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}] |
| Tags |
array<object> |
ジョブテンプレートのタグ。 |
|
|
object |
タグ情報。 |
||
| Key |
string |
タグキー。 |
k1 |
| Value |
string |
タグ値。 |
v1 |
| PackageUrl |
string |
パッケージの URL。このパラメーターは、パッケージタイプが FatJar または War に設定されている場合に必要です。 |
https://edas-bj.oss-cn-beijing.aliyuncs.com/apps/K8s_APP_ID/d4c97c37-aba3-403e-ae1e-6f7d8742****/hello-sae.war |
| PackageType |
string |
ジョブパッケージのタイプ。有効な値:
|
War |
| PreStop |
string |
コンテナが停止する前に実行するスクリプト。このスクリプトは、システムがコンテナを削除する前に実行されます。例: |
{"exec":{"command":["cat","/etc/group"]}} |
| PackageVersion |
string |
パッケージのバージョン。このパラメーターは、パッケージタイプが FatJar または War に設定されている場合に必要です。 |
1.0 |
| JarStartArgs |
string |
JAR パッケージの起動引数。デフォルトの起動コマンドは |
start |
| AppName |
string |
ジョブテンプレートの名前。 |
demo-app |
| AppId |
string |
ジョブテンプレートの ID。 |
7171a6ca-d1cd-4928-8642-7d5cfe69**** |
| JarStartOptions |
string |
JAR パッケージの起動オプション。デフォルトの起動コマンドは |
-Dtest=true |
| Replicas |
integer |
ジョブインスタンスの数。 |
2 |
| Memory |
integer |
各インスタンスで必要なメモリ (MB)。この値を 0 にすることはできません。CPU とメモリリソースは固定比率で割り当てられます。次の組み合わせがサポートされています:
|
2048 |
| PhpConfig |
string |
PHP 設定ファイルの内容。 |
k1=v1 |
| PhpConfigLocation |
string |
PHP ジョブ起動設定のマウントパス。PHP サーバーがこの設定を使用して起動することを確認してください。 |
/usr/local/etc/php/php.ini |
| PostStart |
string |
コンテナが起動した後に実行するスクリプト。このスクリプトは、システムがコンテナを作成した直後に実行されます。例: |
{"exec":{"command":["cat","/etc/group"]}} |
| TerminationGracePeriodSeconds |
integer |
グレースフルストップのタイムアウト (秒)。デフォルト:30。有効な値:1~300。 |
10 |
| CommandArgs |
string |
イメージ起動コマンドの引数。引数は Command パラメーターに渡されます。フォーマット:
Command パラメーターの例では、 |
["a","b"] |
| NamespaceId |
string |
名前空間 ID。 |
cn-beijing:test |
| MountHost |
string |
ジョブテンプレートの VPC 内にある Apsara File Storage NAS ファイルシステムのマウントポイント。再デプロイ時に NAS 設定が変更されない場合、このパラメーターは省略できます。NAS 設定をクリアするには、このパラメーターを空の文字列 ( |
example.com |
| TomcatConfig |
string |
Tomcat ファイル設定。設定を削除するには、このパラメーターを "" または "{}" に設定します。
|
{"port":8080,"contextPath":"/","maxThreads":400,"uriEncoding":"ISO-8859-1","useBodyEncodingForUri":true} |
| RegionId |
string |
リージョン ID。 |
cn-beijing |
| VSwitchId |
string |
vSwitch ID。 |
vsw-2ze559r1z1bpwqxwp**** |
| Cpu |
integer |
各インスタンスで必要な CPU コア数。単位:ミリコア。このパラメーターを 0 に設定することはできません。次の固定仕様のみがサポートされています:
|
1000 |
| Envs |
string |
コンテナの環境変数。カスタム変数を定義するか、ConfigMap を参照できます。ConfigMap を参照するには、まず ConfigMap を作成する必要があります。詳細については、「CreateConfigMap」をご参照ください。次のフォーマットがサポートされています:
|
[{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}] |
| MountDesc |
array<object> |
マウントの説明。 |
|
|
object |
マウントの説明。 |
||
| MountPath |
string |
コンテナのマウントパス。 |
/tmp |
| NasPath |
string |
Apsara File Storage NAS ファイルシステム内のディレクトリ。 |
/ |
| CustomHostAlias |
string |
コンテナ内のカスタムホストマッピング。パラメーターは次のとおりです:
|
[{"hostName":"test.host.name","ip":"0.0.0.0"}] |
| WebContainer |
string |
パッケージが依存する Tomcat コンテナのバージョン。次のバージョンがサポートされています:
このパラメーターは、パッケージタイプがイメージに設定されている場合はサポートされません。 |
apache-tomcat-7.0.91 |
| Command |
string |
イメージの起動コマンド。コマンドは、コンテナ内に存在する実行可能ファイルである必要があります。例:
この例では、 |
echo |
| WarStartOptions |
string |
WAR パッケージの起動オプション。デフォルトの起動コマンドは |
custom-option |
| NasId |
string |
Apsara File Storage NAS ファイルシステムの ID。 |
AKSN89** |
| OssAkId |
string |
Object Storage Service (OSS) バケットにアクセスするための AccessKey ID。 |
xxxxxx |
| OssAkSecret |
string |
OSS バケットにアクセスするための AccessKey Secret。 |
xxxxxx |
| OssMountDescs |
array<object> |
マウントされた OSS バケットの説明。 |
|
|
object |
マウントされた OSS バケットの説明。 |
||
| bucketName |
string |
バケット名。 |
oss-bucket |
| bucketPath |
string |
OSS バケットに作成したディレクトリまたはオブジェクト。指定したマウントディレクトリが存在しない場合、例外が返されます。 |
data/user.data |
| mountPath |
string |
SAE コンテナ内のパス。パスが存在する場合、上書きされます。パスが存在しない場合、新しいパスが作成されます。 |
/usr/data/user.data |
| readOnly |
boolean |
コンテナがマウントされたリソースに対して読み取り専用アクセス権を持つかどうかを指定します。有効な値:
|
true |
| EdasContainerVersion |
string |
HSF フレームワークの実行環境のバージョン (Ali-Tomcat コンテナなど)。 |
3.5.3 |
| Timezone |
string |
タイムゾーン。デフォルト値:Asia/Shanghai。 |
Asia/Shanghai |
| AppDescription |
string |
ジョブテンプレートの説明。 |
Sample application |
| AcrInstanceId |
string |
Container Registry (ACR) Enterprise Edition インスタンスの ID。 |
cri-xxxxxx |
| AcrAssumeRoleArn |
string |
アカウント間でイメージをプルするために必要な RAM ロールの ARN。詳細については、「Alibaba Cloud アカウント間でのイメージのプル」および「RAM ロールを使用した Alibaba Cloud アカウント間での権限付与」をご参照ください。 |
acs:ram::123456789012****:role/adminrole |
| ImagePullSecrets |
string |
Secret の ID。 |
10 |
| TriggerConfig |
string |
ジョブトリガー設定。設定はジョブタイプによって異なります。
|
{"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"} |
| ConcurrencyPolicy |
string |
ジョブの同時実行ポリシー。有効な値:
|
Allow |
| Suspend |
boolean |
ジョブテンプレートを一時停止するかどうかを指定します。 |
false |
| Timeout |
integer |
ジョブのタイムアウト期間。単位:秒。 |
3600 |
| BackoffLimit |
integer |
失敗したジョブの最大リトライ回数。 |
3 |
| Slice |
boolean |
ジョブシャーディングを有効にするかどうかを指定します。 |
true |
| SliceEnvs |
string |
ジョブシャーディングのパラメーター。 |
SliceEnvs |
| RefAppId |
string |
参照されるジョブテンプレートの ID。 |
7171a6ca-d1cd-4928-8642-7d5cfe69**** |
| RefedAppIds |
array |
このテンプレートを参照するジョブテンプレートの ID。 |
|
|
string |
ジョブテンプレート ID。 |
8621a6ca-d1cd-4928-8642-7d5cfe69**** |
|
| PublicWebHookUrls |
array |
ワンタイムタスクのパブリックリクエスト URL のリスト。 |
|
|
string |
パブリック URL。 |
http://***/webhook/putEvents?token=*** |
|
| VpcWebHookUrls |
array |
ワンタイムタスクのプライベートリクエスト URL のリスト。 |
|
|
string |
プライベート URL。 |
http://***/webhook/putEvents?token=*** |
|
| ProgrammingLanguage |
string |
ジョブテンプレートに使用されるプログラミング言語。有効な値:
|
java |
| NasConfigs |
string |
Apsara File Storage NAS ファイルシステムをマウントするための設定。 |
[{"mountPath":"/test1","readOnly":false,"nasId":"nasId1","mountDomain":"nasId1.cn-shenzhen.nas.aliyuncs.com","nasPath":"/test1"},{"nasId":"nasId2","mountDomain":"nasId2.cn-shenzhen.nas.aliyuncs.com","readOnly":false,"nasPath":"/test2","mountPath":"/test2"}] |
| Python |
string |
Python 環境。PYTHON 3.9.15 がサポートされています。 |
PYTHON 3.9.15 |
| PythonModules |
string |
インストールする Python モジュールの依存関係。デフォルトでは、SAE はパッケージのルートディレクトリにある |
Flask==2.0 |
| BestEffortType |
string |
Best-Effort ポリシー。 |
|
| ErrorCode |
string |
エラーコード。
|
|
| Code |
string |
HTTP ステータスコードまたは POP エラーコード。有効な値:
|
200 |
| Success |
boolean |
リクエストが成功したかどうかを示します。有効な値:
|
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "01CF26C7-00A3-4AA6-BA76-7E95F2A3****",
"Message": "success",
"TraceId": "ac1a0b2215622246421415014e****",
"Data": {
"VpcId": "vpc-2ze0i263cnn311nvj****",
"ConfigMapMountDesc": [
{
"Key": "k1",
"ConfigMapName": "test",
"MountPath": "/tmp",
"ConfigMapId": 1
}
],
"SecurityGroupId": "sg-wz969ngg2e49q5i4****",
"Jdk": "Open JDK 8",
"ImageUrl": "docker.io/library/nginx:1.14.2",
"SlsConfigs": "[{\"logDir\":\"\",\"logType\":\"stdout\"},{\"logDir\":\"/tmp/a.log\"}]",
"Tags": [
{
"Key": "k1",
"Value": "v1"
}
],
"PackageUrl": "https://edas-bj.oss-cn-beijing.aliyuncs.com/apps/K8s_APP_ID/d4c97c37-aba3-403e-ae1e-6f7d8742****/hello-sae.war",
"PackageType": "War",
"PreStop": "{\"exec\":{\"command\":[\"cat\",\"/etc/group\"]}}",
"PackageVersion": "1.0",
"JarStartArgs": "start",
"AppName": "demo-app",
"AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
"JarStartOptions": "-Dtest=true",
"Replicas": 2,
"Memory": 2048,
"PhpConfig": "k1=v1",
"PhpConfigLocation": "/usr/local/etc/php/php.ini",
"PostStart": "{\"exec\":{\"command\":[\"cat\",\"/etc/group\"]}}",
"TerminationGracePeriodSeconds": 10,
"CommandArgs": "[\"a\",\"b\"]",
"NamespaceId": "cn-beijing:test",
"MountHost": "example.com",
"TomcatConfig": "{\"port\":8080,\"contextPath\":\"/\",\"maxThreads\":400,\"uriEncoding\":\"ISO-8859-1\",\"useBodyEncodingForUri\":true}",
"RegionId": "cn-beijing",
"VSwitchId": "vsw-2ze559r1z1bpwqxwp****",
"Cpu": 1000,
"Envs": "[{\"name\":\"TEST_ENV_KEY\",\"value\":\"TEST_ENV_VAR\"}]",
"MountDesc": [
{
"MountPath": "/tmp",
"NasPath": "/"
}
],
"CustomHostAlias": "[{\"hostName\":\"test.host.name\",\"ip\":\"0.0.0.0\"}]",
"WebContainer": "apache-tomcat-7.0.91",
"Command": "echo",
"WarStartOptions": "custom-option",
"NasId": "AKSN89**",
"OssAkId": "xxxxxx",
"OssAkSecret": "xxxxxx",
"OssMountDescs": [
{
"bucketName": "oss-bucket",
"bucketPath": "data/user.data",
"mountPath": "/usr/data/user.data",
"readOnly": true
}
],
"EdasContainerVersion": "3.5.3",
"Timezone": "Asia/Shanghai",
"AppDescription": "Sample application",
"AcrInstanceId": "cri-xxxxxx",
"AcrAssumeRoleArn": "acs:ram::123456789012****:role/adminrole",
"ImagePullSecrets": "10",
"TriggerConfig": "{\"type\":\"time\",\"config\":\"0 1 */1 * ?\",\"timezone\":\"GMT+8:00\"}",
"ConcurrencyPolicy": "Allow",
"Suspend": false,
"Timeout": 3600,
"BackoffLimit": 3,
"Slice": true,
"SliceEnvs": "SliceEnvs",
"RefAppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
"RefedAppIds": [
"8621a6ca-d1cd-4928-8642-7d5cfe69****"
],
"PublicWebHookUrls": [
"http://***/webhook/putEvents?token=***"
],
"VpcWebHookUrls": [
"http://***/webhook/putEvents?token=***"
],
"ProgrammingLanguage": "java",
"NasConfigs": "[{\"mountPath\":\"/test1\",\"readOnly\":false,\"nasId\":\"nasId1\",\"mountDomain\":\"nasId1.cn-shenzhen.nas.aliyuncs.com\",\"nasPath\":\"/test1\"},{\"nasId\":\"nasId2\",\"mountDomain\":\"nasId2.cn-shenzhen.nas.aliyuncs.com\",\"readOnly\":false,\"nasPath\":\"/test2\",\"mountPath\":\"/test2\"}]",
"Python": "PYTHON 3.9.15",
"PythonModules": "Flask==2.0",
"BestEffortType": ""
},
"ErrorCode": "",
"Code": "200",
"Success": true
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 404 | InvalidAppId.NotFound | The specified AppId does not exist. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。