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

Serverless App Engine:DeployApplication

最終更新日:Jul 10, 2026

アプリケーションをデプロイします。

今すぐお試しください

この 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:DeployApplication

update

*All Resource

*

なし なし

リクエスト構文

POST /pop/v1/sam/app/deployApplication HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

AppId

string

必須

デプロイするアプリケーションの ID。

7171a6ca-d1cd-4928-8642-7d5cfe69****

Jdk

string

任意

デプロイメントパッケージが依存する JDK バージョン。有効な値:

  • Open JDK 8

  • Open JDK 7

  • Dragonwell 11

  • Dragonwell 8

  • openjdk-8u191-jdk-alpine3.9

  • openjdk-7u201-jdk-alpine3.9

Package TypeImage に設定されている場合、このパラメーターはサポートされません。

Open JDK 8

WebContainer

string

任意

デプロイメントパッケージが依存する Tomcat バージョン。有効な値:

  • apache-tomcat-7.0.91

  • apache-tomcat-8.5.42

Package TypeImage に設定されている場合、このパラメーターはサポートされません。

apache-tomcat-7.0.91

PackageVersion

string

任意

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

1.0.1

PackageUrl

string

任意

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

http://myoss.oss-cn-hangzhou.aliyuncs.com/my-buc/2019-06-30/****.jar

ImageUrl

string

任意

イメージの URL。Package TypeImage に設定されている場合、このパラメーターは必須です。

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 で指定された起動コマンドに必須の引数です。フォーマット:

["a","b"]

上記の例では、CommandArgs=["abc", ">", "file0"] となり、["abc", ">", "file0"] は String 型に変換する必要があり、内部フォーマットは JSON 配列です。このパラメーターが不要な場合は、空のままにしてください。

["a","b"]

Envs

string

任意

コンテナ環境変数パラメーター。環境変数をカスタマイズするか、ConfigMap 項目を参照できます。ConfigMap 項目を参照するには、まず ConfigMap インスタンスを作成する必要があります。詳細については、 CreateConfigMap をご参照ください。有効な値:

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

    • value: 環境変数の値。valueFrom よりも優先されます。

  • ConfigMap 項目の参照 (valueFrom)
    • name: 環境変数の名前。すべてのキーを参照するには、sae-sys-configmap-all-test1 のように sae-sys-configmap-all-<ConfigMap name> と入力します。

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

    • configMapId: ConfigMap の ID。

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

  • シークレットの参照 (valueFrom)
    • name: 環境変数の名前。すべてのキーを参照するには、sae-sys-secret-all-test1 のように sae-sys-secret-all-<secret name> と入力します。

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

    • secretId: シークレットの ID。

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

[ { "name": "sae-sys-configmap-all-hello", "valueFrom": { "configMapRef": { "configMapId": 100, "key": "" } } }, { "name": "hello", "valueFrom": { "configMapRef": { "configMapId": 101, "key": "php-fpm" } } }, { "name": "sae-sys-secret-all-hello", "valueFrom": { “secretRef": { “secretId": 100, "key": "" } } }, { "name": “password”, "valueFrom": { “secretRef": { “secretId": 101, "key": “password” } } }, { "name": "envtmp", "value": "newenv" } ]

CustomHostAlias

string

任意

コンテナ内のカスタムホストマッピング。有効な値:

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

  • ip: IP アドレス。

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

JarStartOptions

string

任意

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

custom-option

JarStartArgs

string

任意

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

-Xms4G -Xmx4G

Liveness

string

任意

コンテナのヘルスチェック。ヘルスチェックに失敗したコンテナはシャットダウンされ、復旧されます。以下のメソッドがサポートされています:

  • exec: 例: {"exec":{"command":\["sh","-c","cat/home/admin/start.sh"]},"initialDelaySeconds":30,"periodSeconds":30,"timeoutSeconds":2}

  • httpGet: 例: {"httpGet":{"path":"/","port":18091,"scheme":"HTTP","isContainKeyWord":true,"keyWord":"SAE"},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}

  • tcpSocket: 例: {"tcpSocket":{"port":18091},"initialDelaySeconds":11,"periodSeconds":10,"timeoutSeconds":1}

