アプリケーションの構成情報を取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
sae:DescribeApplicationConfig |
get |
*All Resource
|
なし | なし |
リクエスト構文
GET /pop/v1/sam/app/describeApplicationConfig HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AppId |
string |
必須 |
アプリケーション ID。 |
7171a6ca-d1cd-4928-8642-7d5cfe69**** |
| VersionId |
string |
任意 |
バージョン ID。 |
0026ff7f-2b57-4127-bdd0-9bf202bb**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスデータ。 |
||
| RequestId |
string |
リクエスト ID。 |
01CF26C7-00A3-4AA6-BA76-7E95F2A3**** |
| Message |
string |
呼び出し結果に関する追加情報。 |
success |
| TraceId |
string |
トレース ID。呼び出しの詳細をクエリするために使用されます。 |
ac1a0b2215622246421415014e**** |
| Data |
object |
アプリケーション情報。 |
|
| VpcId |
string |
VPC の ID。 |
vpc-2ze0i263cnn311nvj**** |
| Readiness |
string |
アプリケーションの起動ステータスチェック。複数のヘルスチェックに失敗したコンテナはシャットダウンされ、再起動されます。ヘルスチェックに合格しないコンテナは SLB トラフィックを受信しません。exec、httpGet、および tcpSocket メソッドがサポートされています。具体的な例については、Liveness パラメーターを参照してください。 説明
ヘルスチェックには 1 つのメソッドのみを選択できます。 |
{"exec":{"command":["curl http://localhost:8080"]},"initialDelaySeconds":20,"timeoutSeconds":5} |
| ConfigMapMountDesc |
array<object> |
ConfigMap 情報。 |
|
|
object |
ConfigMap 情報。 |
||
| Key |
string |
キーと値のペアのキー。 |
k1 |
| ConfigMapName |
string |
ConfigMap の名前。 |
test |
| MountPath |
string |
コンテナのマウントパス。 |
/tmp |
| ConfigMapId |
integer |
ConfigMap の ID。 |
1 |
| SecurityGroupId |
string |
セキュリティグループ ID。 |
sg-wz969ngg2e49q5i4**** |
| BatchWaitTime |
integer |
段階的リリース中のバッチ間の待機時間 (秒単位)。 |
10 |
| Jdk |
string |
デプロイメントパッケージが依存する JDK バージョン。有効な値:
Package Type が Image にセットされている場合、このパラメーターはサポートされません。 |
Open JDK 8 |
| ImageUrl |
string |
イメージ URL。Package Type が Image に設定されている場合、このパラメーターは必須です。 |
docker.io/library/nginx:1.14.2 |
| SlsConfigs |
string |
Simple Log Service (SLS) サービスへのログ収集の設定。
パラメーターの説明:
複数のデプロイ中に SLS 収集設定が変更されていない場合、このパラメーターを設定する必要はありません (つまり、リクエストに SlsConfigs フィールドを含める必要はありません)。SLS 収集機能が不要になった場合は、リクエストでこのフィールドの値を空の文字列に設定します (つまり、SlsConfigs フィールドの値を "" に設定します)。 |
[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}] |
| Liveness |
string |
コンテナのヘルスチェック設定。ヘルスチェックに失敗したコンテナはシャットダウンされ、復旧されます。以下のメソッドがサポートされています。
説明
ヘルスチェックには 1 つのメソッドのみを選択できます。 パラメーターの説明:
|
{"exec":{"command":["curl http://localhost:8080"]},"initialDelaySeconds":20,"timeoutSeconds":3} |
| Tags |
array<object> |
タグ情報。 |
|
|
object |
タグ情報。 |
||
| Key |
string |
タグキー。 |
k1 |
| Value |
string |
タグ値。 |
v1 |
| PackageUrl |
string |
デプロイメントパッケージの URL。デプロイメントパッケージが SAE を通じてアップロードされた場合は、次の点に注意してください。
|
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 |
デプロイメントパッケージのバージョン。Package Type が 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 |
| UpdateStrategy |
string |
デプロイポリシー。最小利用可能インスタンス数が 1 の場合、UpdateStrategy フィールドの値は "" です。最小利用可能インスタンス数が 1 より大きい場合の例は以下の通りです。
パラメーターの説明:
|
{"type":"GrayBatchUpdate","batchUpdate":{"batch":2,"releaseType":"auto","batchWaitTime":1},"grayUpdate":{"gray":1}} |
| MinReadyInstances |
integer |
最小利用可能インスタンス数。有効な値:
説明
サービスの中断を避けるため、ローリングデプロイごとに最小利用可能インスタンス数を 1 以上に設定してください。 |
1 |
| MinReadyInstanceRatio |
integer |
最小利用可能インスタンスの割合。有効な値:
説明
MinReadyInstance と MinReadyInstanceRatio の両方が指定されており、MinReadyInstanceRatio の値が -1 でない場合、MinReadyInstanceRatio パラメーターが優先されます。たとえば、MinReadyInstances が 5 に設定され、MinReadyInstanceRatio が 50 に設定されている場合、システムは MinReadyInstanceRatio を使用して最小利用可能インスタンス数を計算します。 |
-1 |
| Memory |
integer |
各インスタンスに必要なメモリサイズ (MB 単位)。この値を 0 にすることはできません。メモリサイズは CPU と 1 対 1 でマッピングされます。以下の固定仕様のみがサポートされています。
|
2048 |
| Php |
string |
PHP デプロイメントパッケージが依存する PHP バージョン。イメージはサポートされていません。 |
PHP-FPM 7.0 |
| 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 内の NAS のマウントポイント。デプロイ中に設定が変更されていない場合、このパラメーターを設定する必要はありません (つまり、リクエストに MountHost フィールドを含める必要はありません)。NAS 設定をクリアするには、リクエストでこのフィールドの値を空の文字列に設定します (つまり、MountHost フィールドの値を "" に設定します)。 |
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 インスタンスを作成してください。詳細については、 CreateConfigMap を参照してください。有効な値:
|
[{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}] |
| MountDesc |
array<object> |
マウントの説明情報。 |
|
|
object |
マウントの説明情報。 |
||
| MountPath |
string |
コンテナのマウントパス。 |
/tmp |
| NasPath |
string |
NAS ファイルシステムのパス。 |
/ |
| EnableAhas |
string |
Application High Availability Service (AHAS) サービスに接続するかどうかを指定します。有効な値:
|
true |
| CustomHostAlias |
string |
コンテナ内のカスタムホストマッピング。有効な値:
|
[{"hostName":"test.host.name","ip":"0.0.0.0"}] |
| WebContainer |
string |
デプロイメントパッケージが依存する Tomcat バージョン。有効な値:
Package Type が Image にセットされている場合、このパラメーターはサポートされません。 |
apache-tomcat-7.0.91 |
| Command |
string |
イメージ起動コマンド。このコマンドは、コンテナ内に存在する実行可能なオブジェクトである必要があります。例:
上記の例に基づき、 |
echo |
| WarStartOptions |
string |
WAR パッケージアプリケーションの起動オプション。アプリケーションのデフォルト起動コマンド: |
custom-option |
| PhpArmsConfigLocation |
string |
PHP アプリケーションモニタリングのマウントパス。PHP サーバーがこのパスから設定ファイルを読み込むことを確認してください。 設定内容を管理する必要はありません。SAE が正しい設定ファイルを自動的にレンダリングします。 |
/usr/local/etc/php/conf.d/arms.ini |
| NasId |
string |
NAS の ID。 |
AKSN**** |
| OssAkId |
string |
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 |
| EnableGreyTagRoute |
boolean |
トラフィックカナリアリリースルールを有効にするかどうかを指定します。このルールは Spring Cloud および Dubbo フレームワークを使用するアプリケーションにのみ適用されます。有効な値:
|
false |
| MseApplicationId |
string |
Microservices Engine (MSE) 側のアプリケーションの ID。 |
xxxxxxx@xxxxx |
| AcrInstanceId |
string |
ACR エンタープライズインスタンスの ID。 |
cri-xxxxxx |
| AcrAssumeRoleArn |
string |
アカウント間でイメージをプルするために必要な RAM ロールの Amazon リソースネーム (ARN)。詳細については、アカウント間で Alibaba Cloud イメージをプルする および RAM ロールを使用してクロスアカウント権限を付与する を参照してください。 |
acs:ram::123456789012****:role/adminrole |
| ImagePullSecrets |
string |
対応するシークレットの ID。 |
10 |
| AssociateEip |
boolean |
EIP を関連付けるかどうかを指定します。有効な値:
|
true |
| KafkaConfigs |
string |
Kafka のログ収集設定のサマリー。有効な値:
|
{"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"}]} |
| ProgrammingLanguage |
string |
アプリケーションの作成に使用される技術スタックのプログラミング言語。有効な値:
|
java |
| PvtzDiscovery |
string |
K8s Service ベースのサービス登録と検出を有効にします。 |
{ "serviceName": "bwm-poc-sc-gateway-cn-beijing-front", "namespaceId": "cn-beijing:front", "portAndProtocol": { "18012": "TCP" }, "portProtocols": [ { "port": "18012", "protocol": "TCP" } ], "enable": true } |
| SwimlanePvtzDiscovery |
string |
エンドツーエンドのカナリアリリースを備えた K8s Service ベースのサービス登録と検出を設定します。 |
{\"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" |
| NasConfigs |
string |
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 |
カスタムインストールモジュールの依存関係。デフォルトでは、ルートディレクトリの requirements.txt ファイルで定義された依存関係がインストールされます。依存関係が設定されていないか、カスタムパッケージが必要な場合は、インストールする依存関係を指定できます。 |
Flask==2.0 |
| MseApplicationName |
string |
SAE サービスが MSE に登録された後のアプリケーション名。 |
cn-shenzhen-alb-demo-5c**** |
| AppSource |
string |
SAE アプリケーションタイプ。
|
micro_service |
| ServiceTags |
object |
アプリケーションに設定されたカナリアリリースタグ。 |
|
|
string |
カナリアリリースタグ値。 |
tag1 |
|
| Dotnet |
string |
.NET フレームワークバージョン:
|
.NET 8.0 |
| MicroRegistrationConfig |
string |
レジストリ設定。このパラメーターは、レジストリタイプが MSE Nacos Enterprise Edition の場合にのみ効果があります。 |
{\"instanceId\":\"mse-cn-1ls43******\",\"namespace\":\"62ee12fb-c279-4da4-be96-21**********\"} |
| EnableIdle |
boolean |
アイドルモードを有効にするかどうかを指定します。有効な値:
|
false |
| EnableNewArms |
boolean |
新しい ARMS 機能を有効にするかどうかを指定します。有効な値:
|
false |
| EnableCpuBurst |
string |
CPU Burst 機能を有効にするかどうかを指定します。有効な値:
|
true |
| OidcRoleName |
string |
身分認証用の RAM ロール。 説明
事前に同じリージョンに OIDC ID プロバイダーと ID プロバイダーロールを作成してください。詳細については、OIDC ID プロバイダーの作成 および シングルサインオン (SSO) ID プロバイダー用ロールの作成 を参照してください。 |
sae-test |
| SecretMountDesc |
array<object> |
シークレットのマウント説明。 |
|
|
object |
シークレットのマウント説明。 |
||
| Key |
string |
Base64 でエンコードされたデータ値のキー。 |
task-center |
| SecretName |
string |
シークレットインスタンスの名前。 |
dummy-name-opaque-894 |
| MountPath |
string |
マウントパス。 |
/opt/www/runtime/logs |
| SecretId |
integer |
照会されたシークレットインスタンスの ID。 |
520 |
| SidecarContainersConfig |
array<object> |
サイドカーコンテナ設定。 |
|
|
array<object> |
サイドカーコンテナ設定。 |
||
| Name |
string |
コンテナ名。 |
test |
| Cpu |
integer |
サイドカーコンテナがメインコンテナから使用できる最大の CPU リソース。 |
500 |
| Memory |
integer |
サイドカーコンテナがメインコンテナから使用できる最大のメモリリソース。 |
1024 |
| ImageUrl |
string |
イメージの URL。 |
registry.cn-beijing.aliyuncs.com/sae-dev-test/nginx:stable |
| AcrInstanceId |
string |
Container Registry Enterprise Edition インスタンスの ID。ImageUrl が Container Registry Enterprise Edition のイメージに設定されている場合、このパラメーターは必須です。 |
cri-fhzlneorxala66ip |
| Command |
string |
イメージの起動コマンド。コマンドはコンテナ内に存在する実行可能オブジェクトでなければなりません。例:
上記の例に基づくと、 |
/bin/sh |
| CommandArgs |
string |
イメージ起動コマンドの引数。引数は、上記の起動コマンド Command で必要です。フォーマット:
上記の例では、 |
[\"-c\",\"echo \\\"test\\\" > /home/nas/test.log && sleep 10000000s\"] |
| Envs |
string |
コンテナの環境変数。環境変数をカスタマイズするか、ConfigMap を参照できます。ConfigMap を参照するには、まず ConfigMap インスタンスを作成する必要があります。詳細については、「 CreateConfigMap 」をご参照ください。有効値:
|
[{\"name\":\"k1\",\"value\":\"c8e3a815-e5d3-4adf-abb3-98b106a607c4\"}] |
| ConfigMapMountDesc |
array<object> |
マウントしたい ConfigMap の説明。「名前空間設定項目」ページで作成した設定項目を使用して、構成情報をコンテナに注入します。パラメーターは次のように説明されます:
説明
|
|
|
object |
マウントしたい ConfigMap の説明。 |
||
| Key |
string |
ConfigMap のキー。 |
key |
| ConfigMapName |
string |
ConfigMap の名前。 |
ConfigMap-test |
| MountPath |
string |
コンテナのマウントパス。 |
/mnt/test |
| ConfigMapId |
integer |
ConfigMap インスタンスの ID。 |
7361 |
| EmptyDirDesc |
array<object> |
共有一時ストレージ。一時ストレージディレクトリを設定し、メインコンテナとサイドカーコンテナにマウントします。 |
|
|
object |
共有一時ストレージ。 |
||
| Name |
string |
一時ストレージの名前。 |
sidecar-container |
| MountPath |
string |
ボリュームがコンテナにマウントされるパス。 |
/mnt/cache |
| SecretMountDesc |
array<object> |
マウントしたいシークレットの説明。 |
|
|
object |
|||
| Key |
string |
Base64 でエンコードされたデータ値のキー。 |
|
| SecretName |
string |
シークレットインスタンスの名前。 |
|
| MountPath |
string |
マウントパス。 |
|
| SecretId |
integer |
シークレットインスタンスの ID。 |
|
| Liveness |
string |
コンテナのヘルスチェック。 |
|
| Readiness |
string |
アプリケーションの起動ステータスのチェック。 |
|
| PreStop |
string |
||
| PostStart |
string |
||
| InitContainersConfig |
array<object> |
init コンテナ設定。 |
|
|
array<object> |
init コンテナ設定。 |
||
| Name |
string |
init コンテナの名前。 |
init-container |
| ImageUrl |
string |
init コンテナが使用するイメージの URL。 |
registry.cn-shenzhen.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0 |
| Command |
string |
イメージの起動コマンド。コマンドはコンテナ内に存在する実行可能オブジェクトでなければなりません。例:
上記の例に基づくと、 |
/bin/sh |
| CommandArgs |
string |
イメージ起動コマンドの引数。引数は、上記の起動コマンド Command で必要です。フォーマット:
上記の例では、 |
["a","b"] |
| Envs |
string |
コンテナの環境変数。環境変数をカスタマイズするか、ConfigMap を参照できます。ConfigMap を参照するには、まず ConfigMap インスタンスを作成する必要があります。詳細については、「 CreateConfigMap 」をご参照ください。有効値:
|
[{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}] |
| ConfigMapMountDesc |
array<object> |
ConfigMap の構成。 |
|
|
object |
ConfigMap のキーと値のペア。 |
||
| Key |
string |
キーと値のペアのキー。 |
k1 |
| ConfigMapName |
string |
ConfigMap の名前。 |
test |
| MountPath |
string |
コンテナのマウントパス。 |
/tmp |
| ConfigMapId |
integer |
ConfigMap の ID。 |
1 |
| EmptyDirDesc |
array<object> |
共有一時ストレージ。 |
|
|
object |
|||
| Name |
string |
一時ストレージの名前。 |
|
| MountPath |
string |
ボリュームがコンテナにマウントされるパス。 |
|
| SecretMountDesc |
array<object> |
マウントしたいシークレットの説明。 |
|
|
object |
|||
| Key |
string |
キー。 |
|
| SecretName |
string |
シークレットインスタンスの名前。 |
|
| MountPath |
string |
マウントパス。 |
|
| SecretId |
integer |
シークレットインスタンスの ID。 |
|
| CustomImageNetworkType |
string |
カスタムイメージのタイプ。イメージがカスタムイメージでない場合、このパラメーターを空の文字列に設定します。有効な値:
|
internet |
| ResourceType |
string |
The resource type. Only |
application |
| BaseAppId |
string |
The ID of the baseline application. |
8c573618-8d72-4407-baf4-f7b64b****** |
| MicroserviceEngineConfig |
string |
The microservice governance configuration.
|
{\"Enable\":true,\"MseLosslessRule\":{\"enable\":true,\"notice\":true,\"delayTime\":10,\"warmupTime\":120,\"funcType\":2,\"aligned\":false,\"related\":false,\"lossLessDetail\":false}} |
| NewSaeVersion |
string |
The application version. Valid values:
|
pro |
| ClusterId |
string |
The cluster ID. |
495fc79c-ae61-4600-866d-a09d68****** |
| DiskSize |
integer |
The disk storage size, in GB. |
20 |
| StartupProbe |
string |
The startup probe of the application. |
{\"exec\":{\"command\":[\"/bin/sh\",\"-c\",\"#!Note: If microservice config is enabled, the application will be automatically injected with the prestop configuration for lossless offline. If you delete this prestop configuration, lossless offline will not be effective.\\n echo stop > /tmp/prestop; /home/admin/.tools/curl http://127.0.0.1:54199/offline; sleep 30\"]}} |
| GpuCount |
string |
The number of GPUs. |
|
| GpuType |
string |
The GPU type. |
|
| EnablePrometheus |
boolean |
Indicates whether Prometheus custom metric collection is enabled. |
|
| IsStateful |
boolean |
Indicates whether the application is stateful. |
|
| CmsServiceId |
string |
The CloudMonitor service ID. |
|
| HeadlessPvtzDiscovery |
string |
||
| Html |
string |
||
| EmptyDirDesc |
array<object> |
共有一時ストレージ。 |
|
|
object |
The shared ephemeral storage configuration. |
||
| Name |
string |
一時ストレージの名前。 |
|
| MountPath |
string |
マウントパス。 |
|
| DeploymentName |
string |
The instance name of the application in the ASI cluster. |
demo-b0cdce9b-3d1f-4168-b206-b59f348f1a8a |
| AlbIngressReadinessGate |
string |
The ALB gateway ReadinessGate configuration. |
|
| MaxSurgeInstances |
integer |
The Peak Volume of instances. |
|
| MaxSurgeInstanceRatio |
integer |
The Peak Volume instance ratio. |
|
| AgentVersion |
string |
The agent version. |
|
| EnableNamespaceAgentVersion |
boolean |
Indicates whether the namespace agent version configuration is reused. |
|
| SlsLogEnvTags |
string |
sls log env tags |
|
| LokiConfigs |
string |
LokiConfigs |
|
| IdleHour |
string |
||
| Labels |
object |
The labels. |
|
|
string |
|||
| RaspConfig |
array<object> |
||
|
object |
|||
| EnableRasp |
boolean |
||
| RaspAppName |
string |
||
| RaspAppKey |
string |
||
| ErrorCode |
string |
The error code. Valid values:
|
|
| Code |
string |
The API status or POP error code. Valid values:
|
200 |
| Success |
boolean |
Indicates whether the application configuration information is retrieved. Valid values:
|
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "01CF26C7-00A3-4AA6-BA76-7E95F2A3****",
"Message": "success",
"TraceId": "ac1a0b2215622246421415014e****",
"Data": {
"VpcId": "vpc-2ze0i263cnn311nvj****",
"Readiness": "{\"exec\":{\"command\":[\"curl http://localhost:8080\"]},\"initialDelaySeconds\":20,\"timeoutSeconds\":5}",
"ConfigMapMountDesc": [
{
"Key": "k1",
"ConfigMapName": "test",
"MountPath": "/tmp",
"ConfigMapId": 1
}
],
"SecurityGroupId": "sg-wz969ngg2e49q5i4****",
"BatchWaitTime": 10,
"Jdk": "Open JDK 8",
"ImageUrl": "docker.io/library/nginx:1.14.2",
"SlsConfigs": "[{\"logDir\":\"\",\"logType\":\"stdout\"},{\"logDir\":\"/tmp/a.log\"}]",
"Liveness": "{\"exec\":{\"command\":[\"curl http://localhost:8080\"]},\"initialDelaySeconds\":20,\"timeoutSeconds\":3}",
"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,
"UpdateStrategy": "{\"type\":\"GrayBatchUpdate\",\"batchUpdate\":{\"batch\":2,\"releaseType\":\"auto\",\"batchWaitTime\":1},\"grayUpdate\":{\"gray\":1}}",
"MinReadyInstances": 1,
"MinReadyInstanceRatio": -1,
"Memory": 2048,
"Php": "PHP-FPM 7.0",
"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": "/"
}
],
"EnableAhas": "true",
"CustomHostAlias": "[{\"hostName\":\"test.host.name\",\"ip\":\"0.0.0.0\"}]",
"WebContainer": "apache-tomcat-7.0.91",
"Command": "echo",
"WarStartOptions": "custom-option",
"PhpArmsConfigLocation": "/usr/local/etc/php/conf.d/arms.ini",
"NasId": "AKSN****",
"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",
"EnableGreyTagRoute": false,
"MseApplicationId": "xxxxxxx@xxxxx",
"AcrInstanceId": "cri-xxxxxx",
"AcrAssumeRoleArn": "acs:ram::123456789012****:role/adminrole",
"ImagePullSecrets": "10",
"AssociateEip": true,
"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\"}]}",
"ProgrammingLanguage": "java",
"PvtzDiscovery": "{ \"serviceName\": \"bwm-poc-sc-gateway-cn-beijing-front\", \"namespaceId\": \"cn-beijing:front\", \"portAndProtocol\": { \"18012\": \"TCP\" }, \"portProtocols\": [ { \"port\": \"18012\", \"protocol\": \"TCP\" } ], \"enable\": true }",
"SwimlanePvtzDiscovery": "{\\\"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": "\"0\"",
"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",
"MseApplicationName": "cn-shenzhen-alb-demo-5c****",
"AppSource": "micro_service",
"ServiceTags": {
"key": "tag1"
},
"Dotnet": ".NET 8.0",
"MicroRegistrationConfig": "{\\\"instanceId\\\":\\\"mse-cn-1ls43******\\\",\\\"namespace\\\":\\\"62ee12fb-c279-4da4-be96-21**********\\\"}",
"EnableIdle": false,
"EnableNewArms": false,
"EnableCpuBurst": "true",
"OidcRoleName": "sae-test",
"SecretMountDesc": [
{
"Key": "task-center",
"SecretName": "dummy-name-opaque-894",
"MountPath": "/opt/www/runtime/logs",
"SecretId": 520
}
],
"SidecarContainersConfig": [
{
"Name": "test",
"Cpu": 500,
"Memory": 1024,
"ImageUrl": "registry.cn-beijing.aliyuncs.com/sae-dev-test/nginx:stable",
"AcrInstanceId": "cri-fhzlneorxala66ip",
"Command": "/bin/sh",
"CommandArgs": "[\\\"-c\\\",\\\"echo \\\\\\\"test\\\\\\\" > /home/nas/test.log && sleep 10000000s\\\"]",
"Envs": "[{\\\"name\\\":\\\"k1\\\",\\\"value\\\":\\\"c8e3a815-e5d3-4adf-abb3-98b106a607c4\\\"}]",
"ConfigMapMountDesc": [
{
"Key": "key",
"ConfigMapName": "ConfigMap-test",
"MountPath": "/mnt/test",
"ConfigMapId": 7361
}
],
"EmptyDirDesc": [
{
"Name": "sidecar-container",
"MountPath": "/mnt/cache"
}
],
"SecretMountDesc": [
{
"Key": "",
"SecretName": "",
"MountPath": "",
"SecretId": 0
}
],
"Liveness": "",
"Readiness": "",
"PreStop": "",
"PostStart": ""
}
],
"InitContainersConfig": [
{
"Name": "init-container",
"ImageUrl": "registry.cn-shenzhen.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0",
"Command": "/bin/sh",
"CommandArgs": "[\"a\",\"b\"]\n",
"Envs": "[{\"name\":\"TEST_ENV_KEY\",\"value\":\"TEST_ENV_VAR\"}]\n",
"ConfigMapMountDesc": [
{
"Key": "k1\n",
"ConfigMapName": "test\n",
"MountPath": "/tmp\n",
"ConfigMapId": 1
}
],
"EmptyDirDesc": [
{
"Name": "",
"MountPath": ""
}
],
"SecretMountDesc": [
{
"Key": "",
"SecretName": "",
"MountPath": "",
"SecretId": 0
}
]
}
],
"CustomImageNetworkType": "internet",
"ResourceType": "application",
"BaseAppId": "8c573618-8d72-4407-baf4-f7b64b******",
"MicroserviceEngineConfig": "{\\\"Enable\\\":true,\\\"MseLosslessRule\\\":{\\\"enable\\\":true,\\\"notice\\\":true,\\\"delayTime\\\":10,\\\"warmupTime\\\":120,\\\"funcType\\\":2,\\\"aligned\\\":false,\\\"related\\\":false,\\\"lossLessDetail\\\":false}}",
"NewSaeVersion": "pro",
"ClusterId": "495fc79c-ae61-4600-866d-a09d68******",
"DiskSize": 20,
"StartupProbe": "{\\\"exec\\\":{\\\"command\\\":[\\\"/bin/sh\\\",\\\"-c\\\",\\\"#!Note: If microservice config is enabled, the application will be automatically injected with the prestop configuration for lossless offline. If you delete this prestop configuration, lossless offline will not be effective.\\\\n echo stop > /tmp/prestop; /home/admin/.tools/curl http://127.0.0.1:54199/offline; sleep 30\\\"]}}",
"GpuCount": "",
"GpuType": "",
"EnablePrometheus": false,
"IsStateful": false,
"CmsServiceId": "",
"HeadlessPvtzDiscovery": "",
"Html": "",
"EmptyDirDesc": [
{
"Name": "",
"MountPath": ""
}
],
"DeploymentName": "demo-b0cdce9b-3d1f-4168-b206-b59f348f1a8a",
"AlbIngressReadinessGate": "",
"MaxSurgeInstances": 0,
"MaxSurgeInstanceRatio": 0,
"AgentVersion": "",
"EnableNamespaceAgentVersion": false,
"SlsLogEnvTags": "",
"LokiConfigs": "",
"IdleHour": "",
"Labels": {
"key": ""
},
"RaspConfig": [
{
"EnableRasp": true,
"RaspAppName": "",
"RaspAppKey": ""
}
]
},
"ErrorCode": "",
"Code": "200",
"Success": true
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidApplication.NotFound | The current application does not exist. | |
| 404 | InvalidAppId.NotFound | The specified AppId does not exist. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。