Querying Job Details in the Job Center (1.1.8)

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 /v2/{project_id}/graphs/jobs

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints N/A Range The value can contain up to 64 characters. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
end_time	No	String	Definition Job end date. Only dates are currently supported. The format is yyyy-MM-dd, for example, 2019-03-27. Constraints N/A Range N/A Default Value N/A
graph_name	No	String	Definition Associated graph name Constraints N/A Range N/A Default Value N/A
limit	No	Integer	Definition Maximum number of resources displayed on a single page. The default value is 10. Constraints N/A Range N/A Default Value N/A
offset	No	Integer	Definition Start position of the request. The default value is 0. Constraints N/A Range N/A Default Value N/A
start_time	No	String	Definition Job start date. Only dates are currently supported. The format is yyyy-MM-dd, for example, 2019-03-27. Constraints N/A Range The value can contain up to 64 characters. Only letters and digits are allowed. Default Value N/A
status	No	String	Definition Job status. Constraints N/A Range running waiting success partiallyFailed failed Default Value N/A

Request Parameters

**Table 3** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It is used to obtain the permission to call APIs. For how to obtain the token, see Authentication. (The token is the value of X-Subject-Token in the response header.) Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
job_count	Integer	Definition Total number of jobs. Range N/A
job_list	Array of job_list objects	Definition Job list. Range N/A

**Table 5** job_list
Parameter	Type	Description
job_id	String	Definition Job ID. Range N/A
status	String	Definition Job status. Range pending running success partiallyFailed failed
job_type	String	Definition Job type. Range N/A
job_name	String	Definition Job name. Range N/A
related_graph	String	Definition Associated graph name. Range N/A
begin_time	String	Definition Job start time, in UTC format yyyy-MM-dd HH:mm:ss. Range N/A
end_time	String	Definition Job end time (UTC), in UTC format yyyy-MM-dd HH:mm:ss. Range N/A
job_detail	job_detail object	Definition This parameter is returned only when job_name is set to ImportGraph and is used to display graph import details. Range N/A
fail_reason	String	Definition Job failure cause. Range N/A
job_progress	Double	Definition Job execution progress. This parameter is reserved and is not currently used. Range N/A

**Table 6** job_detail
Parameter	Type	Description
schema_path	Array of schema_path objects	Definition Metadata file path. Range N/A
edgeset_path	Array of edgeset_path objects	Definition Path for storing edge datasets. Range N/A
vertexset_path	Array of vertexset_path objects	Definition Path for storing vertex datasets. Range N/A

**Table 7** schema_path
Parameter	Type	Description
path	String	Definition OBS path. Range N/A
log	String	Definition Import log. Range N/A
status	String	Definition OBS file status. Range success failed partFailed
cause	String	Definition Import failure cause. Range N/A
total_lines	Long	Definition Total number of imported lines. The value -1 indicates that this parameter is not returned in the current version. Range N/A
failed_lines	Long	Definition Number of lines that failed to import. The value -1 indicates that this parameter is not returned in the current version. Range N/A
successful_lines	Long	Definition Number of lines that are successfully imported. The value -1 indicates that this parameter is not returned in the current version. Range N/A

**Table 8** edgeset_path
Parameter	Type	Description
path	String	Definition OBS path. Range N/A
log	String	Definition Import log. Range N/A
status	String	Definition OBS file import status. Range success failed partFailed
cause	String	Definition Import failure cause. Range N/A
total_lines	Long	Definition Total number of imported lines. The value -1 indicates that this parameter is not returned in the current version. Range N/A
failed_lines	Long	Definition Number of lines that failed to import. The value -1 indicates that this parameter is not returned in the current version. Range N/A
successful_lines	Long	Definition Number of lines that are successfully imported. The value -1 indicates that this parameter is not returned in the current version. Range N/A

**Table 9** vertexset_path
Parameter	Type	Description
path	String	Definition OBS path. Range N/A
log	String	Definition Import log. Range N/A
status	String	Definition OBS file import status. Range success failed partFailed
cause	String	Definition Import failure cause. Range N/A
total_lines	Long	Definition Total number of imported lines. The value -1 indicates that this parameter is not returned in the current version. Range N/A
failed_lines	Long	Definition Number of lines that failed to import. The value -1 indicates that this parameter is not returned in the current version. Range N/A
successful_lines	Long	Definition Number of lines that are successfully imported. The value -1 indicates that this parameter is not returned in the current version. Range N/A

Status code: 400

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Definition System prompt. If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error code. Range N/A
error_msg	String	Definition System prompt. If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error message. Range N/A

Example Request

Query asynchronous job details in the job center on the management plane.

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

Example Response

Status code: 200

Example response for a successful request

{
  "job_count" : 2,
  "job_list" : [ {
    "job_id" : "ff80808167bb90340167bc3c7b5b026a",
    "status" : "success",
    "job_type" : "GraphManagement",
    "job_name" : "ImportGraph",
    "related_graph" : "test1217",
    "begin_time" : "2018-12-17T12:55:40",
    "end_time" : "2018-12-17T12:56:32",
    "job_detail" : {
      "vertexset_path" : null,
      "edgeset_path" : [ {
        "path" : "hkmovie/edge.csv",
        "log" : null,
        "cause" : null,
        "status" : "success"
      } ],
      "schema_path" : [ {
        "path" : "hkmovie/schema.xml",
        "log" : null,
        "cause" : null,
        "status" : "success"
      } ]
    },
    "job_progress" : 0
  }, {
    "job_id" : "ff80808167bb90340167bc5d0b1d0358",
    "status" : "success",
    "job_type" : "GraphManagement",
    "job_name" : "DeleteGraph",
    "related_graph" : "test1218",
    "begin_time" : "2018-12-17T13:31:14",
    "end_time" : "2018-12-17T13:34:48",
    "job_progress" : 0
  } ]
}

Status code: 400

Example response for a failed request

{
  "error_msg" : "failed",
  "error_code" : "GES.9999"
}

Status Codes

Return Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authorization failed.
403 Forbidden	No operation permissions.
404 Not Found	No resources found.
500 Internal Server Error	Internal server error.
503 Service Unavailable	Service unavailable.