全部產品
Search
文件中心

Serverless App Engine:DescribeJobStatus - DescribeJobStatus

更新時間:Apr 23, 2026

調用DescribeJobStatus介面查詢任務狀態。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

sae:DescribeJobStatus

*全部資源

*

請求文法

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

請求參數

名稱

類型

必填

描述

樣本值

AppId

string

工作範本 ID。

e1a7a07-abcb-4652-a1d3-2d57f415****

JobId

string

任務 ID。

event-b798157b-40a2-4388-b578-71fb897103**-**

返回參數

名稱

類型

描述

樣本值

object

返回資料。

RequestId

string

請求 ID。

53F15A18-8079-5992-810C-0211A5AE****

Message

string

附加資訊。取值說明如下:

  • 請求正常,返回 success

  • 請求異常,返回具體異常錯誤碼。

success

TraceId

string

調用鏈 ID,用於精確查詢調用資訊。

0b1639af16575057857241351e****

Data

object

返回資料。

JobId

string

任務 ID。

event-b798157b-40a2-4388-b578-71fb897103**-**

Active

integer

正在啟動並執行執行個體數。

0

Succeeded

integer

運行成功的執行個體數。

3

Failed

integer

運行失敗的執行個體數。

0

StartTime

integer

任務的建立時間。

1657522800

CompletionTime

integer

任務執行的完成時間。

1657522839

Message

string

附加資訊。取值說明如下:

  • 請求正常,返回 success

  • 請求異常,返回具體異常錯誤碼。

success

State

string

任務的運行狀態。取值說明如下:

  • 0:未執行。

  • 1:執行成功。

  • 2:執行失敗。

  • 3:正在執行。

1

ErrorCode

string

錯誤碼。取值說明如下:

  • 請求成功:不返回 ErrorCode 欄位。

  • 請求失敗:返回 ErrorCode 欄位。具體資訊,請參見本文的錯誤碼目錄。

Code

string

介面狀態或 POP 錯誤碼。取值說明如下:

  • 2xx:成功。

  • 3xx:重新導向。

  • 4xx:請求錯誤。

  • 5xx:伺服器錯誤。

200

Success

boolean

查詢任務狀態是否成功。取值說明如下:

  • true:查詢成功。

  • false:查詢失敗。

true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "53F15A18-8079-5992-810C-0211A5AE****",
  "Message": "success",
  "TraceId": "0b1639af16575057857241351e****",
  "Data": {
    "JobId": "event-b798157b-40a2-4388-b578-71fb897103**-**",
    "Active": 0,
    "Succeeded": 3,
    "Failed": 0,
    "StartTime": 1657522800,
    "CompletionTime": 1657522839,
    "Message": "success",
    "State": "1"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

404 InvalidAppId.NotFound The specified AppId does not exist. 指定的AppId不存在。

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

變更歷史

更多資訊,參考變更詳情