Querying All Jobs

Function

This API is used to query information about all jobs in the current project.

URI

• URI format

  GET /v1.0/{project_id}/jobs

• Parameter description

  Table 1 URI parameter

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

  Table 2 query parameter description

  Parameter	Mandatory	Type	Description
  page-size	No	Integer	Maximum number of jobs displayed on each page. The value range is as follows: [1, 100]. The default value is 50.
  current-page	No	Integer	Current page number. The default value is 1.
  start	No	Long	Queries the jobs executed later than the time specified by this parameter. The time is a UNIX timestamp in milliseconds.
  end	No	Long	Queries the jobs executed earlier than the time specified by this parameter. The time is a UNIX timestamp in milliseconds.
  job-type	No	String	Type of a job to be queried. Job types include DDL, DCL, IMPORT, EXPORT, QUERY, INSERT, DATA_MIGRATION, UPDATE, DELETE, RESTART_QUEUE, and SCALE_QUEUE. To query all types of jobs, enter ALL.
  job-status	No	String	Status of the job to be queried.
  job-id	No	String	ID of the job to be queried. You can get the value by calling Submitting a SQL Job (Recommended).
  queue_name	No	String	Specifies queue_name as the filter to query jobs running on the specified queue.
  sql_pattern	No	String	Specifies the SQL segment as the filter. It is case insensitive.
  order	No	String	Specifies the job sorting mode. The default value is start_time_desc (job submission time in descending order). Four sorting modes are supported: duration_desc (job running duration in descending order), duration_asc (job running duration in ascending order), start_time_desc (job submission time in descending order), and start_time_asc (job submission time in ascending order).
  engine-type	No	String	Engine type.
  owner	No	String	User who submits a job.
  tags	No	String	Queue tags for the search. You can specify multiple tags in key=value format. Request with one specified tag For example, GET /v1.0/{project_id}/jobs? tags=k1%3Dv1 In this example, = needs to be escaped to %3D, k1 indicates the tag key, and v1 indicates the tag value. Request with more than one tag Separate tags with commas (,) and convert the commas (,) to %2C, for example, GET /v1.0/{project_id}/jobs?. tags=k1%3Dv1%2Ck2%3Dv2. The equal sign (=) is escaped to %3D. k1 indicates a tag key, and v1 indicates the tag value. k2 indicates another tag key, and v2 indicates the tag value. Currently, only fuzzy query is supported. Exact query is not supported.

  

  The following is an example of the URL containing the query parameter:

  GET /v1.0/{project_id}/jobs?page-size={size}&current-page={page_number}&start={start_time}&end={end_time}&job-type={QUERY}&queue_name={test}&order={duration_desc}

Request

None

Response

Example Request

None

Example Response

{
 "is_success": true,
  "message": "",
  "job_count": 1,
  "jobs": [
    {

      "detail": "{\"type\":\"struct\",\"fields\":[{\"name\":\"name\",\"type\":\"string\",\"nullable\":true,\"metadata\":{}},{\"name\":\"age\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}}]}",
      "duration": 17731,

      "end_time": 1502349821460,
      "input_size": 0,
      "job_id": "37286cc7-0508-4ffd-b636-951c8a5c75de",
      "job_type": "QUERY",
      "message": "",
      "owner": "tenant1",
      "queue_name": "queue1",
      "result_count": 3,
      "start_time": 1502349803729,
      "statement": "select * from t_json_002",
      "status": "FINISHED",
      "with_column_header": false
    }
  ]
}

Status Codes

Table 6 describes the status code.

Error Codes

If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.