All Products
Search
Document Center

Serverless App Engine:DescribeJobHistory

Last Updated:Dec 26, 2025

Query the information about jobs.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
sae:DescribeJobHistory
*All Resources
*
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the job template.

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

The number of the page to return.

1
PageSizelongNo

The number of entries to return on each page. Valid values: 0 to 10000.

20
StatestringNo

The status of the job. Valid values:

  • 0: The job is not executed.
  • 1: The job is executed.
  • 2: The job fails to be executed.
  • 3: The job is being executed.
1

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The request ID.

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

The message returned. Take note of the following rules:

  • If the call is successful, success is returned.
  • If the call fails, an error code is returned.
success
TraceIdstring

The trace ID that is used to query the details of the request.

0b1639af16575057857241351e****
Dataobject

The returned data.

CurrentPagelong

The page number of the returned page.

1
TotalSizelong

The total number of jobs.

20
PageSizelong

The number of entries to return on each page. Valid values: 0 to 10000.

20
Jobsarray<object>

The jobs.

jobobject
JobIdstring

The job ID.

manual-3db7a8fa-5d40-4edc-92e4-49d50eab****
Activelong

The number of running instances.

0
Succeededlong

The number of instances that are successfully run.

3
Failedlong

The number of instances that failed to run.

0
StartTimelong

The time when the job was created.

1657522800
CompletionTimelong

The time when the job was executed.

1657522839
Messagestring

The message returned if exceptions occur during job running.

Null
Statestring

The status of the job. Valid values:

  • 0: The job was not executed.
  • 1: The job was executed.
  • 2: The job failed to be executed.
  • 3: The job is being executed.
1
ErrorCodestring

The error code returned. Take note of the following rules:

  • If the call is successful, the ErrorCode parameter is not returned.
  • If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section in this topic.
Null
Codestring

The HTTP status code returned. Valid values:

  • 2xx: The call was successful.
  • 3xx: The call was redirected.
  • 4xx: The call failed.
  • 5xx: A server error occurred.
200
Successboolean

Indicates whether the call was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "53F15A18-8079-5992-810C-0211A5AE****",
  "Message": "success",
  "TraceId": "0b1639af16575057857241351e****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 20,
    "PageSize": 20,
    "Jobs": [
      {
        "JobId": "manual-3db7a8fa-5d40-4edc-92e4-49d50eab****",
        "Active": 0,
        "Succeeded": 3,
        "Failed": 0,
        "StartTime": 1657522800,
        "CompletionTime": 1657522839,
        "Message": "Null\n",
        "State": 1
      }
    ]
  },
  "ErrorCode": "Null\n",
  "Code": 200,
  "Success": true
}

Error codes

HTTP status codeError codeError message
404InvalidAppId.NotFoundThe specified AppId does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history