調用ListJobs API擷取工作範本列表-Serverless 應用引擎-阿里雲 - Serverless App Engine

調用ListJobs介面擷取工作範本列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

sae:ListJobs

list

*全部資源

*

無

請求文法

GET /pop/v1/sam/job/listJobs HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
CurrentPage	integer	否	當前頁數。取值從 1 開始。	1
PageSize	integer	否	頁面大小。取值範圍為[0,200]。	20
AppName	string	否	工作範本名稱。	demo-app
NamespaceId	string	否	命名空間 ID。	cn-beijing:demo
Tags	string	否	標籤列表，JSON 字串。取值說明如下： key：標籤鍵。 value：標籤值。	[{"key":"key","value":"value"}]
OrderBy	string	否	對工作範本進行排序。取值說明如下： running：按照當前執行個體數進行排序。 instances：按照目標執行個體數進行排序。	running
Reverse	boolean	否	根據 OrderBy 參數傳入的欄位名排序。取值說明如下： true：按升序排序。 false：按降序排序。	true
FieldType	string	否	設定篩選工作範本的維度。取值說明如下： appName：工作範本名稱。 appIds：工作範本 ID。	appName
FieldValue	string	否	根據已設定的 FieldType 篩選維度，選擇輸入目標工作範本的工作範本名稱或工作範本 ID。	demo-app
Workload	string	否	Workload 需指定為`job`。	job

返回參數

名稱	類型	描述	樣本值
	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
AppId	string	工作範本 ID。	f7730764-d88f-4b9a-8d8e-cd8efbfe****
Tags	array<object>	工作範本標籤。
	object	工作範本標籤詳細資料。
Key	string	標籤鍵。	key
Value	string	標籤值。	value
RegionId	string	地區 ID。	cn-beijing
AppDescription	string	工作範本描述資訊。	description
TriggerConfig	string	任務觸發配置，根據任務類型進行配置。定時任務：type 欄位設為 time，config 欄位為具體 Cron 運算式，timezone 欄位為指定時區。配置樣本：`{"type":"time","config":"0 1 /1 ?","timezone":"GMT+8:00"}` 一次性任務：type 欄位設為 http，config 配置具體的 HTTP 觸發規則。更多資訊，請參見請求參數 SourceHttpEventParameters。配置樣本：`{"type":"http","config":{"type":"HTTPS","method"、["GET"],"ip":[],"referer":[],"securityConfig":"none"}}`	{"type":"time","config":"0 1 /1 ?","timezone":"GMT+8:00"}
Suspend	boolean	是否暫停工作範本。	false
Active	integer	正在啟動並執行執行個體數。	0
Succeeded	integer	運行成功的執行個體數。	3
Failed	integer	運行失敗的執行個體數。	0
LastStartTime	integer	上一次任務啟動時間。	1657522800
CompletionTime	integer	上一次任務完成時間。	1657522839
LastChangeorderState	string	上一次發布單執行是否成功，取值說明如下： 0：發布單執行失敗。 1：發布單執行成功。	1
LastJobState	string	上一次任務的運行狀態。取值說明如下： 0：未執行。 1：執行成功。 2：執行失敗。 3：正在執行。	0
Cpu	integer	每個執行個體所需的 CPU，單位為毫核，不能為 0。目前僅支援以下固定規格： 500 1000 2000 4000 8000 16000 32000	500
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
Message	string	調用結果的附加資訊。	success
ImageUrl	string	鏡像地址。
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",
        "AppId": "f7730764-d88f-4b9a-8d8e-cd8efbfe****",
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "RegionId": "cn-beijing",
        "AppDescription": "description",
        "TriggerConfig": "{\"type\":\"time\",\"config\":\"0 1 */1 * ?\",\"timezone\":\"GMT+8:00\"}",
        "Suspend": false,
        "Active": 0,
        "Succeeded": 3,
        "Failed": 0,
        "LastStartTime": 1657522800,
        "CompletionTime": 1657522839,
        "LastChangeorderState": "1",
        "LastJobState": "0",
        "Cpu": 500,
        "Mem": 1024,
        "Message": "success",
        "ImageUrl": ""
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true,
  "CurrentPage": 1,
  "TotalSize": 2,
  "PageSize": 20
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
404	InvalidAppId.NotFound	The specified AppId does not exist.	指定的AppId不存在。

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

變更歷史

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