説明

ヘルスチェックには 1 つのメソッドのみを選択できます。

設定項目:

  • exec.command: ヘルスチェックコマンドを設定します。

  • httpGet.path: アクセスパス。

  • httpGet.scheme: HTTP または HTTPS

  • httpGet.isContainKeyWord: true はキーワードが含まれることを示し、false はキーワードが含まれないことを示し、このフィールドがない場合は高度な特徴が使用されないことを示します。

  • httpGet.keyWord: カスタムキーワード。このパラメーターを使用する場合、isContainKeyWord フィールドが存在する必要があります。

  • tcpSocket.port: TCP 接続検出用のポート。

  • initialDelaySeconds: ヘルスチェックの初期遅延時間を設定します。デフォルト値: 10。単位: 秒。

  • periodSeconds: ヘルスチェックのエポックを設定します。デフォルト値: 30。単位: 秒。

  • timeoutSeconds: ヘルスチェックのタイムアウト期間を設定します。デフォルト値: 1。単位: 秒。このパラメーターが 0 に設定されているか、設定されていない場合、デフォルトのタイムアウト期間は 1 秒です。

{"exec":{"command":["sleep","5s"]},"initialDelaySeconds":10,"timeoutSeconds":11}

Readiness

string

任意

アプリケーションの起動ステータスチェック。複数のヘルスチェックに失敗したコンテナはシャットダウンされ、再起動されます。ヘルスチェックに合格しないコンテナは SLB トラフィックを受信しません。exechttpGet、および tcpSocket のメソッドがサポートされています。具体的な例については、Liveness パラメーターをご参照ください。

説明

ヘルスチェックには 1 つのメソッドのみを選択できます。

{"exec":{"command":["sleep","6s"]},"initialDelaySeconds":15,"timeoutSeconds":12}

MinReadyInstances

integer

任意

利用可能なインスタンスの最小値。有効な値:

  • このパラメーターが 0 に設定されている場合、スペックアップ中にサービス中断が発生します。

  • このパラメーターが -1 に設定されている場合、システム推奨値が使用されます。これは現在のインスタンス数の 25% です。現在のインスタンス数が 5 の場合、5 × 25% = 1.25 となり、切り上げられて 2 になります。

説明

サービス中断を防ぐため、各ローリングデプロイにおける利用可能なインスタンスの最小値は ≥ 1 である必要があります。

1

MinReadyInstanceRatio

integer

任意

利用可能なインスタンスの最小パーセンテージ。有効な値:

  • -1: 初期化値。パーセンテージが使用されないことを示します。

  • 0~100: 単位はパーセントで、切り上げられます。たとえば、このパラメーターが 50% に設定されており、現在のインスタンス数が 5 の場合、利用可能なインスタンスの最小値は 3 です。

説明

MinReadyInstanceMinReadyInstanceRatio の両方が指定されており、MinReadyInstanceRatio の値が -1 でない場合、MinReadyInstanceRatio パラメーターが優先されます。たとえば、MinReadyInstances5 に設定され、MinReadyInstanceRatio50 に設定されている場合、値 50 が利用可能なインスタンスの最小値の計算に使用されます。

-1

BatchWaitTime

integer

任意

デプロイメントバッチ間の間隔。単位: 秒。

10

EdasContainerVersion

string

任意

HSF フレームワークにおけるアプリケーションランタイム環境のバージョン (Ali-Tomcat コンテナなど)。

3.5.3

UpdateStrategy

string

任意

デプロイメントポリシー。利用可能なインスタンスの最小値が 1 の場合、UpdateStrategy フィールドの値は "" です。利用可能なインスタンスの最小値が 1 より大きい場合、例は以下の通りです:

  • グレースケール 1 インスタンス + 後続 2 バッチ + 自動バッチ処理 + 1 分のバッチ間隔: {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}

  • グレースケール 1 インスタンス + 後続 2 バッチ + 手動バッチ処理: {"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"manual"},"grayUpdate":{"gray":1}}

  • 2 バッチ + 自動バッチ処理 + 0 分のバッチ間隔: {"type":"BatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":0}}

