調用ListApplications API擷取應用列表-Serverless 應用引擎-阿里雲 - Serverless App Engine

取得應用程式清單。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sae:ListApplications

get

*All Resource

*

無

請求文法

GET /pop/v1/sam/app/listApplications HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
CurrentPage	integer	否	目前頁數。	1
PageSize	integer	否	分頁查詢時取得的每頁數量。取值範圍[0,10000]。	20
AppName	string	否	應用程式名稱。	demo-app
NamespaceId	string	否	命名空間 ID。	cn-beijing:demo
Tags	string	否	標籤鍵值對。取值說明如下： key：標籤鍵，長度範圍[1,128]。 value：標籤值，長度範圍[1,128]。區分大小寫。如果指定多個標籤，則會為指定資源同時建立並綁定多個標籤。同一個資源上的同一個標籤鍵只能對應一個標籤值。如果您嘗試新增已有標籤鍵，則對應的標籤值會更新為新值。不能以 `aliyun` 和 `acs:` 開頭，不能包含 `http://` 或者 `https://`。	[{"key":"key","value":"value"}]
OrderBy	string	否	對應用程式進行排序。取值說明如下： runnings：按照目前執行個體數進行排序。 instances：按照目標執行個體數進行排序。	runnings
Reverse	boolean	否	根據應用程式執行個體運作狀態對其進行排序。如果狀態相同，則按照執行個體 ID 排序。取值說明如下： true：按升序排序。表示根據啟動執行個體的步驟來排列，例如執行個體最終想要變更為運作狀態，需先經過啟動容器、拉取映像、初始化執行個體等步驟。 false：按降序排序。執行個體升序排列如下： Error：執行個體啟動過程中出錯。 CrashLoopBackOff：容器無法啟動，在啟動過程中出錯，重新啟動後又出錯。 ErrImagePull：拉取執行個體中的容器映像出錯。 ImagePullBackOff：無法獲取容器映像。 Pending：執行個體等待排程中。 Unknown：未知異常。 Terminating：執行個體終止接入中。 NotFound：無法找到執行個體。 PodInitializing：執行個體初始化中。 Init:0/1：執行個體初始化。 Running：執行個體運作中。	true
FieldType	string	否	設定篩選應用程式的維度。取值說明如下： appName：應用程式名稱。 appIds：應用程式 ID。 slbIps：SLB IP 位址。 instanceIps：執行個體 IP 位址。	appName
FieldValue	string	否	輸入目標應用程式的應用程式名稱、應用程式 ID、SLB IP 位址或執行個體 IP 位址。	demo-app
AppSource	string	否	SAE 應用程式類型。 micro_service。 web。 job。	micro_service
IsStateful	string	否	是否為有狀態應用程式。
NewSaeVersion	string	否	應用程式版本： lite：輕量版 std：標準版 pro：專業版

返回參數

名稱	類型	描述	樣本值
	object	返回資料。
Message	string	呼叫結果的附加資訊。	success
RequestId	string	請求 ID。	B4D805CA-926D-41B1-8E63-7AD0C1ED****
Data	object	應用程式清單。
CurrentPage	integer	目前頁數。	1
TotalSize	integer	應用程式總個數。	2
PageSize	integer	頁面大小。	20
Applications	array<object>	應用程式清單。
	array<object>	應用程式清單資訊。
AppName	string	應用程式名稱。	demo-app
NamespaceId	string	命名空間 ID。	cn-beijing:demo
AppDeletingStatus	boolean	是否正在刪除應用。取值說明如下： true：應用正在被刪除。 false：應用沒有被刪除。	false
AppId	string	應用 ID。	f7730764-d88f-4b9a-8d8e-cd8efbfe****
Tags	array<object>	應用標籤。
	object	應用標籤資訊。
Key	string	標籤鍵。	key
Value	string	標籤值。	value
RunningInstances	integer	運行中的執行個體個數。	2
Instances	integer	應用執行個體個數。	2
RegionId	string	地區 ID。	cn-beijing
AppDescription	string	應用描述資訊。	description
Cpu	integer	每個執行個體所需的 CPU，單位為毫核，不能為 0。目前僅支援以下固定規格： 500 1000 2000 4000 8000 16000 32000	1000
Mem	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 毫核。	1024
MseEnabled	boolean	該應用是否已啟用 MSE 微服務治理	true
MseNamespaceId	string	MSE 微服務治理命名空間 default：免費版 sae-pro：專業版 sae-ent：企業版	sae-ent
BaseAppId	string	Base 應用 ID，僅灰階應用存在此屬性	xxx-xxx-xx-xxx
ProgrammingLanguage	string	應用的程式設計語言	java
Children	array<object>	該應用的灰階應用列表
	array<object>	詳細資料。
AppName	string	應用程式名稱。	app1
NamespaceId	string	命名空間 ID。	cn-beijing:demo
AppDeletingStatus	boolean	是否正在刪除該應用。	false
AppId	string	應用 ID。	xxx-xxx-xxx-xxx
ScaleRuleEnabled	boolean	是否開啟 Auto Scaling 策略。	false
ScaleRuleType	string	彈性規則的類型	timing
Tags	array<object>	應用標籤。
	object	應用標籤。
