Updated on 2022-02-22 GMT+08:00

Querying the Job List

Function

After the ID of an asynchronous job is returned, if the job ID at the service layer is lost and cannot be obtained through the API, a new API is provided to query all asynchronous jobs stored in the engine. The job ID, job status, and original request of each job are returned.

URI

  • URI format
    GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/status?limit={limit}&offset={offset}
  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.

    offset

    No

    Integer

    Offset of a query. The default value is 0.

    job_id

    Yes

    String

    ID of the job corresponding to the response

    limit

    No

    Integer

    Maximum number of records that can be queried. The default value is 100000.

Request

  • Request example
    GET /ges/v1.0/1/graphs/movie/jobs/status

Response

Table 2 Parameters

Parameter

Mandatory

Type

Description

errorMessage

No

String

System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.

errorCode

No

String

System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.

result

Yes

String

Query result. If the query is successful, the value is success. If the query fails, the value is failed.

jobs

No

Json

Job status list stored in the system. If execution succeeds, this parameter is contained in the response. The following table describes the structure of a single jobs field.

Table 3 Job status structure

Parameter

Mandatory

Type

Description

jobId

Yes

String

JobId

request

Yes

Json

Request content, including the command, URL, and body.

status

Yes

String

Job status. The value can be pending, running, or complete.

Return Value

  • Normal

    200

  • Abnormal
    Table 4 Return code for failed requests

    Return Value

    Description

    400 Bad Request

    Request error.

    401 Unauthorized

    Authentication failed.

    403 Forbidden

    No operation permission.

    404 Not Found

    No resources found.

    500 Internal Server Error

    Internal service error.

    503 Service Unavailable

    Service unavailable.