Help Center/ Graph Engine Service/ API Reference (ME-Abu Dhabi Region)/ Management Plane APIs/ Task Center APIs/ Querying Job Details in the Job Center
Updated on 2022-02-22 GMT+08:00
View PDF
Share

Querying Job Details in the Job Center

Function

This API is used to query asynchronous job details in the job center on the management plane. Asynchronous jobs include creating, closing, starting, deleting, adding, importing, exporting, and upgrading graphs, as well as adding backups.

URI

GET /v1.0/{project_id}/graphs/jobs

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

endTime

No

String

Job end date. Currently, only the date is supported. The format is yyyy-MM-dd, for example, 2019-03-27.

graph_name

No

String

Associated graph name

limit

No

String

Maximum number of resources displayed on a single page. The default value is 10.

offset

No

String

Start position of the request. The default value is 0.

startTime

No

String

Job start date. Currently, only the date is supported. The format is yyyy-MM-dd, for example, 2019-03-27.

status

No

String

Job status. Possible values:

  • running
  • waiting
  • success
  • failed

Request Parameters

Table 3 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

errorMessage

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

String

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

jobCount

Integer

Total number of jobs

jobList

Array of Job objects

Task list
Table 5 Job

Parameter

Type

Description

jobId

String

Job ID

status

String

Job status.

  • pending
  • running
  • success
  • failed

jobType

String

Task type

jobName

String

Task name

relatedGraph

String

Associated graph name

beginTime

String

Job start time (UTC). The format is yyyy-MM-dd'T'HH:mm:ss.

endTime

String

Job end time (UTC). The format is yyyy-MM-dd'T'HH:mm:ss.

jobDetail

JobDetail object

This parameter is returned only when jobName is set to ImportGraph and is used to display graph import details.

failReason

String

Job failure cause

jobProgress

Double

Job execution progress. It is a reserved field, and not used currently.
Table 6 JobDetail

Parameter

Type

Description

schemaPath

Array of schemaPath objects

Path for storing metadata

edgesetPath

Array of edgesetPath objects

Path for storing the edge data set

vertexsetPath

Array of vertexsetPath objects

Path for storing the vertex data set
Table 7 schemaPath

Parameter

Type

Description

path

String

OBS storage path

log

String

Import log

status

String

OBS file status:

  • success: Imported successfully.
  • Failed: Failed to import the file.
  • partFailed: Partially failed.

cause

String

Import failure cause
Table 8 edgesetPath

Parameter

Type

Description

path

String

OBS storage path

log

String

Import log

status

String

OBS file status:

  • success: Imported successfully.
  • Failed: Failed to import the file.
  • partFailed: Partially failed.

cause

String

Import failure cause

totalLines

Long

Total number of imported lines. The value -1 indicates that this field is not returned in the current version.

failedLines

Long

Lines failed to be imported. The value -1 indicates that this field is not returned in the current version.

successfulLines

Long

Lines imported successfully. The value -1 indicates that this field is not returned in the current version.
Table 9 vertexsetPath

Parameter

Type

Description

path

String

OBS storage path

log

String

Import log

status

String

OBS file status:

  • success: Imported successfully.
  • Failed: Failed to import the file.
  • partFailed: Partially failed.

cause

String

Import failure cause

totalLines

Long

Total number of imported lines. The value -1 indicates that this field is not returned in the current version.

failedLines

Long

Lines failed to be imported. The value -1 indicates that this field is not returned in the current version.

successfulLines

Long

Lines imported successfully. The value -1 indicates that this field is not returned in the current version.

Example Request

GET    https://Endpoint/v1.0/{project_id}/graphs/jobs?offset=0&limit=100

Example Response

Example response with status code 200:

OK

Http Status Code: 200
{  
"jobCount": 136,
"jobList": [
 {
      "jobId": "ff80808167bb90340167bc3c7b5b026a",
      "status": "success",
      "jobType": "GraphManagement",
      "jobName": "ImportGraph",
      "relatedGraph": "test1217",
      "beginTime": "2018-12-17T12:55:40",
      "endTime": "2018-12-17T12:56:32",
      "jobDetail": {
        "vertexsetPath": null,
        "edgesetPath": [
          {
            "path": "hkmovie/edge.csv",
            "log": null,
            "cause": null,
            "status": "success"
          }
        ],
        "schemaPath": [
          {
            "path": "hkmovie/schema.xml",
            "log": null,
            "cause": null,
            "status": "success"
          }
        ]
      },
      "jobProgress": 0
    },
    {
      "jobId": "ff80808167bb90340167bc5d0b1d0358",
      "status": "success",
      "jobType": "GraphManagement",
      "jobName": "DeleteGraph",
      "relatedGraph": "test1218",
      "beginTime": "2018-12-17T13:31:14",
      "endTime": "2018-12-17T13:34:48",
      "jobProgress": 0
    }
]
}

Status code: 400

Bad Request

{
  "errorMessage" : "failed",
  "errorCode" : "GES.9999"
}

Status Code

Status Code

Description

200

OK

400

Bad Request
Parent topic: Task Center APIs