全部產品
Search

搜尋本產品

    Serverless App Engine：DescribeApplicationConfig

    文件中心

    Serverless App Engine：DescribeApplicationConfig

    更新時間：Jul 10, 2026

    取得應用程式設定資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    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 參數。

    說明

    只能選擇一種方式進行健康檢查。

    {"exec":{"command":["curl http://localhost:8080"]},"initialDelaySeconds":20,"timeoutSeconds":5}
    ConfigMapMountDesc

    array<object>

    ConfigMap 資訊。

    object

    ConfigMap 資訊。

    Key

    string

    ConfigMap 索引值對。

    k1
    ConfigMapName

    string

    ConfigMap 名稱。

    test
    MountPath

    string

    容器掛載路徑。

    /tmp
    ConfigMapId

    integer

    ConfigMap ID。

    1
    SecurityGroupId

    string

    安全性群組 ID。

    sg-wz969ngg2e49q5i4****
    BatchWaitTime

    integer

    分批發佈時批次間的等待時間，單位為秒。

    10
    Jdk

    string

    部署套件相依的 JDK 版本。支援版本如下：

    • Open JDK 8

    • Open JDK 7

    • Dragonwell 11

    • Dragonwell 8

    • openjdk-8u191-jdk-alpine3.9

    • openjdk-7u201-jdk-alpine3.9

    當 Package Type 為 Image 時不支援。

    Open JDK 8
    ImageUrl

    string

    映像位址。當 Package Type 為 Image 時必填。

    docker.io/library/nginx:1.14.2
    SlsConfigs

    string

    日誌採集到 SLS 的設定。

    • 使用 SAE 自動建立的 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：設定 SLS 上的 Project 名稱。

    • logDir：日誌路徑。

    • logType：日誌類型。stdout 表示容器標準輸出日誌，僅可設定 1 條；如果不設定，則表示收集檔案日誌。

    • logstoreName：設定 SLS 上的 Logstore 名稱。

    • logtailName：設定 SLS 上的 Logtail 名稱，如果不指定，則表示新建 Logtail。

    多次部署時如果 SLS 採集設定沒有變更，則不需要設定該參數（即請求中無需包含 SlsConfigs 欄位）；如果不再需要使用 SLS 採集功能，您需要在請求中將該欄位的值設定為空字串（即請求中 SlsConfigs 欄位的值為 ""）。

    [{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]
    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}

    說明

    只能選擇一種方式進行健康檢查。

    參數說明如下：

    • 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":["curl http://localhost:8080"]},"initialDelaySeconds":20,"timeoutSeconds":3}
    Tags

    array<object>

    標籤資訊。

    object

    標籤資訊。

    Key

    string

    標籤鍵。

    k1
    Value

    string

    標籤值。

    v1
    PackageUrl

    string

    部署套件位址，如果您的部署套件是透過 SAE 上傳的，需要注意以下兩點：

    • 該位址不能直接下載，需要您透過 GetPackageVersionAccessableUrl 介面來取得可下載的位址（有效期 10 分鐘）。

    • 該套件在 SAE 端最長時間會保留 90 天，超過 90 天後不會返回位址也不提供下載。

    https://edas-bj.oss-cn-beijing.aliyuncs.com/apps/K8s_APP_ID/d4c97c37-aba3-403e-ae1e-6f7d8742****/hello-sae.war
    PackageType

    string

    應用程式套件類型。取值說明如下：

    • 當您選擇用 Java 部署時，支援 FatJar、War 和 Image。

    • 當您選擇用 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

    War
    PreStop

    string

    容器停止前執行指令碼。在容器被刪除前觸發執行一段指令碼，格式如：{"exec":{"command":\["cat","/etc/group"\]}}

    {"exec":{"command":["cat","/etc/group"]}}
    PackageVersion

    string

    部署套件的版本號。當 Package Type 為 FatJar 或 War 時必填。

    1.0
    JarStartArgs

    string

    JAR 套件啟動應用程式參數。應用程式預設啟動命令：$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

    start
    AppName

    string

    應用程式名稱。

    demo-app
    AppId

    string

    應用程式 ID。

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

    string

    JAR 套件啟動應用程式選項。應用程式預設啟動命令：$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs

    -Dtest=true
    Replicas

    integer

    應用程式執行個體個數。

    2
    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：灰度後剩餘批次，當 type 為 GrayBatchUpdate 時必填。

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

    integer

    最小存活執行個體數。取值說明如下：

    • 如果設定為 0，應用程式在升級過程中將會中斷業務。

    • 如果設定為 -1，最小存活執行個體數將使用系統推薦值，即取現有執行個體數的 25%。如果當前為 5 個執行個體，5×25%=1.25，向上取整後，最小存活執行個體數為 2。

    說明

    每次滾動部署最小存活的執行個體數建議 ≥1，保證業務不中斷。

    1
    MinReadyInstanceRatio

    integer

    最小存活執行個體數百分比。取值說明如下：

    • -1：預設值，表示不採用百分比。如果不填寫，系統預設為 -1。

    • 0~100：單位為百分比，向上取整。例如設定為 50%，如果當前為 5 個執行個體，則最小存活執行個體數為 3。

    說明

    當 MinReadyInstance 和 MinReadyInstanceRatio 同時傳遞，且 MinReadyInstanceRatio 的取值非 -1 時，以 MinReadyInstanceRatio 參數為準。假設 MinReadyInstances 取值為 5，MinReadyInstanceRatio 取值為 50，則會用 MinReadyInstanceRatio 來計算最小存活執行個體數。

    -1
    Memory

    integer

    每個執行個體所需的記憶體，單位為 MB，不能為 0。與 CPU 為一一對應關係，目前僅支援以下固定規格：

    • 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 毫核。

    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"\]}}

    {"exec":{"command":["cat","/etc/group"]}}
    TerminationGracePeriodSeconds

    integer

    優雅下線逾時時間，預設為 30，單位為秒。取值範圍為 1~300。

    10
    CommandArgs

    string

    映像啟動命令參數。啟動命令 Command 所需參數。格式如下：

    ["a","b"]

    在 Command 參數的範例中，CommandArgs=["abc", ">", "file0"]，其中 ["abc", ">", "file0"] 需要轉成 String 類型，裡面的格式為 JSON 陣列。如果無此參數，則無需填寫。

    ["a","b"]
    NamespaceId

    string

    命名空間 ID。

    cn-beijing:test
    MountHost

    string

    NAS 在應用程式 VPC 內的掛載點。部署時如果設定沒有變更，則不需要設定該參數（即請求中無需包含 MountHost 欄位）；如果需要清除 NAS 設定，您需要在請求中將該欄位的值設定為空字串（即請求中 MountHost 欄位的值為 ""）。

    example.com
    TomcatConfig

    string

    Tomcat 檔案設定，設定為 "" 或 "{}" 表示刪除設定：

    • port：連接埠範圍為 1024~65535，小於 1024 的連接埠需要 Root 權限才能操作。因為容器設定的是 Admin 權限，所以請填寫大於 1024 的連接埠。如果不設定，則預設為 8080。

    • contextPath：存取路徑，預設為根目錄 "/"。

    • maxThreads：設定連線池的連線數大小，預設大小為 400。

    • uriEncoding：Tomcat 的編碼格式，包括 UTF-8、ISO-8859-1、GBK 和 GB2312。如果不設定，則預設為 ISO-8859-1。

    • useBodyEncoding：是否使用 BodyEncoding for URL，預設為 true。

    {"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。目前僅支援以下固定規格：

    • 500

    • 1000

    • 2000

    • 4000

    • 8000

    • 16000

    • 32000

    1000
    Envs

    string

    容器環境變數參數。支援自訂或引用設定項目。如需引用設定項目，請先建立 ConfigMap 執行個體。更多資訊，請參見 CreateConfigMap 。取值說明如下：

    • 自訂設定

      • name：環境變數名稱。

      • value：環境變數值。

    • 引用設定項目

      • name：環境變數名稱。支援引用單個或全部鍵，如果引用全部鍵，需輸入 sae-sys-configmap-all-<設定項目名稱>，例如 sae-sys-configmap-all-test1。

      • valueFrom：環境變數引用。取值為 configMapRef。

      • configMapId：設定項目 ID。

      • key：鍵。如果引用全部鍵值，則不設定該欄位。

    [{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}]
    MountDesc

    array<object>

    掛載描述資訊。

    object

    掛載描述資訊。

    MountPath

    string

    容器掛載路徑。

    /tmp
    NasPath

    string

    NAS 相對檔案目錄。

    /
    EnableAhas

    string

    是否接入 AHAS。取值說明如下：

    • true：接入 AHAS。

    • false：不接入 AHAS。

    true
    CustomHostAlias

    string

    容器內自訂 Host 對應。取值說明如下：

    • hostName：網域名稱或主機名稱。

    • ip：IP 位址。

    [{"hostName":"test.host.name","ip":"0.0.0.0"}]
    WebContainer

    string

    部署套件相依的 Tomcat 版本。支援版本如下：

    • apache-tomcat-7.0.91

    • apache-tomcat-8.5.42

    當 Package Type 為 Image 時不支援。

    apache-tomcat-7.0.91
    Command

    string

    映像啟動命令。該命令必須為容器內存在的可執行的物件。範例如下：

    command:
      - echo
      - abc
      - >
      - file0

    根據上述範例，則 Command="echo", CommandArgs=["abc", ">", "file0"]。

    echo
    WarStartOptions

    string

    WAR 套件啟動應用程式選項。應用程式預設啟動命令：java $JAVA_OPTS $CATALINA_OPTS -Options org.apache.catalina.startup.Bootstrap "$@" start。

    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

    Bucket 名稱。

    oss-bucket
    bucketPath

    string

    您在 OSS 建立的目錄或 OSS 對象，如果 OSS 掛載目錄不存在，會觸發異常。

    data/user.data
    mountPath

    string

    您在 SAE 的容器路徑。如果路徑已存在，為覆蓋關係；如果路徑不存在，會建立。

    /usr/data/user.data
    readOnly

    boolean

    容器路徑是否對掛載目錄資源有可讀許可權，取值說明如下：

    • true：唯讀許可權。

    • false：讀寫權限。

    true
    EdasContainerVersion

    string

    HSF 框架中應用程式執行環境版本，例如 Ali-Tomcat 容器。

    3.5.3
    Timezone

    string

    時區，預設為 Asia/Shanghai。

    Asia/Shanghai
    AppDescription

    string

    應用程式描述資訊。

    Sample application
    EnableGreyTagRoute

    boolean

    是否啟用流量灰度規則。該規則僅適用於 Spring Cloud 和 Dubbo 框架的應用程式。取值說明如下：

    • true：啟用灰度規則。

    • false：停用灰度規則。

    false
    MseApplicationId

    string

    對應 MSE 產品側應用程式 ID。

    xxxxxxx@xxxxx
    AcrInstanceId

    string

    ACR 企業版執行個體 ID。

    cri-xxxxxx
    AcrAssumeRoleArn

    string

    跨帳號拉取映像時所需的 RAM 角色的 ARN。更多資訊，請參見跨帳號拉取阿里雲映像和透過 RAM 角色實現跨雲端帳號授權。

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

    string

    對應保密字典 ID。

    10
    AssociateEip

    boolean

    是否綁定 EIP。取值說明如下：

    • true：綁定。

    • false：不綁定。

    true
    KafkaConfigs

    string

    日誌採集到 Kafka 的設定彙總資訊。取值說明如下：

    • kafkaEndpoint：Kafka API 的服務接入位址。

    • kafkaInstanceId：Kafka 執行個體 ID。

    • kafkaConfigs：單條或多條日誌的設定彙總資訊。範例值與參數說明，請參見本文的請求參數 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

    string

    建立應用程式的技術堆疊語言。取值說明如下：

    • java：Java 語言。

    • php：PHP 語言。

    • other：多語言，例如 Python、C++、Go、.NET 和 Node.js 等。

    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：SAE 內建 Nacos。

    • 1：使用者自建 Nacos。

    • 2：MSE 商業版 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。

    • web。

    • job。

    micro_service
    ServiceTags

    object

    應用程式設定的灰度標籤。

    string

    灰度標籤值。

    tag1
    Dotnet

    string

    .NET 框架的版本號：

    • .NET 3.1

    • .NET 5.0

    • .NET 6.0

    • .NET 7.0

    • .NET 8.0

    .NET 8.0
    MicroRegistrationConfig

    string

    註冊中心設定，僅在註冊中心類型為 MSE Nacos 企業版時生效。

    {\"instanceId\":\"mse-cn-1ls43******\",\"namespace\":\"62ee12fb-c279-4da4-be96-21**********\"}
    EnableIdle

    boolean

    是否開啟閒置模式：

    • 開啟：true

    • 關閉：false

    false
    EnableNewArms

    boolean

    是否啟用新的 ARMS 功能：

    • true：啟用

    • false：不啟用

    false
    EnableCpuBurst

    string

    是否啟用 CPU Burst 功能：

    • true：啟用

    • false：不啟用

    true
    OidcRoleName

    string

    設定身分驗證服務 RAM 角色。

    說明

    需要提前建立同地域的 OIDC 身分供應商和身分供應商角色。具體資訊，請參見建立 OIDC 身分供應商和建立角色 SSO 身分供應商。

    sae-test
    SecretMountDesc

    array<object>

    Secret 掛載描述。

    object

    Secret 掛載描述。

    Key

    string

    對資料值進行 Base 64 編碼的 Key。

    task-center
    SecretName

    string

    Secret 執行個體名稱。

    dummy-name-opaque-894
    MountPath

    string

    掛載路徑。

    /opt/www/runtime/logs
    SecretId

    integer

    查詢的 Secret 執行個體 ID。

    520
    SidecarContainersConfig

    array<object>

    Sidecar 容器設定。

    array<object>

    Sidecar 容器設定。

    Name

    string

    容器名稱。

    test
    Cpu

    integer

    設定 Sidecar 容器可以使用主容器的 CPU 資源上限。

    500
    Memory

    integer

    設定 Sidecar 容器可以使用主容器的記憶體資源上限。

    1024
    ImageUrl

    string

    鏡像地址。

    registry.cn-beijing.aliyuncs.com/sae-dev-test/nginx:stable
    AcrInstanceId

    string

    Container Registry ACR 企業版執行個體 ID。當 ImageUrl 為 Container Registry 企業版時必填。

    cri-fhzlneorxala66ip
    Command

    string

    鏡像啟動命令。該命令必須為容器記憶體在的可執行檔對象。樣本如下：

    command:
      - echo
      - abc
      - >
      - file0

    根據上述樣本，則Command="echo", CommandArgs=["abc", ">", "file0"]。

    /bin/sh
    CommandArgs

    string

    鏡像啟動命令參數。上述啟動命令 Command 所需參數。格式如下：

    ["a","b"]

    在上述樣本中，CommandArgs=["abc", ">", "file0"]，其中["abc", ">", "file0"]需要轉成 String 類型，裡面的格式為 JSON 數組。如果無此參數，則無需填寫。

    [\"-c\",\"echo \\\"test\\\" > /home/nas/test.log && sleep 10000000s\"]
    Envs

    string

    容器環境變數參數。支援自訂或引用配置項。如需引用配置項，請先建立 ConfigMap 執行個體。更多資訊，請參見 CreateConfigMap 。取值說明如下：

    • 自訂配置

      • name：環境變數名稱。

      • value：環境變數值。優先順序高於 valueFrom。

    • 引用配置項（valueFrom）

      • name：環境變數名稱。支援引用單個或全部鍵，如果引用全部鍵，需輸入sae-sys-configmap-all-<配置項名稱>，例如sae-sys-configmap-all-test1。

      • valueFrom：環境變數引用。取值為configMapRef。

        • configMapId：配置項 ID。

        • key：鍵。如果引用全部健值，則不設定該欄位。

    [{\"name\":\"k1\",\"value\":\"c8e3a815-e5d3-4adf-abb3-98b106a607c4\"}]
    ConfigMapMountDesc

    array<object>

    ConfigMap 掛載描述。使用在命名空間配置項頁面建立的配置項來向容器中注入配置資訊。參數說明如下：

    說明

    可通過傳遞sae-sys-configmap-all參數掛載所有鍵。

    • mountPath：掛載路徑。

    • ConfigMapName：ConfigMap 名稱。

    object

    ConfigMap 掛載描述。

    Key

    string

    ConfigMap 鍵。

    key
    ConfigMapName

    string

    ConfigMap 名稱。

    ConfigMap-test
    MountPath

    string

    容器掛載路徑。

    /mnt/test
    ConfigMapId

    integer

    ConfigMap 執行個體 ID。

    7361
    EmptyDirDesc

    array<object>

    共用臨時儲存。設定臨時儲存目錄，並掛載到主容器和 Sidecar 容器。

    object

    共用臨時儲存。

    Name

    string

    臨時儲存名稱。

    sidecar-container
    MountPath

    string

    資料卷在容器內的掛載路徑。

    /mnt/cache
    SecretMountDesc

    array<object>

    Secret 掛載描述

    object

    Key

    string

    對資料值進行 Base 64 編碼的 Key。

    SecretName

    string

    Secret 執行個體名稱。

    MountPath

    string

    掛載路徑。

    SecretId

    integer

    Secret 執行個體 ID。

    Liveness

    string

    容器健全狀態檢查。

    Readiness

    string

    應用啟動狀態檢查。

    PreStop

    string

    PostStart

    string

    InitContainersConfig

    array<object>

    初始化容器設定。

    array<object>

    初始化容器設定。

    Name

    string

    初始化容器名稱。

    init-container
    ImageUrl

    string

    初始化容器使用的鏡像地址。

    registry.cn-shenzhen.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0
    Command

    string

    鏡像啟動命令。該命令必須為容器記憶體在的可執行檔對象。樣本如下：

    command:
      - echo
      - abc
      - >
      - file0

    根據上述樣本，則Command="echo", CommandArgs=["abc", ">", "file0"]。

    /bin/sh
    CommandArgs

    string

    鏡像啟動命令參數。上述啟動命令 Command 所需參數。格式如下：

    ["a","b"]

    在上述樣本中，CommandArgs=["abc", ">", "file0"]，其中["abc", ">", "file0"]需要轉成 String 類型，裡面的格式為 JSON 數組。如果無此參數，則無需填寫。

    ["a","b"]

    Envs

    string

    容器環境變數參數。支援自訂或引用配置項。如需引用配置項，請先建立 ConfigMap 執行個體。更多資訊，請參見 CreateConfigMap 。取值說明如下：

    • 自訂配置

      • name：環境變數名稱。

      • value：環境變數值。優先順序高於 valueFrom。

    • 引用配置項（valueFrom）

      • name：環境變數名稱。支援引用單個或全部鍵，如果引用全部鍵，需輸入sae-sys-configmap-all-<配置項名稱>，例如sae-sys-configmap-all-test1。

      • valueFrom：環境變數引用。取值為configMapRef。

      • configMapId：配置項 ID。

      • key：鍵。如果引用全部健值，則不設定該欄位。

    • 引用保密字典（valueFrom）

      • name：環境變數名稱。支援引用單個或全部鍵，如果引用全部鍵，需輸入sae-sys-secret-all-<保密字典名稱>，例如sae-sys-secret-all-test1。

      • valueFrom：環境變數引用。取值為secretRef。

      • secretId：保密字典 ID。

      • key：鍵。如果引用全部健值，則不設定該欄位。

    [{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}]

    ConfigMapMountDesc

    array<object>

    ConfigMap 資訊。

    object

    ConfigMap 索引值對。

    Key

    string

    ConfigMap 索引值對。

    k1

    ConfigMapName

    string

    ConfigMap 名稱。

    test

    MountPath

    string

    容器掛載路徑。

    /tmp

    ConfigMapId

    integer

    ConfigMap ID。

    1
    EmptyDirDesc

    array<object>

    共用臨時儲存。

    object

    Name

    string

    臨時儲存名稱。

    MountPath

    string

    資料卷在容器內的掛載路徑。

    SecretMountDesc

    array<object>

    Secret 掛載描述。

    object

    Key

    string

    鍵。

    SecretName

    string

    Secret 執行個體名稱。

    MountPath

    string

    掛載路徑。

    SecretId

    integer

    Secret 執行個體 ID。

    CustomImageNetworkType

    string

    自訂映像類型，如果非自訂映像，需要設定為空字串：

    • internet：公網映像

    • intranet：私網映像

    internet
    ResourceType

    string

    資源類型，僅支援 application。

    application
    BaseAppId

    string

    基線應用程式 ID。

    8c573618-8d72-4407-baf4-f7b64b******
    MicroserviceEngineConfig

    string

    設定微服務治理功能。

    • 是否開啟微服務治理（enable）：

      • ture：開啟

      • false：不開啟

    • 設定無損上下線（mseLosslessRule）：

      • delayTime：延遲事件

      • enable：是否啟用無損上線功能，ture 為開啟，false 為不開啟。

      • notice：是否啟用通知功能，ture 為啟用，false 為啟用。

      • warmupTime：小流量預熱時長，單位為秒。

    {\"Enable\":true,\"MseLosslessRule\":{\"enable\":true,\"notice\":true,\"delayTime\":10,\"warmupTime\":120,\"funcType\":2,\"aligned\":false,\"related\":false,\"lossLessDetail\":false}}
    NewSaeVersion

    string

    應用程式版本：

    • lite：輕量版

    • std：標準版

    • pro：專業版

    pro
    ClusterId

    string

    叢集 ID。

    495fc79c-ae61-4600-866d-a09d68******
    DiskSize

    integer

    磁碟儲存大小（單位 GB）。

    20
    StartupProbe

    string

    應用程式啟動偵測。

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

    GPU 數量。

    GpuType

    string

    GPU 卡型。

    EnablePrometheus

    boolean

    是否開啟 Prometheus 自訂指標採集。

    IsStateful

    boolean

    是否為有狀態應用程式。

    CmsServiceId

    string

    CloudMonitor 服務 ID。

    HeadlessPvtzDiscovery

    string

    Html

    string

    EmptyDirDesc

    array<object>

    共用臨時儲存。

    object

    共用臨時儲存設定。

    Name

    string

    臨時儲存名稱。

    MountPath

    string

    掛載路徑。

    DeploymentName

    string

    應用程式在 ASI 叢集中的執行個體名稱。 [responses.200.schema.properties.Data.properties.AlbIngressReadinessGate

    demo-b0cdce9b-3d1f-4168-b206-b59f348f1a8a
    AlbIngressReadinessGate

    string

    ALB 閘道就緒門控（ReadinessGate）設定。

    MaxSurgeInstances

    integer

    最大峰值執行個體數。

    MaxSurgeInstanceRatio

    integer

    最大峰值執行個體數比例。

    AgentVersion

    string

    Agent 版本。

    EnableNamespaceAgentVersion

    boolean

    是否複用命名空間 Agent 版本設定。

    SlsLogEnvTags

    string

    sls log env tags

    LokiConfigs

    string

    LokiConfigs

    IdleHour

    string

    Labels

    object

    标签。

    string

    RaspConfig

    array<object>

    object

    EnableRasp

    boolean

    RaspAppName

    string

    RaspAppKey

    string

    ErrorCode

    string

    错误码。取值说明如下：

    • 请求成功：不返回 ErrorCode 字段。

    • 请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码列表。

    Code

    string

    接口状态或 POP 错误码。取值说明如下：

    • 2xx：成功。

    • 3xx：重定向。

    • 4xx：请求错误。

    • 5xx：服务器错误。

    200
    Success

    boolean

    获取应用配置信息是否成功。取值说明如下：

    • true：获取成功。

    • false：获取失败。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "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 status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidApplication.NotFound The current application does not exist.
    404 InvalidAppId.NotFound The specified AppId does not exist.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。