Key	string	標籤鍵。	key
Value	string	標籤值。	value
RunningInstances	integer	運行中的執行個體個數。	2
Instances	integer	執行個體個數。	2
RegionId	string	地區 ID。	cn-beijing
AppDescription	string	應用描述資訊。	Test application
Cpu	integer	CPU 大小。	2000
Mem	integer	記憶體大小。	2048
MseEnabled	boolean	該應用是否已啟用 MSE 微服務治理。	true
BaseAppId	string	基礎應用 ID。	ee99cce6-1c8e-4bfa-96c3-3e2fa9******
ProgrammingLanguage	string	應用所用的語言。	java
AppType	string	應用部署的方式。	Image
NamespaceName	string	命名空間名稱	demo
IsStateful	boolean	是否為有狀態應用。
NewSaeVersion	string	應用版本： lite：輕量版 std：標準版 pro：專業版	pro
ResourceType	string	資源類型。
EnableIdle	string	是否開啟閑置。
ImageUrl	string	鏡像地址。	registry.cn-hangzhou.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0
PackageUrl	string	部署套件地址。	https://sae-oss-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/apps/K8S_APP_ID/1421801774382676/adf2624a-66fd-4a2b-8caa-6921da******/hello-sae.jar
AppType	string	應用部署的方式。	Image
NamespaceName	string	命名空間名稱。	demo
IsStateful	boolean	是否為有狀態應用。
NewSaeVersion	string	應用版本： lite：輕量版 std：標準版 pro：專業版	pro
EnableIdle	string	是否開啟閑置。	false
DiskSize	integer	磁碟儲存大小（單位 GB）。	20
VpcId	string	VPC ID。
ResourceType	string	資源類型。
Labels	object	標籤。
	string
RaspEnabled	boolean
ErrorCode	string	錯誤碼。取值說明如下：請求成功：不返回 ErrorCode 欄位。請求失敗：返回 ErrorCode 欄位。具體資訊，請參見本文的錯誤碼目錄。
Code	string	介面狀態或 POP 錯誤碼。取值說明如下： 2xx：成功。 3xx：重新導向。 4xx：請求錯誤。 5xx：伺服器錯誤。	200
Success	boolean	取得應用程式清單。取值說明如下： true：取得成功。 false：取得失敗。	true
CurrentPage	integer	目前頁數。	1
TotalSize	integer	應用程式總個數。	2
PageSize	integer	頁面大小。	20

樣本

正常返回樣本

JSON格式

{
  "Message": "success",
  "RequestId": "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 2,
    "PageSize": 20,
    "Applications": [
      {
        "AppName": "demo-app",
        "NamespaceId": "cn-beijing:demo",
        "AppDeletingStatus": false,
        "AppId": "f7730764-d88f-4b9a-8d8e-cd8efbfe****",
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "RunningInstances": 2,
        "Instances": 2,
        "RegionId": "cn-beijing",
        "AppDescription": "description",
        "Cpu": 1000,
        "Mem": 1024,
        "MseEnabled": true,
        "MseNamespaceId": "sae-ent",
        "BaseAppId": "xxx-xxx-xx-xxx",
        "ProgrammingLanguage": "java",
        "Children": [
          {
            "AppName": "app1",
            "NamespaceId": "cn-beijing:demo",
            "AppDeletingStatus": false,
            "AppId": "xxx-xxx-xxx-xxx",
            "ScaleRuleEnabled": false,
            "ScaleRuleType": "timing",
            "Tags": [
              {
                "Key": "key",
                "Value": "value"
              }
            ],
            "RunningInstances": 2,
            "Instances": 2,
            "RegionId": "cn-beijing",
            "AppDescription": "Test application",
            "Cpu": 2000,
            "Mem": 2048,
            "MseEnabled": true,
            "BaseAppId": " ee99cce6-1c8e-4bfa-96c3-3e2fa9******",
            "ProgrammingLanguage": "java",
            "AppType": "Image",
            "NamespaceName": "demo",
            "IsStateful": false,
            "NewSaeVersion": "pro",
            "ResourceType": "",
            "EnableIdle": ""
          }
        ],
        "ImageUrl": "registry.cn-hangzhou.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0",
        "PackageUrl": "https://sae-oss-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/apps/K8S_APP_ID/1421801774382676/adf2624a-66fd-4a2b-8caa-6921da******/hello-sae.jar",
        "AppType": "Image",
        "NamespaceName": "demo",
        "IsStateful": false,
        "NewSaeVersion": "pro",
        "EnableIdle": "false",
        "DiskSize": 20,
        "VpcId": "",
        "ResourceType": "",
        "Labels": {
          "key": ""
        },
        "RaspEnabled": false
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true,
  "CurrentPage": 1,
  "TotalSize": 2,
  "PageSize": 20
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Illegal.argument	Illegal argument

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

變更歷史

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