全部產品
Search

搜尋本產品

    Edge Security Acceleration：ListEdgeContainerApps - 擷取邊緣容器應用列表

    文件中心

    Edge Security Acceleration：ListEdgeContainerApps - 擷取邊緣容器應用列表

    更新時間：Mar 20, 2026

    擷取邊緣容器應用列表，包括使用者該帳號下建立的所有邊緣應用。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    esa:ListEdgeContainerApps

    none

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    PageNumber

    integer

    否

    當前頁碼。預設值：1，取值範圍：1~65535。

    1
    PageSize

    integer

    否

    每頁大小。預設為：20，取值範圍：1~500。

    20
    OrderKey

    string

    否

    排序欄位，不傳則預設為空白。取值：

    • Name：版本名稱。

    • CreateTime：版本建立時間。

    • ModifyTime：版本修改時間。

    CreateTime
    OrderType

    string

    否

    排序方向，不傳則預設為空白。取值：

    • Asc：升序排列。

    • Desc：降序排列。

    Asc

    SearchType

    string

    否

    模糊尋找的類型，取值：

    • AppId：應用 ID。

    • Name：應用程式名稱。

    AppId
    SearchKey

    string

    否

    搜尋關鍵詞。

    ver-1005682639679266816

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    2430E05E-1340-5773-B5E1-B743929F46F2
    PageNumber

    integer

    當前頁碼。預設值;1，取值範圍：1~65535。

    1
    PageSize

    integer

    整頁大小。取值範圍：1~500。

    10
    TotalCount

    integer

    總條數。

    10
    Apps

    array<object>

    應用數組

    array<object>

    描述應用的對象。

    Status

    string

    應用的狀態資訊，取值：

    • creating：建立中

    • failed：建立失敗

    • created：建立成功

    created
    GatewayType

    string

    網關類型， 可能值：

    • l7：七層網關

    • l4：四層網關

    l7
    CreateTime

    string

    建立時間。

    2022-12-01T16:16:27.418298794+08:00
    VersionCount

    integer

    應用版本數量。

    10
    DomainName

    string

    App 所綁定的網域名稱。

    test.com
    Remarks

    string

    備忘資訊。

    test app
    ServicePort

    integer

    服務端連接埠號碼。範圍：1~65535。

    80
    AppId

    string

    應用 ID。

    app-88068867578379****
    TargetPort

    integer

    後端連接埠，也是應用的服務連接埠。範圍：1~65535。

    80
    QuicCid

    string

    是否開啟 quic 支援。

    false
    Name

    string

    應用程式名稱。

    app-test
    UpdateTime

    string

    應用的上次修改時間。日期格式按照 ISO8601 標記法，並使用 UTC 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。

    2023-11-15T12:11:02Z
    HealthCheck

    object

    表示健全狀態檢查資訊的對象。

    Timeout

    integer

    應用健全狀態檢查逾時時間，單位為秒。

    60
    Type

    string

    健全狀態檢查類型，取值：

    • l7：七層健全狀態檢查探測。

    • l4：四層健全狀態檢查探測。

    l7
    Host

    string

    健全狀態檢查的網域名稱。

    test.com
    Interval

    integer

    應用健全狀態檢查的間隔時間，單位秒。

    5
    SuccTimes

    integer

    應用的健全狀態檢查連續成功次數。

    1
    Method

    string

    應用的健全狀態檢查的方法。

    GET
    HttpCode

    string

    應用的健全狀態檢查成功的狀態代碼範圍。

    http_2XX
    FailTimes

    integer

    應用的健全狀態檢查連續失敗次數。

    5
    Port

    integer

    應用的健全狀態檢查連接埠。

    8080
    Uri

    string

    應用的健全狀態檢查的路徑。

    /health_check
    Percentage

    integer

    建立進度百分比。

    100

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "2430E05E-1340-5773-B5E1-B743929F46F2",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 10,
  "Apps": [
    {
      "Status": "created",
      "GatewayType": "l7",
      "CreateTime": "2022-12-01T16:16:27.418298794+08:00",
      "VersionCount": 10,
      "DomainName": "test.com",
      "Remarks": "test app",
      "ServicePort": 80,
      "AppId": "app-88068867578379****",
      "TargetPort": 80,
      "QuicCid": "false",
      "Name": "app-test",
      "UpdateTime": "2023-11-15T12:11:02Z",
      "HealthCheck": {
        "Timeout": 60,
        "Type": "l7",
        "Host": "test.com",
        "Interval": 5,
        "SuccTimes": 1,
        "Method": "GET",
        "HttpCode": "http_2XX",
        "FailTimes": 5,
        "Port": 8080,
        "Uri": "/health_check"
      },
      "Percentage": 100
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParameter.OrderType The specified OrderType is invalid. Please check the OrderType parameter. You may not have set it to either Asc or Desc. Please make the necessary changes and call the interface again. OrderType參數無效。請檢查OrderType參數，你有可能未設定為 Asc、Desc其中一種，請進行修改後，重新調用介面。
    400 InvalidParameter.OrderKey The specified OrderKey is invalid. Please check the OrderKey parameter. OrderKey參數無效。請檢查OrderKey參數，該參數不能賦值為非法字元如 @、#、% 等，請進行修改後，重新調用介面。
    400 InvalidParameter Invalid parameter. Check the parameter configuration. 參數正確性校正失敗，請檢查的參數內容。
    400 InvalidParameter.PageNumber Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer. 參數 PageNumber 校正不通過。請仔細檢查請求參數是否存在且為正整數。
    400 InvalidParameter.appid The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID. 傳入的應用ID格式不正確，可使用ListEdgeContainerApps介面擷取應用ID。
    400 InvalidPageSize.ValueNotSupported The PageSize value is invalid. The default value is set to 20. The acceptable range is between 1 and 500. 請求PageSize值非法，預設取值為20，取值區間為1-500。
    500 InternalError Failed to call the service. Try again later or contact technical support. 調用服務失敗，請稍後重試或聯絡客服諮詢詳情。
    404 InvalidApp.NotFound The application does not exist. Check whether the application ID you specified is correct and try again. 您傳入的應用ID對應的應用不存在，請檢查後重試。

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

    變更歷史

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