この操作はジョブテンプレートを作成します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sae:CreateJob |
create |
*All Resource
|
なし | なし |
リクエスト構文
POST /pop/v1/sam/job/createJob HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AppName |
string |
必須 |
ジョブテンプレートの名前。 半角英数字とハイフン (-) を使用できます。 先頭は半角英字である必要があり、長さは 36 文字以内にする必要があります。 |
test |
| NamespaceId |
string |
任意 |
SAE 名前空間の ID。 名前空間名は小文字とハイフン (-) のみを含めることができ、先頭は文字である必要があります。 |
cn-beijing:test |
| AppDescription |
string |
任意 |
ジョブテンプレートの説明。 1,024 文字を超えることはできません。 |
This is a test description. |
| VpcId |
string |
任意 |
SAE 名前空間の VPC ID。 SAE では、名前空間は 1 つの VPC にのみバインドでき、このバインドは変更できません。 バインドは、名前空間に最初の SAE ジョブテンプレートを作成するときに確立されます。 1 つの VPC は複数の名前空間に関連付けることができます。 このパラメーターを指定しない場合、デフォルトで名前空間にバインドされている VPC の ID が使用されます。 |
vpc-bp1aevy8sofi8mh1q**** |
| VSwitchId |
string |
任意 |
タスクインスタンスの Elastic Network Interface (ENI) の vSwitch ID。 vSwitch は指定された VPC 内に配置する必要があります。 vSwitch は SAE 名前空間にもバインドされます。 このパラメーターを指定しない場合、デフォルトで名前空間にバインドされている vSwitch の ID が使用されます。 |
vsw-bp12mw1f8k3jgygk9**** |
| PackageType |
string |
必須 |
デプロイメントパッケージのタイプ。 有効な値:
|
FatJar |
| PackageVersion |
string |
任意 |
デプロイメントパッケージのバージョン。 このパラメーターは、PackageType が FatJar、War、または PythonZip に設定されている場合に必要です。 |
1.0.1 |
| PackageUrl |
string |
任意 |
デプロイメントパッケージの URL。 このパラメーターは、PackageType が FatJar、War、または PythonZip に設定されている場合に必要です。 |
http://myoss.oss-cn-hangzhou.aliyuncs.com/my-buc/2019-06-30/****.jar |
| ImageUrl |
string |
任意 |
イメージの URL。 このパラメーターは、PackageType が Image に設定されている場合に必要です。 |
registry.cn-hangzhou.aliyuncs.com/sae_test/ali_sae_test:0.0.1 |
| Jdk |
string |
任意 |
デプロイメントパッケージに必要な JDK のバージョン。 次のバージョンがサポートされています:
このパラメーターは、PackageType が Image に設定されている場合はサポートされません。 |
Open JDK 8 |
| WebContainer |
string |
任意 |
デプロイメントパッケージに必要な Tomcat のバージョン。 次のバージョンがサポートされています:
このパラメーターは、PackageType が Image に設定されている場合はサポートされません。 |
apache-tomcat-7.0.91 |
| Cpu |
integer |
任意 |
各インスタンスに必要な CPU (ミリコア単位)。 この値を 0 にすることはできません。 現在、次の固定仕様のみがサポートされています:
|
1000 |
| Memory |
integer |
任意 |
各インスタンスに必要なメモリ (MB 単位)。 この値を 0 にすることはできません。 CPU とメモリの仕様は連動しています。 現在、次の仕様がサポートされています:
|
1024 |
| Replicas |
integer |
必須 |
同時タスクインスタンスの数。 |
3 |
| Command |
string |
任意 |
コンテナのエントリポイントコマンド。 コマンドはコンテナ内の実行可能ファイルである必要があります。 例:
上記の例では、 |
echo |
| CommandArgs |
string |
任意 |
エントリポイントコマンド (Command) の引数。 形式は次のとおりです:
|
["a","b"] |
| Envs |
string |
任意 |
コンテナに設定する環境変数。 変数を参照するには、ConfigMap がすでに存在している必要があります。 詳細については、「CreateConfigMap」をご参照ください。 値は、次のいずれかの方法で設定できます:
|
[{"name":"envtmp","value":"0"}] |
| CustomHostAlias |
string |
任意 |
コンテナ内でホスト名を IP アドレスにマッピングするホストエイリアス。 パラメーターは次のとおりです:
|
[{"hostName":"samplehost","ip":"127.0.0.1"}] |
| JarStartOptions |
string |
任意 |
JAR パッケージの起動オプション。 デフォルトの起動コマンドは次のとおりです: |
custom-option |
| JarStartArgs |
string |
任意 |
JAR パッケージの起動引数。 デフォルトの起動コマンドは次のとおりです: |
-Xms4G -Xmx4G |
| EdasContainerVersion |
string |
任意 |
タスクの HSF 実行環境のバージョン (Ali-Tomcat コンテナなど)。 |
3.5.3 |
| Timezone |
string |
任意 |
タイムゾーン。 デフォルト値:Asia/Shanghai。 |
Asia/Shanghai |
| SlsConfigs |
string |
任意 |
Simple Log Service (SLS) にログを収集するための設定。
パラメーターは次のとおりです:
後続のデプロイメントでログ収集設定が変更されない場合は、このパラメーターを設定する必要はありません (リクエストに SlsConfigs フィールドを含める必要はありません)。 ログ収集機能を使用する必要がなくなった場合は、リクエストでこのパラメーターの値を空の文字列 ("") に設定します。 説明
SAE は、対応するジョブテンプレートを削除すると、自動的に作成したプロジェクトを削除します。 したがって、既存のプロジェクトを指定する場合は、SAE によって自動的に作成されたプロジェクトを使用しないでください。 |
[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}] |
| NasId |
string |
任意 |
NAS ファイルシステムの ID。 この設定が後続のデプロイメントで変更されない場合は、このパラメーターを省略できます。 NAS 設定をクリアするには、このパラメーターを空の文字列 ("") に設定します。 |
10d3b4**** |
| MountHost |
string |
任意 |
ジョブテンプレートの VPC 内の NAS マウントポイント。 この設定が後続のデプロイメントで変更されない場合は、このパラメーターを省略できます。 NAS 設定をクリアするには、このパラメーターを空の文字列 ("") に設定します。 |
10d3b4bc9****.com |
| MountDesc |
string |
任意 |
NAS マウントの説明。 この設定が後続のデプロイメントで変更されない場合は、このパラメーターを省略できます。 NAS 設定をクリアするには、このパラメーターを空の文字列 ("") に設定します。 |
[{mountPath: "/tmp", nasPath: "/"}] |
| PreStop |
string |
任意 |
PreStop フック。 このスクリプトは、コンテナが停止する直前に実行されます。 値は JSON 文字列である必要があります。例: |
{"exec":{"command":["sh","-c","echo hello"]}} |
| PostStart |
string |
任意 |
PostStart フック。 このスクリプトは、コンテナが作成された直後に実行されます。 値は JSON 文字列である必要があります。例: |
{"exec":{"command":["sh","-c","echo hello"]}} |
| WarStartOptions |
string |
任意 |
WAR パッケージデプロイメントの起動コマンド。 設定手順は、イメージベースのデプロイメントと同じです。 詳細については、「起動コマンドの設定」をご参照ください。 |
CATALINA_OPTS=\"$CATALINA_OPTS $Options\" catalina.sh run |
| ConfigMapMountDesc |
string |
任意 |
ConfigMap マウントの説明。 名前空間で作成された ConfigMap を使用して、コンテナに設定を挿入します。 パラメーターは次のとおりです:
説明
|
[{"configMapId":16,"key":"test","mountPath":"/tmp"}] |
| SecurityGroupId |
string |
任意 |
セキュリティグループ ID。 |
sg-wz969ngg2e49q5i4**** |
| AutoConfig |
boolean |
任意 |
ネットワーク環境を自動的に設定するかどうかを指定します。 有効な値:
|
false |
| TerminationGracePeriodSeconds |
integer |
任意 |
グレースフルシャットダウンのタイムアウト (秒単位)。 値は 1 から 300 までの整数である必要があります。 デフォルト:30。 |
10 |
| PhpConfigLocation |
string |
任意 |
PHP タスクの起動設定ファイルのマウントパス。 PHP サーバーが起動時にこの設定ファイルを使用することを確認する必要があります。 |
/usr/local/etc/php/php.ini |
| PhpConfig |
string |
任意 |
PHP 設定ファイルの内容。 |
k1=v1 |
| TomcatConfig |
string |
任意 |
Tomcat の設定。 設定を削除するには、このパラメーターを
|
{"port":8080,"contextPath":"/","maxThreads":400,"uriEncoding":"ISO-8859-1","useBodyEncodingForUri":true} |
| OssMountDescs |
string |
任意 |
Object Storage Service (OSS) マウントの説明。 パラメーターは次のとおりです:
|
[{"bucketName": "oss-bucket", "bucketPath": "data/user.data", "mountPath": "/usr/data/user.data", "readOnly": true}] |
| OssAkId |
string |
任意 |
OSS への読み取りおよび書き込み用の AccessKey ID。 |
xxxxxx |
| OssAkSecret |
string |
任意 |
OSS への読み取りおよび書き込み用の AccessKey Secret。 |
xxxxxx |
| AcrInstanceId |
string |
任意 |
Container Registry (ACR) Enterprise Edition インスタンスの ID。 このパラメーターは、ImageUrl が ACR Enterprise Edition インスタンス内のイメージを指している場合に必要です。 |
cri-xxxxxx |
| AcrAssumeRoleArn |
string |
任意 |
アカウント間でイメージをプルするために必要な RAM ロールの Alibaba Cloud Resource Name (ARN)。 詳細については、「RAM ロールを使用して Alibaba Cloud アカウント間でイメージをプルする権限を付与する」をご参照ください。 |
acs:ram::123456789012****:role/adminrole |
| ImagePullSecrets |
string |
任意 |
イメージをプルするために使用されるシークレットの ID。 |
10 |
| EnableImageAccl |
boolean |
任意 |
イメージアクセラレーションを有効にするかどうかを指定します。 有効な値:
|
false |
| Workload |
string |
必須 |
ワークロード。 値を |
job |
| TriggerConfig |
string |
任意 |
タスクのトリガー設定。タスクの種類によって異なります。
|
{"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"} |
| ConcurrencyPolicy |
string |
任意 |
タスクの同時実行ポリシー。 有効な値:
|
Allow |
| Timeout |
integer |
任意 |
タスクのタイムアウト (秒単位)。 |
3600 |
| BackoffLimit |
integer |
任意 |
タスクが失敗とマークされるまでの最大再試行回数。 |
3 |
| Slice |
boolean |
任意 |
タスクシャーディングを有効にするかどうかを指定します。 |
true |
| SliceEnvs |
string |
任意 |
タスクシャーディングのパラメーター。 |
[0,1,2] |
| RefAppId |
string |
任意 |
参照されるジョブの ID。 |
7171a6ca-d1cd-4928-8642-7d5cfe69**** |
| ProgrammingLanguage |
string |
任意 |
プログラミング言語。 有効な値:java、php、python、shell。 |
java |
| Python |
string |
任意 |
Python 環境。 PYTHON 3.9.15 がサポートされています。 |
PYTHON 3.9.15 |
| PythonModules |
string |
任意 |
pip を使用してインストールする Python の依存関係。 このパラメーターを設定しない場合、SAE はプロジェクトのルートディレクトリにある 'requirements.txt' ファイルから依存関係をインストールします。 |
Flask==2.0 |
| NasConfigs |
string |
任意 |
NAS ファイルシステムをマウントするための設定。 |
|
| BestEffortType |
string |
任意 |
BestEffort ポリシー。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
作成されたジョブテンプレートの詳細。 |
||
| RequestId |
string |
リクエスト ID。 |
01CF26C7-00A3-4AA6-BA76-7E95F2A3*** |
| Message |
string |
追加情報。 有効な値:
|
success |
| TraceId |
string |
呼び出しのトレース ID。 この ID を使用して、呼び出しに関する詳細情報をクエリできます。 |
ac1a0b2215622246421415014e**** |
| Data |
object |
返されたデータ。 |
|
| ChangeOrderId |
string |
変更オーダー ID。 この ID を使用して、タスクの実行ステータスを確認できます。 |
01db03d3-3ee9-48b3-b3d0-dfce2d88**** |
| AppId |
string |
ジョブテンプレート ID。 |
7171a6ca-d1cd-4928-8642-7d5cfe69**** |
| ErrorCode |
string |
エラーコード。
|
|
| Code |
string |
HTTP ステータスコードまたは POP エラーコード。 有効な値:
|
200 |
| Success |
boolean |
ジョブテンプレートが正常に作成されたかどうかを示します。 有効な値:
|
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "01CF26C7-00A3-4AA6-BA76-7E95F2A3***",
"Message": "success",
"TraceId": "ac1a0b2215622246421415014e****",
"Data": {
"ChangeOrderId": "01db03d3-3ee9-48b3-b3d0-dfce2d88****",
"AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****"
},
"ErrorCode": "",
"Code": "200",
"Success": true
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Application.MissingJdk | Your application must at least contain a JDK component. | |
| 400 | InvalidPackageType.NotFound | The package type must be War, FatJar, or Image. | |
| 400 | InvalidParameter.FileName | The application deployment package name is invalid. This name can contain only alphanumeric characters, hyphens (-), and underscores (_). In addition, you can upload JAR files only if the selected deployment version supports JAR file. Otherwise, upload WAR files only. | |
| 400 | InvalidParameter.NotEmpty | You must specify the parameter %s. | |
| 400 | InvalidParameter.Obviously | The specified parameter is invalid {%s}. | |
| 400 | JarApplication.MissingJdk | A FatJar application must contain JDK. | |
| 400 | NoAvailableCluster.NotFound | No clusters are available for the current region. | |
| 400 | NoComputeResourceQuota.Exceed | Your compute resource is insufficient. Please contact us to raise the quota. | |
| 400 | PandoraApplication.MissingJdk | The Pandora application is missing a JDK component. | |
| 400 | PandoraApplication.OnlyJdk | A Pandora application only requires JDK component. | |
| 400 | InvalidParameter.WithMessage | The parameter is invalid {%s}: %s | |
| 400 | InvalidComponent.NotFound | The current component (such as JDK, Tomcat, or EDASWebContainer) does not exist. | |
| 400 | InvalidHostnameIp.Invalid | The hostname and/or IP is invalid: Hostname [%s], IP [%s]. | |
| 400 | InvalidInstanceSpecification.Unsupported | The instance specification is not supported: CPU [%s], memory [%s]. | |
| 400 | InvalidServerlessRegion.Unsupported | The current region is not supported: %s | |
| 400 | WarApplication.MissingJdkWebcontainer | A War application must contain JDK and Tomcat. | |
| 400 | InvalidNamespace.WithUppercase | This namespace does not support creating SAE apps because it contains uppercase letters. | |
| 400 | LogService.ConfigQuotaExceed | The maximum number of Log Service configs is exceeded. | |
| 400 | LogService.InternalError | An exception occurred while calling Log Service. Please submit a ticket to solve the problem. | |
| 400 | LogService.LogDirInvalid | The log collection path is invalid. | |
| 400 | LogService.NotAvailable | Log Service is unavailable. Please activate Log Service first. | |
| 400 | LogService.ProjectNumQuotaExceed | The maximum number of Log Service projects is exceeded. | |
| 400 | vswitch.not.exist | The specified VSwitch does not exist. | |
| 400 | user.indebt | The user has an outstanding payment. | |
| 400 | NoComputeResourceQuota.App.Exceed | You can create %s instances for each application. Please submit a ticket to raise the quota. | |
| 400 | NoComputeResourceQuota.User.Exceed | Your account is limited to create %s instances. Please submit a ticket to raise the quota. | |
| 400 | System.Upgrading | The system is being upgraded. Please try again later. | |
| 400 | VolumnPath.Conflict | Conflict between log collection directory and persistent storage directory. | |
| 400 | MountConflict.ConfigMap | Conflict detected for ConfigMap path %s. | |
| 400 | NotFound.ConfigMap | The ConfigMap object (ID: %s) does not exist. | |
| 400 | NotFound.ConfigMapKey | The key %s of ConfigMap object (ID: %s) does not exist. | |
| 400 | Sls.Config.Mixed.Multi.Project | The specified Config contains multiple projects. | |
| 400 | Sls.Config.User.Defined.Missing.Logstore.Info | The specified Config is invalid. Both Project and Logstore must be specified. | |
| 400 | Sls.Config.User.Defined.Missing.Project.Info | The specified Config is invalid. Both Project and Logstore must be specified. | |
| 400 | Sls.Logstore.Name.Invalid | The specified name of Logstore is invalid. The Logstore name must not contain the prefix "sae-". | |
| 400 | Sls.Logstore.User.Defined.Not.Exist | The user defined Logstore does not exist. | |
| 400 | Sls.Project.Name.Invalid | The specified project name is invalid. The project name must not contain the prefix "sae-". | |
| 400 | Sls.Project.User.Defined.Not.Exist | The user defined project does not exist. | |
| 400 | InvalidImageUrl.AcrInstanceId.Domain.NotMatch | The specified domain of ImageUrl does not match AcrInstanceId domains. | |
| 400 | PhpApplication.MissingPhpRuntime | A PHP application must contain PHP Runtime. | |
| 404 | Associate.Eip.Not.Enough | No sufficient EIPs are available. | |
| 404 | InvalidNamespaceId.NotFound | The specified NamespaceId does not exist. | |
| 404 | InvalidVpcId.NotFound | The specified VpcId does not exist. | |
| 404 | InvalidAcrInstanceId.NotFound | The specified AcrInstanceId does not exist. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。