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

Serverless App Engine:UpdateJob

最終更新日:Apr 23, 2026

UpdateJob API を呼び出してジョブテンプレートを更新します。

今すぐお試しください

この 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: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) のバージョン。次のバージョンがサポートされています:

  • Open JDK 8

  • Open JDK 7

  • Dragonwell 11

  • Dragonwell 8

  • openjdk-8u191-jdk-alpine3.9

  • openjdk-7u201-jdk-alpine3.9

このパラメーターは、パッケージタイプImage に設定されている場合はサポートされません。

Open JDK 8

WebContainer

string

任意

デプロイメントパッケージが依存する Tomcat のバージョン。次のバージョンがサポートされています:

  • apache-tomcat-7.0.91

  • apache-tomcat-8.5.42

このパラメーターは、パッケージタイプImage に設定されている場合はサポートされません。

apache-tomcat-7.0.91

PackageVersion

string

任意

デプロイメントパッケージのバージョン。このパラメーターは、パッケージタイプFatJarWar、または PythonZip に設定されている場合に必要です。

1.0.1

PackageUrl

string

任意

デプロイメントパッケージの URL。このパラメーターは、パッケージタイプFatJarWar、または 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
      - abc
      - >
      - file0

この例では、Command="echo" および CommandArgs=["abc", ">", "file0"] です。

echo

CommandArgs

string

任意

イメージの起動 Command の引数。値は、文字列に変換された JSON 配列である必要があります。フォーマット:

["a","b"]

上記の例では、CommandArgs=["abc", ">", "file0"] です。["abc", ">", "file0"] 配列は文字列に変換されます。このパラメーターはオプションです。

["a","b"]

Envs

string

任意

コンテナの環境変数。環境変数をカスタマイズしたり、ConfigMap から変数を参照したりできます。ConfigMap を参照するには、まず ConfigMap インスタンスを作成する必要があります。詳細については、「CreateConfigMap」をご参照ください。値は JSON 文字列です。次のフィールドがサポートされています:

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

    • value:環境変数の値。

  • ConfigMap からの参照変数
    • name:環境変数の名前。単一のキーと値のペアまたはすべてのキーと値のペアを参照できます。すべてのキーと値のペアを参照するには、値を sae-sys-configmap-all-<ConfigMap 名> に設定します。例:sae-sys-configmap-all-test1

    • valueFrom:環境変数の参照。値を configMapRef に設定します。

    • configMapId:ConfigMap の ID。

    • key:キーと値のペアのキー。すべてのキーと値のペアを参照する場合は、このフィールドを設定しないでください。

[{"name":"envtmp","value":"0"}]

CustomHostAlias

string

任意

コンテナ内のホスト名と IP アドレス間のカスタムマッピング。値は JSON 文字列です。次のフィールドがサポートされています:

  • hostName:ドメイン名またはホスト名。

  • ip:IP アドレス。

[{"hostName":"samplehost","ip":"127.0.0.1"}]

JarStartOptions

string

任意

アプリケーションを起動するための JAR パッケージのオプション。アプリケーションのデフォルトの起動コマンドは次のとおりです:$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

custom-option

JarStartArgs

string

任意

アプリケーションを起動するための JAR パッケージの引数。アプリケーションのデフォルトの起動コマンドは次のとおりです:$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

-Xms4G -Xmx4G

EdasContainerVersion

string

任意

High-speed Service Framework (HSF) のアプリケーション実行環境のバージョン (Ali-Tomcat コンテナなど)。

3.5.3

SlsConfigs

string

任意

Log Service へのログ収集の設定。

  • SAE によって自動的に作成される Log Service リソースを使用する:[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]

  • カスタム Log Service リソースを使用する:[{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}]

次のフィールドがサポートされています:

  • projectName:Log Service プロジェクトの名前。

  • logDir:ログパス。

  • logType:ログタイプ。stdout はコンテナの標準出力を示します。標準出力は 1 つだけ指定できます。このフィールドを設定しない場合、ファイルログが収集されます。

  • logstoreName:Log Service の Logstore の名前。

  • logtailName:Logtail の名前。このパラメーターを指定しない場合、新しい Logtail が作成されます。

デプロイメント中に 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"]}}

{"exec":{"command":["sh","-c","echo hello"]}}