設定項目:

  • type: リリースポリシータイプ。有効な値: GrayBatchUpdate (グレースケールリリース)、BatchUpdate (バッチリリース)。

  • batchUpdate: バッチリリースポリシー。

    • batch: リリースバッチ数。

    • releaseType: バッチ間の処理プロセス。有効な値: auto (自動)、manual (手動)。

    • batchWaitTime: バッチ間の間隔。単位: 分。

  • grayUpdate: グレースケールインスタンスの数。typeGrayBatchUpdate に設定されている場合、このパラメーターは必須です。

{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}}

SlsConfigs

string

任意

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

  • Serverless App Engine によって自動作成された SLS リソースを使用: [{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]

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

設定項目:

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

  • logDir: ログパス。

  • logType: ログタイプ。stdout はコンテナ標準出力ログを示し、1 つのエントリのみを設定できます。このパラメーターが設定されていない場合、ファイルログが収集されます。

  • logstoreName: Simple Log Service の Logstore 名。

  • logtailName: Simple Log Service の Logtail 名。このパラメーターが指定されていない場合、自動作成によって新しい Logtail が作成されます。

複数のデプロイメント中に SLS 収集設定が変更されていない場合、このパラメーターを設定する必要はありません (つまり、リクエストに SlsConfigs フィールドを含める必要はありません)。SLS コレクション機能が不要になった場合は、このフィールドの値を空の文字列に設定します (つまり、リクエストの SlsConfigs フィールドの値を "" に設定します)。

説明

アプリケーションとともに自動作成されたプロジェクトは、アプリケーションが削除されると削除されます。したがって、既存のプロジェクトを選択する際は、Serverless App Engine によって自動作成されたプロジェクトを選択しないでください。

[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]

Timezone

string

任意

タイムゾーン。デフォルト値: Asia/Shanghai

Asia/Shanghai

NasId

string

任意

このフィールドの構成は推奨されません。代わりに NasConfigs を構成してください。NAS ファイルシステムの ID。デプロイメント中に構成が変更されていない場合、このパラメーターを設定する必要はありません (つまり、リクエストに NasId フィールドを含める必要はありません)。NAS 構成をクリアするには、このフィールドの値を空の文字列に設定します (つまり、リクエストの NasId フィールドの値を "" に設定します)。

10d3b4****

MountHost

string

任意

このフィールドの構成は推奨されません。代わりに NasConfigs を構成してください。アプリケーションの VPC 内の NAS ファイルシステムのマウントポイント。デプロイメント中に構成が変更されていない場合、このパラメーターを設定する必要はありません (つまり、リクエストに MountHost フィールドを含める必要はありません)。NAS 構成をクリアするには、このフィールドの値を空の文字列に設定します (つまり、リクエストの MountHost フィールドの値を "" に設定します)。

10d3b4bc9****.com

MountDesc

string

任意

このフィールドの構成は推奨されません。代わりに NasConfigs を構成してください。NAS マウントの説明。デプロイメント中に構成が変更されていない場合、このパラメーターを設定する必要はありません (つまり、リクエストに MountDesc フィールドを含める必要はありません)。NAS 構成をクリアするには、このフィールドの値を空の文字列に設定します (つまり、リクエストの MountDesc フィールドの値を "" に設定します)。スクリプトとして記述することも可能です。

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

ChangeOrderDesc

string

任意

変更注文の説明。

Start application

WarStartOptions

string

任意

WAR パッケージベースのアプリケーションをデプロイするための起動コマンド。構成プロシージャは、イメージベースのデプロイ中の起動コマンドと同じです。詳細については、起動コマンドの設定 をご参照ください。フォーマットに従って指定してください。

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

AutoEnableApplicationScalingRule

boolean

任意

アプリケーションの弾力的スケーリングポリシーを自動的に有効にするかどうかを指定します。呼び出し時に適用されます。有効な値:

  • true: 有効。

  • false: 無効。

true

ConfigMapMountDesc

string

任意

ConfigMap のマウント説明。名前空間設定項目ページで作成された ConfigMap を使用して、構成情報をコンテナに注入します。フォーマットに従って指定してください。設定項目:

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

  • key: キー。

説明

sae-sys-configmap-all パラメーターを渡すことで、すべてのキーをマウントできます。スクリプトで指定することも可能です。

  • mountPath: マウントパス。

[{"configMapId":16,"key":"test","mountPath":"/tmp"}]

TerminationGracePeriodSeconds

integer

任意

グレースフルシャットダウンのタイムアウト期間。デフォルト値: 30。単位: 秒。有効な値: 1 ~ 300。

10

EnableAhas

string

任意

Application High Availability Service (AHAS) を有効にするかどうかを指定します。サービス連携機能です。有効な値:

  • true: AHAS を有効にします。

  • false: AHAS を有効にしません。

false

PhpArmsConfigLocation

string

任意

PHP アプリケーションモニタリングのマウントパス。PHP サーバーがこのパスから設定ファイルを読み込むようにしてください。Serverless App Engine が正しい設定ファイルを自動的にレンダリングするため、構成内容を管理する必要はありません。呼び出し時に参照されます。

/usr/local/etc/php/conf.d/arms.ini

PhpConfigLocation

string

任意

PHP アプリケーション起動構成のマウントパス。PHP サーバーが起動にこの設定ファイルを使用するようにしてください。

/usr/local/etc/php/php.ini

PhpConfig

string

任意

PHP 設定ファイルの内容。

k1=v1

TomcatConfig

string

任意

Tomcat 構成。構成を削除するには、このパラメーターを "" または "{}" に設定します。フォーマットに従って指定してください。有効な値:

  • port: ポート番号。有効な値: 1024 ~ 65535。1024 未満のポートには root 権限が必要です。コンテナは admin 権限で構成されているため、1024 より大きいポートを指定してください。デフォルト値: 8080。

  • contextPath: アクセスパス。デフォルト値: ルートディレクトリ "/"。読み取り専用です。

  • maxThreads: 接続プールサイズ。デフォルト値: 400。

  • uriEncoding: Tomcat のエンコード形式。有効な値: UTF-8ISO-8859-1GBKGB2312。デフォルト値: ISO-8859-1

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

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

OssMountDescs

string

任意

OSS マウント説明。パラメータ設定:

  • bucketName: バケット名。

  • bucketPath: OSS に作成したフォルダまたはオブジェクト。OSS マウントフォルダが存在しない場合、例外がトリガーされます。スクリプトでパスを指定することも可能です。

  • mountPath: Serverless App Engine のコンテナパス。パスが既に存在する場合は上書き関係になります。パスが存在しない場合は作成されます。セットとして扱われます。

  • readOnly: コンテナパスがマウントされたフォルダリソースに対して読み取り専用権限を持つかどうかを指定します。有効な値:
    • true: 読み取り専用権限。

    • false: 読み書き権限。

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

EnableGreyTagRoute

boolean

任意

トラフィックカナリアリリースルールを有効にするかどうかを指定します。このルールは Spring Cloud または Dubbo フレームワークを使用するアプリケーションにのみ適用されます。有効な値:

  • true: カナリアリリースルールを有効にします。

  • false: カナリアリリースルールを無効にします。

false

Php

string

任意

デプロイメントパッケージが依存する PHP バージョン。イメージではサポートされていません。

PHP-FPM 7.0

AcrInstanceId

string

任意

Container Registry エンタープライズインスタンス ID。ImageUrl が Container Registry エンタープライズインスタンスのイメージに設定されている場合、このパラメーターは必須です。

cri-xxxxxx

AcrAssumeRoleArn

string

任意

クロスアカウントイメージプルに必須の RAM ロールの Amazon リソースネーム (ARN)。フォーマットに従って指定してください。詳細については、RAM ロールを使用した Alibaba Cloud アカウント間の権限付与 をご参照ください。

acs:ram::123456789012****:role/adminrole

ImagePullSecrets

string

任意

対応するシークレット ID。

10

AssociateEip

boolean

任意

Elastic IP アドレス (EIP) を関連付けるかどうかを指定します。有効な値:

  • true: EIP を関連付けます。

  • false: EIP を関連付けません。

true

KafkaConfigs

string

任意

Kafka のログ収集設定のまとめ。有効な値:

  • kafkaEndpoint: Kafka API のエンドポイント。

  • kafkaInstanceId: Kafka インスタンス ID。

  • kafkaConfigs: 1 つ以上のログエントリの構成まとめ。Topic ごとに設定します。値の例とパラメーターの説明については、本トピックの kafkaConfigs リクエストパラメーターをご参照ください。スクリプトでコレクションを定義することも可能です。

{"kafkaEndpoint":"10.0.X.XXX:XXXX,10.0.X.XXX:XXXX,10.0.X.XXX:XXXX","kafkaInstanceId":"alikafka_pre-cn-7pp2l8kr****","kafkaConfigs":[{"logType":"file_log","logDir":"/tmp/a.log","kafkaTopic":"test2"},{"logType":"stdout","logDir":"","kafkaTopic":"test"}]}

PvtzDiscoverySvc

string

任意

K8s Service ベースのサービス登録と検出を有効にします。プロ版で利用可能です。有効な値:

  • portProtocols: ポートとプロトコル。有効なポート値: [1,65535]。有効なプロトコル値: TCP および UDP

  • portAndProtocol: ポートとプロトコル。有効なポート値: [1,65535]。有効なプロトコル値: TCP および UDPportProtocols が推奨されます。portProtocols が設定されている場合、portProtocols のみが効果があります

  • enable: K8s Service ベースのサービス登録と検出を有効にします。

{"portProtocols":[{"port":18012,"protocol":"TCP"}],"portAndProtocol":{"18012":"TCP"},"enable":true}

SwimlanePvtzDiscoverySvc

string

任意

エンドツーエンドのカナリアリリースを使用して、K8s Service ベースのサービス登録と検出を設定します:

  • enable: K8s Service ベースのエンドツーエンドカナリアリリースを有効にするかどうかを指定します。
    • true: 有効。

    • false: 無効。

  • namespaceId: 名前空間 ID。

  • portAndProtocol: リッスンポートとプロトコル。フォーマット: {"port:protocol type":"container port"}。

  • portProtocols: サービスポートとプロトコルを定義します。
    • port: ポート。

    • protocol: プロトコル。

    • targetPort: コンテナポート。

  • pvtzDiscoveryName: サービス検出名。

  • serviceId: サービス ID。

  • serviceName: サービス名。

{\"enable\":\"false\",\"namespaceId\":\"cn-beijing:test\",\"portAndProtocol\":{\"2000:TCP\":\"18081\"},\"portProtocols\":[{\"port\":2000,\"protocol\":\"TCP\",\"targetPort\":18081}],\"pvtzDiscoveryName\":\"cn-beijing-1421801774382676\",\"serviceId\":\"3513\",\"serviceName\":\"demo-gray.test\"}

MicroRegistration

string

任意

Nacos レジストリを指定します。有効な値:

  • 0: Serverless App Engine 組み込み Nacos。

  • 1: セルフマネージド Nacos。

  • 2: Microservices Engine (MSE) 商用版 Nacos。

説明

Serverless App Engine 組み込み Nacos を選択した場合、組み込み Nacos の構成を取得することはできません。

"0"

MicroRegistrationConfig

string

任意

レジストリ構成。レジストリタイプが MSE Nacos Enterprise エディションの場合にのみ効果があります。

{\"instanceId\":\"mse-cn-zvp2bh6h70r\",\"namespace\":\"4c0aa74f-57cb-423c-b6af-5d9f2d0e3dbd\"}

NasConfigs

string

任意

NAS マウント構成。フォーマットに従って指定してください。有効な値:

  • mountPath: コンテナマウントパス。

  • readOnly: 読み書き権限の場合は false に設定します。読み取り専用にする場合は true を指定します。

  • nasId: NAS ID。

  • mountDomain: コンテナマウントポイントアドレス。詳細については、 DescribeMountTargets をご参照ください。

  • nasPath: 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

任意

カスタムインストールモジュールの依存関係。デフォルトでは、Root フォルダ内の requirements.txt ファイルで定義された依存関係がインストールされます。依存関係が構成されていないか、カスタムパッケージが必要な場合は、インストールする依存関係を指定できます。

Flask==2.0

Dotnet

string

任意

.NET フレームワークのバージョン:

  • .NET 3.1

  • .NET 5.0

  • .NET 6.0

  • .NET 7.0

  • .NET 8.0

.NET 3.1

Deploy

string

任意

このパラメーターは停止状態のアプリケーションに対してのみ効果があります。実行中のアプリケーションに対して DeployApplication 操作を呼び出すと、アプリケーションは即座に再デプロイされます。

  • true: デフォルト値。即座にデプロイし、新しいデプロイメント構成を適用して、インスタンスを起動します。

  • false: 新しいデプロイメント構成のみを適用し、アプリケーションインスタンスを起動しません。

true

PackageType

string

任意

アプリケーションパッケージタイプ。有効な値:

  • Java でデプロイする場合、以下のタイプがサポートされています: FatJarWarImage

  • PHP でデプロイする場合、以下のタイプがサポートされています:
    • PhpZip

    • IMAGE_PHP_5_4

    • IMAGE_PHP_5_4_ALPINE

    • IMAGE_PHP_5_5

    • IMAGE_PHP_5_5_ALPINE

    • IMAGE_PHP_5_6

    • IMAGE_PHP_5_6_ALPINE

    • IMAGE_PHP_7_0

    • IMAGE_PHP_7_0_ALPINE

    • IMAGE_PHP_7_1

    • IMAGE_PHP_7_1_ALPINE

    • IMAGE_PHP_7_2

    • IMAGE_PHP_7_2_ALPINE

    • IMAGE_PHP_7_3

    • IMAGE_PHP_7_3_ALPINE

  • Python でデプロイする場合、以下のタイプがサポートされています: PythonZip および Image

FatJar

Cpu

integer

任意

各インスタンスに必須の CPU リソース。単位: ミリコア。このパラメーターを 0 に設定することはできません。以下の固定仕様のみがサポートされています:

  • 500

  • 1000

  • 2000

  • 4000

  • 8000

  • 12000

  • 16000

  • 32000

1000

Memory

integer

任意

各インスタンスに必須のメモリ。単位: MB。このパラメーターを 0 に設定することはできません。メモリは CPU と 1 対 1 でマッピングされます。以下の固定仕様のみがサポートされています:

  • 1024: CPU 500 および 1000 ミリコアに対応。

  • 2048: CPU 500、1000、および 2000 ミリコアに対応。

  • 4096: CPU 1000、2000、および 4000 ミリコアに対応。

  • 8192: CPU 2000、4000、および 8000 ミリコアに対応。

  • 12288: CPU 12000 ミリコアに対応。

  • 16384: CPU 4000、8000、および 16000 ミリコアに対応。

  • 24576: CPU 12000 ミリコアに対応。

  • 32768: CPU 16000 ミリコアに対応。

  • 65536: CPU 8000、16000、および 32000 ミリコアに対応。

  • 131072: CPU 32000 ミリコアに対応。

1024

Replicas

integer

任意

インスタンス数。

1

SecurityGroupId

string

任意

セキュリティグループ ID。

sg-wz969ngg2e49q5i4****

VSwitchId

string

任意

アプリケーションインスタンスのネットワークインターフェースが存在する vSwitch。vSwitch は指定された VPC 内にある必要があります。

vsw-bp12mw1f8k3jgygk9****

ServiceTags

string

任意

アプリケーションに設定されたカナリアリリースタグ。

{\"alicloud.service.tag\":\"g1\"}

EnableNewArms

boolean

任意

新しい ARMS 特徴を有効にするかどうかを指定します:

  • true: 有効。

  • false: 無効。

true

EnableCpuBurst

boolean

任意

CPU Burst 特徴を有効にするかどうかを指定します:

  • true: 有効。

  • false: 無効。

true

OidcRoleName

string

任意

身分認証用の RAM ロール。フォーマットに従って指定してください。

説明

事前に同じリージョンに OIDC ID プロバイダーと ID プロバイダーロールを作成してください。詳細については、OIDC ID プロバイダーの作成 および シングルサインオン (SSO) ID プロバイダー用ロールの作成 をご参照ください。

sae-test

SidecarContainersConfig

array

任意

サイドカーコンテナ構成。

SidecarContainerConfig

任意

サイドカーコンテナ構成。

SecretMountDesc

string

任意

Secret のマウント説明。名前空間シークレットページで作成されたシークレットを使用して、機密情報をコンテナに注入します。フォーマットに従って指定してください。設定項目:

  • secretId: シークレットインスタンス ID。ListSecrets 操作を呼び出すことで取得できます。

  • key: キー。

説明

sae-sys-secret-all パラメーターを渡すことで、すべてのキーをマウントできます。スクリプトで指定することも可能です。

  • mountPath: マウントパス。

[{“secretId":10,”key":"test","mountPath":"/tmp"}]

EnableSidecarResourceIsolated

boolean

任意

サイドカーのリソース分離を有効にするかどうかを指定します:

  • true: リソース分離を有効にします。

  • false: リソース分離を有効にしません。

true

CustomImageNetworkType

string

任意

カスタムイメージタイプ。イメージがカスタムイメージでない場合は、このパラメーターを空の文字列に設定します:

  • internet: パブリックイメージ。

  • intranet: 非公開イメージ。

internet

MicroserviceEngineConfig

string

任意

マイクロサービスガバナンスを構成します。

  • マイクロサービスガバナンスを有効にするかどうか (enable):

    • true: 有効。

    • false: 無効。

  • ロスレスオンライン/オフラインの構成 (mseLosslessRule):

    • delayTime: 遅延時間。

    • enable: ロスレスオンライン特徴を有効にするかどうかを指定します。true は有効、false は無効を示します。

    • notice: 通知特徴を有効にするかどうかを指定します。true は有効、false は無効を示します。

    • warmupTime: 低トラフィックシナリオ用のウォームアップ持続時間。単位: 秒。

{"enable": true,"mseLosslessRule": {"delayTime": 0,"enable": false,"notice": false,"warmupTime": 120}}

NewSaeVersion

string

任意

アプリケーションバージョン:

  • lite: ライトエディション。

  • std: スタンダードエディション。

  • pro: プロフェッショナルエディション。

pro

InitContainersConfig

array

任意

Init コンテナ構成。

InitContainerConfig

任意

Init コンテナ構成。

GpuConfig

string

任意

StartupProbe

string

任意

アプリケーション起動プローブを有効にします。呼び出し時にチェックが実行されます。

  • チェック成功: アプリケーションが正常に起動したことを示します。Liveness および Readiness チェックを構成している場合、アプリケーションの正常な起動後に実行されます。

  • チェック失敗: アプリケーションの起動に失敗したことを示します。例外が報告され、アプリケーションは自動的に再起動されます。スクリプトによるチェックも可能です。

説明

これは説明内容です。

  • exec、httpGet、および tcpSocket のメソッドがサポートされています。具体的な例については、Liveness パラメーターをご参照ください。

  • ヘルスチェックには 1 つのメソッドのみを選択できます。

{"exec":{"command":["sh","-c","cat /home/admin/start.sh"]},"initialDelaySeconds":30,"periodSeconds":30,"timeoutSeconds":2}

EnablePrometheus

boolean

任意

カスタム Prometheus メトリックコレクションを有効にするかどうかを指定します。プロ版で利用可能です。

false

Html

string

任意

Nginx バージョン。

  • nginx 1.20

  • nginx 1.22

  • nginx 1.24

  • nginx 1.26

  • nginx 1.28

nginx 1.28

EmptyDirDesc

string

任意

共有エフェメラルストレージ構成。

[{\"name\":\"workdir\",\"mountPath\":\"/usr/local/tomcat/webapps\"}]

AlbIngressReadinessGate

string

任意

ALB ゲートウェイ ReadinessGate 構成。

default

MaxSurgeInstances

integer

任意

サージインスタンスの最大値。有効な値:

利用可能なインスタンスの最小値が 100% の場合、最大サージを 0 に設定することはできません。 このパラメーターが -1 に設定されている場合、システム推奨値である 30% が使用されます。これは現在のインスタンス数の 30% です。たとえば、現在のインスタンス数が 10 の場合、値は 10 × 30% = 3 となります。

-1

MaxSurgeInstanceRatio

integer

任意

サージインスタンスの最大パーセンテージ。最大値として機能します。有効な値:

利用可能なインスタンスの最小値が 100% の場合、最大サージを 0 に設定することはできません。このパラメーターが -1 に設定されている場合、システム推奨値である 30% が使用されます。これは現在のインスタンス数の 30% です。たとえば、現在のインスタンス数が 10 の場合、値は 10 × 30% = 3 となります。

-1

AgentVersion

string

任意

AliyunAgent バージョン。

4.4.2

EnableNamespaceAgentVersion

boolean

任意

名前空間の Agent バージョン構成を再利用するかどうかを指定します。

true

SlsLogEnvTags

string

任意

SLS ログタグ。

LokiConfigs

string

任意

Labels

object

任意

string

任意

レスポンスフィールド

フィールド

説明

object

デプロイされたアプリケーション情報。

RequestId

string

リクエスト ID。

01CF26C7-00A3-4AA6-BA76-7E95F2A3***

Message

string

追加情報。フォーマットは以下の通りです。有効な値:

  • リクエストが成功した場合、success が返されます。

  • リクエストが失敗した場合、特定のエラーコードが返されます。

success

TraceId

string

トレース ID。リクエストの詳細をクエリするために使用されます。

ac1a0b2215622246421415014e****

Data

object

返された結果。

ChangeOrderId

string

返された変更注文 ID。タスク実行ステータスをクエリするために使用されます。

01db03d3-3ee9-48b3-b3d0-dfce2d88****

AppId

string

アプリケーション ID。

7171a6ca-d1cd-4928-8642-7d5cfe69****

IsNeedApproval

boolean

Resource Access Management (RAM) ユーザーによって公開された変更に承認が必須かどうかを示します。有効な値:

  • true: 承認が必要です。

  • false: 承認は不要です。

true

ErrorCode

string

エラーコード。フォーマットは文字列です。Topic に関連するエラーも含みます。有効な値:

  • リクエストが成功した場合、ErrorCode フィールドは返されません。

  • リクエストが失敗した場合、ErrorCode フィールドが返されます。詳細については、本トピックの「エラーコード」セクションをご参照ください。

Code

string

API ステータスまたは POP エラーコード。有効な値:

  • 2xx: 成功。

  • 3xx: リダイレクト。

  • 4xx: リクエストエラー。

  • 5xx: サーバーエラー。

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****",
    "IsNeedApproval": true
  },
  "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.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 MinReadyInstanceRatio.Invalid The ratio of minimum available instances must be between 0 and 100.
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.
400 InvalidParameter.FileName The application deployment package name is invalid. This name can contain only alphanumeric characters, hyphens (-), and underscores (_). For deploying java package, you can upload JAR files only if the selected deployment version supports JAR file. Otherwise, upload WAR files only. For deploying php package, you can upload ZIP files only if the selected deployment version supports ZIP file.
400 Sls.Logtail.Name.Invalid The specified name of Logtail is invalid. The Logtail name must not contain the prefix sae-.
400 InvalidImageUrl.MissingAcrInstanceId The specified domain of ImageUrl is from ACREE, but you are not specified AcrInstanceId.
400 EnvFromSecretIdConflict.AlreadyExist The specified SecretId [%s] already exist in the specified Envs.
400 MountConflict.Secret Conflict detected for Secret path %s.
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.

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

変更履歴

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