UpdateJob API を呼び出してジョブテンプレートを更新します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sae:UpdateJob |
update |
*All Resource
|
なし | なし |
リクエスト構文
POST /pop/v1/sam/job/updateJob HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AppId |
string |
必須 |
更新するジョブテンプレートの ID。 |
7171a6ca-d1cd-4928-8642-7d5cfe69**** |
| Jdk |
string |
任意 |
デプロイメントパッケージが依存する Java 開発キット (JDK) のバージョン。次のバージョンがサポートされています:
このパラメーターは、パッケージタイプが Image に設定されている場合はサポートされません。 |
Open JDK 8 |
| WebContainer |
string |
任意 |
デプロイメントパッケージが依存する Tomcat のバージョン。次のバージョンがサポートされています:
このパラメーターは、パッケージタイプが Image に設定されている場合はサポートされません。 |
apache-tomcat-7.0.91 |
| PackageVersion |
string |
任意 |
デプロイメントパッケージのバージョン。このパラメーターは、パッケージタイプが FatJar、War、または PythonZip に設定されている場合に必要です。 |
1.0.1 |
| PackageUrl |
string |
任意 |
デプロイメントパッケージの URL。このパラメーターは、パッケージタイプが FatJar、War、または PythonZip に設定されている場合に必要です。 |
http://myoss.oss-cn-hangzhou.aliyuncs.com/my-buc/2019-06-30/****.jar |
| ImageUrl |
string |
任意 |
イメージの URL。このパラメーターは、パッケージタイプが Image に設定されている場合に必要です。 |
registry.cn-hangzhou.aliyuncs.com/sae_test/ali_sae_test:0.0.1 |
| Command |
string |
任意 |
イメージの起動コマンド。コマンドは、コンテナ内に存在する実行可能なオブジェクトである必要があります。例:
この例では、Command="echo" および |
echo |
| CommandArgs |
string |
任意 |
イメージの起動 Command の引数。値は、文字列に変換された JSON 配列である必要があります。フォーマット:
上記の例では、 |
["a","b"] |
| Envs |
string |
任意 |
コンテナの環境変数。環境変数をカスタマイズしたり、ConfigMap から変数を参照したりできます。ConfigMap を参照するには、まず ConfigMap インスタンスを作成する必要があります。詳細については、「CreateConfigMap」をご参照ください。値は JSON 文字列です。次のフィールドがサポートされています:
|
[{"name":"envtmp","value":"0"}] |
| CustomHostAlias |
string |
任意 |
コンテナ内のホスト名と IP アドレス間のカスタムマッピング。値は JSON 文字列です。次のフィールドがサポートされています:
|
[{"hostName":"samplehost","ip":"127.0.0.1"}] |
| JarStartOptions |
string |
任意 |
アプリケーションを起動するための JAR パッケージのオプション。アプリケーションのデフォルトの起動コマンドは次のとおりです: |
custom-option |
| JarStartArgs |
string |
任意 |
アプリケーションを起動するための JAR パッケージの引数。アプリケーションのデフォルトの起動コマンドは次のとおりです: |
-Xms4G -Xmx4G |
| EdasContainerVersion |
string |
任意 |
High-speed Service Framework (HSF) のアプリケーション実行環境のバージョン (Ali-Tomcat コンテナなど)。 |
3.5.3 |
| SlsConfigs |
string |
任意 |
Log Service へのログ収集の設定。
次のフィールドがサポートされています:
デプロイメント中に SLS 設定が変更されない場合は、このパラメーターを設定する必要はありません。ログ収集機能の使用を停止するには、このパラメーターの値を空の文字列 ( 説明
ジョブテンプレートで自動的に作成されたプロジェクトは、ジョブテンプレートが削除されると削除されます。したがって、既存のプロジェクトを選択するときは、SAE によって自動的に作成されたプロジェクトを選択しないでください。 |
[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}] |
| Timezone |
string |
任意 |
タイムゾーン。デフォルト値:Asia/Shanghai。 |
Asia/Shanghai |
| NasId |
string |
任意 |
Apsara File Storage NAS ファイルシステムの ID。デプロイメント中に設定が変更されない場合は、このパラメーターを設定する必要はありません。NAS 設定をクリアするには、このパラメーターの値を空の文字列 ( |
10d3b4**** |
| MountHost |
string |
任意 |
ジョブテンプレートが配置されている VPC 内の NAS ファイルシステムのマウントポイント。デプロイメント中に設定が変更されない場合は、このパラメーターを設定する必要はありません。NAS 設定をクリアするには、このパラメーターの値を空の文字列 ( |
10d3b4bc9****.com |
| MountDesc |
string |
任意 |
NAS マウントの説明。デプロイメント中に設定が変更されない場合は、このパラメーターを設定する必要はありません。NAS 設定をクリアするには、リクエストでこのパラメーターの値を空の文字列 ( |
[{mountPath: "/tmp", nasPath: "/"}] |
| PostStart |
string |
任意 |
コンテナの起動後に実行されるスクリプト。例: |
{"exec":{"command":["sh","-c","echo hello"]}} |
| PreStop |
string |
任意 |
コンテナの停止前に実行されるスクリプト。例: |
{"exec":{"command":["sh","-c","echo hello"]}} |
| WarStartOptions |
string |
任意 |
WAR パッケージでデプロイされたアプリケーションの起動コマンド。手順は、イメージの起動コマンドを設定する手順と同じです。詳細については、「起動コマンドの設定」をご参照ください。 |
CATALINA_OPTS=\"$CATALINA_OPTS $Options\" catalina.sh run |
| ConfigMapMountDesc |
string |
任意 |
コンテナにマウントされる ConfigMap インスタンスの説明。名前空間設定ページで作成した ConfigMap インスタンスを使用して、コンテナに設定を挿入できます。値は JSON 文字列です。次のフィールドがサポートされています:
説明
|
[{"configMapId":16,"key":"test","mountPath":"/tmp"}] |
| TerminationGracePeriodSeconds |
integer |
任意 |
グレースフルタイムアウト期間。デフォルト値:30。単位:秒。有効な値:1~300。 |
10 |
| PhpConfigLocation |
string |
任意 |
PHP アプリケーションの起動設定ファイルがマウントされるパス。PHP サーバーがこの設定ファイルを使用してアプリケーションを起動することを確認してください。 |
/usr/local/etc/php/php.ini |
| PhpConfig |
string |
任意 |
PHP 設定ファイルの内容。 |
k1=v1 |
| TomcatConfig |
string |
任意 |
Tomcat ファイルの設定。このパラメーターを "" または "{}" に設定すると、設定は削除されます。値は JSON 文字列です。次のフィールドがサポートされています:
|
{"port":8080,"contextPath":"/","maxThreads":400,"uriEncoding":"ISO-8859-1","useBodyEncodingForUri":true} |
| OssMountDescs |
string |
任意 |
OSS マウントの説明。値は JSON 文字列です。次のパラメーターがサポートされています:
|
[{"bucketName": "oss-bucket", "bucketPath": "data/user.data", "mountPath": "/usr/data/user.data", "readOnly": true}] |
| OssAkId |
string |
任意 |
OSS からのデータの読み取りおよび OSS へのデータの書き込みに使用される AccessKey ID。 |
xxxxxx |
| OssAkSecret |
string |
任意 |
OSS からのデータの読み取りおよび OSS へのデータの書き込みに使用される AccessKey Secret。 |
xxxxxx |
| Php |
string |
任意 |
Container Registry Enterprise Edition インスタンスの ID。 |
cri-xxxxxx |
| AcrInstanceId |
string |
任意 |
Container Registry Enterprise Edition インスタンスの ID。ImageUrl が Container Registry Enterprise Edition インスタンス内のイメージに設定されている場合、このパラメーターは必須です。 |
cri-xxxxxx |
| AcrAssumeRoleArn |
string |
任意 |
アカウント間でイメージをプルするために必要な RAM ロールの Alibaba Cloud リソース名 (ARN)。詳細については、「RAM ロールを使用した Alibaba Cloud アカウント間の権限付与」をご参照ください。 |
acs:ram::123456789012****:role/adminrole |
| ImagePullSecrets |
string |
任意 |
シークレットの ID。 |
10 |
| EnableImageAccl |
boolean |
任意 |
イメージアクセラレーションを有効にするかどうかを指定します。 |
|
| 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] |
| Replicas |
string |
任意 |
ジョブの同時インスタンス数。 |
3 |
| 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 |
任意 |
カスタムモジュールの依存関係。デフォルトでは、パッケージのルートディレクトリにある requirements.txt ファイルで定義されている依存関係がインストールされます。このパラメーターを設定しない場合、またはパッケージに 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。 |
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 ステータスコード。
|
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 | InvalidApplication.NotFound | The current application does not exist. | |
| 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 | 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 | InvalidParameter.WithMessage | The parameter is invalid {%s}: %s | |
| 400 | JarApplication.MissingJdk | A FatJar application must contain JDK. | |
| 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 | WarApplication.MissingJdkWebcontainer | A War application must contain JDK and Tomcat. | |
| 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 | 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 | Application.ChangerOrderRunning | An application change process is in progress. Please try again later. | 日文说明1 |
| 400 | Application.InvalidStatus | The application status is abnormal. Please try again later. | 日文说明1 |
| 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 | Package.Version.Too.Long | The maximum length of package version is exceeded. | |
| 400 | App.Package.Version.Exists | The package version of application already exists. | |
| 400 | Slb.Occupied | The SLB instance is occupied. | |
| 400 | Slb.Tag.Not.Qualified | The current SLB instance cannot be reused because it may have been occupied by %s. | |
| 400 | MinReadyInstances.Not.Smaller.Replicas | The minimum number of available instances must be less than the number of application instances. | |
| 400 | BatchWaitTime.Not.Smaller.Zero | BatchWaitTime must not be smaller than zero. | |
| 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 | Sae.Errorcode.Ahas.Create.Error.Message | Failed to create AHAS. | |
| 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 | InvalidNamespaceId.NotFound | The specified NamespaceId does not exist. | |
| 404 | InvalidAcrInstanceId.NotFound | The specified AcrInstanceId does not exist. | |
| 404 | Associate.Eip.Not.Enough | No sufficient EIPs are available. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。