PreStop

string

任意

コンテナの停止前に実行されるスクリプト。例:{"exec":{"command":["sh","-c","echo hello"]}}

{"exec":{"command":["sh","-c","echo hello"]}}

WarStartOptions

string

任意

WAR パッケージでデプロイされたアプリケーションの起動コマンド。手順は、イメージの起動コマンドを設定する手順と同じです。詳細については、「起動コマンドの設定」をご参照ください。

CATALINA_OPTS=\"$CATALINA_OPTS $Options\" catalina.sh run

ConfigMapMountDesc

string

任意

コンテナにマウントされる ConfigMap インスタンスの説明。名前空間設定ページで作成した ConfigMap インスタンスを使用して、コンテナに設定を挿入できます。値は JSON 文字列です。次のフィールドがサポートされています:

  • configMapId:ConfigMap インスタンスの ID。ListNamespacedConfigMaps 操作を呼び出して ID を取得できます。

  • key:キーと値のペアのキー。

説明

sae-sys-configmap-all パラメーターを渡して、すべてのキーと値のペアをマウントできます。

  • mountPath:マウントパス。

[{"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:ポート番号。有効な値:1024~65535。1024 未満のポートで操作を実行するには、root 権限が必要です。コンテナは管理者権限で設定されているため、1024 より大きいポート番号を指定してください。このフィールドを設定しない場合、デフォルトのポート 8080 が使用されます。

  • contextPath:コンテキストパス。デフォルト値:/。

  • maxThreads:接続プール内の最大接続数。デフォルト値:400。

  • uriEncoding:Tomcat の URI エンコーディングスキーム。サポートされている値:UTF-8ISO-8859-1GBKGB2312。このパラメーターを設定しない場合、デフォルト値の ISO-8859-1 が使用されます。

  • useBodyEncodingForUriBodyEncoding for URL を使用するかどうかを指定します。デフォルト値:true

{"port":8080,"contextPath":"/","maxThreads":400,"uriEncoding":"ISO-8859-1","useBodyEncodingForUri":true}

OssMountDescs

string

任意

OSS マウントの説明。値は JSON 文字列です。次のパラメーターがサポートされています:

  • bucketName:バケットの名前。

  • bucketPath:OSS で作成したディレクトリまたはオブジェクト。指定した OSS マウントディレクトリが存在しない場合、例外が発生します。

  • mountPath:SAE コンテナ内のパス。パスが存在する場合、新しいパスが既存のパスを上書きします。パスが存在しない場合、新しいパスが作成されます。

  • readOnly:コンテナがマウントディレクトリ内のリソースに対して読み取り専用権限を持つかどうかを指定します。
    • true:コンテナは読み取り専用権限を持ちます。

    • false:コンテナは読み取り/書き込み権限を持ちます。

[{"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

任意

トリガー設定。ジョブタイプに基づいてこのパラメーターを設定します。

  • Cron ジョブtype フィールドを time に、config フィールドを cron 式に、timezone フィールドを目的のタイムゾーンに設定します。 例:{"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"}

  • 1 回限りのジョブtype フィールドを http に設定し、config フィールドに特定の HTTP トリガールールを設定します。詳細については、「SourceHttpEventParameters」をご参照ください。 例:{"type":"http","config":{"type":"HTTPS","method":["GET"],"ip":[],"referer":[],"securityConfig":"none"}}

{"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"}

ConcurrencyPolicy

string

任意

同時ジョブの実行ポリシー。有効な値:

  • Forbid:前のジョブが完了していない場合、新しいジョブは作成されません。

  • Allow:同時ジョブが許可されます。

  • Replace:新しいジョブを作成する時間に達したときに、前のジョブが完了していない場合、新しいジョブが前のジョブを置き換えます。

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

任意

プログラミング言語。サポートされている値:javaphppythonshell

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

  • リクエストが失敗した場合はエラーコード。

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 ステータスコード。

  • 2xx:リクエストは成功です。

  • 3xx:リクエストはリダイレクトされます。

  • 4xx:リクエストは無効です。

  • 5xx:サーバーエラーが発生しました。

200

Success

boolean

ジョブテンプレートが更新されたかどうかを示します。有効な値:

  • true

  • false

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.

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

変更履歴

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