• MapReduce Service

mrs
  1. Help Center
  2. MapReduce Service
  3. API Reference
  4. APIs
  5. Job Execution Object APIs
  6. Querying the Job Execution Object List

Querying the Job Execution Object List

Function

This API is used to query the job execution object list. This API is compatible with Sahara.

URI

  • Format:

    GET /v1.1/{project_id}/job-executions

  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory or Not

    Description

    project_id

    Yes

    Project ID. For details on how to obtain the project ID, see Obtaining a Project ID.

    limit

    No

    Maximum number of objects in response data

    Value range: 1 to 1073741822

    marker

    No

    Job execution ID

    Query the job execution list, and select one job execution ID as the marker. The ID is the ID of the last element in the list that will not be returned.

    sort_by

    No

    Sort field

    A hyphen (-) before the sort field indicates to sort in descending order. For example:

    • sort_by=name indicates to sort by name in ascending order.
    • sort_by=-name indicates to sort by name in descending order.

Request

  • Example:

    GET /v1.1/{project_id}/job-executions?limit=2&sort_by=id&marker=839244be-c471-469b-80c0-6f63e376bcbc

  • Parameter description

    None.

Response

  • Example:
    {
        "markers": {
            "prev": "821c8924-5249-4dd8-8069-b8d425f3f54a",
            "next": null
        },
        "job_executions": [
            {
                "created_at": "2017-06-22T06:24:57",
                "updated_at": "2017-06-22T06:24:59",
                "id": "84900772-8807-4ddc-9484-f719fa43711f",
                "tenant_id": "5a3314075bfa49b9ae360f4ecd333695",
                "job_id": "",
                "start_time": "2017-06-22T06:24:49",
                "end_time": "2017-06-22T06:25:02",
                "cluster_id": "33dff020-7f96-4270-9c3a-88b99627f6e2",
                "oozie_job_id": null,
                "return_code": null,
                "input_id": null,
                "output_id": null,
                "is_protected": null,
                "is_public": null,
                "engine_job_id": null,
                "job_configs": null,
                "data_source_urls": null,
                "info": null
            },
            {
                "created_at": "2017-06-22T06:23:51",
                "updated_at": "2017-06-22T06:23:51",
                "id": "852042ea-a32c-424b-aacf-df2e6d6642b5",
                "tenant_id": "5a3314075bfa49b9ae360f4ecd333695",
                "job_id": "",
                "start_time": "2017-06-22T06:23:51",
                "end_time": null,
                "cluster_id": "33dff020-7f96-4270-9c3a-88b99627f6e2",
                "oozie_job_id": null,
                "return_code": null,
                "input_id": null,
                "output_id": null,
                "is_protected": null,
                "is_public": null,
                "engine_job_id": null,
                "job_configs": null,
                "data_source_urls": null,
                "info": null
            }
        ]
    }
  • Parameter description
    Table 2 Response parameter description

    Parameter

    Mandatory or Not

    Type

    Description

    markers

    No

    Object

    Marker object

    For details, see Table 3.

    job_execution

    Yes

    Array

    Job execution list

    For details, see Table 4.

    Table 3 markers parameter description

    Parameter

    Mandatory or Not

    Type

    Description

    prev

    No

    String

    Marker on the previous page

    next

    No

    String

    Marker on the next page

    Table 4 job_executions parameter description

    Parameter

    Mandatory or Not

    Type

    Description

    info

    No

    Bool

    Key-value pair set, containing job running information returned by Oozie

    cluster_id

    Yes

    String

    Cluster ID

    job_id

    Yes

    String

    Job ID

    engine_job_id

    Yes

    String

    Workflow ID of Oozie

    oozie_job_id

    Yes

    String

    Workflow ID returned by Oozie

    tenant_id

    Yes

    String

    Project ID. For details on how to obtain the project ID, see Obtaining a Project ID.

    created_at

    Yes

    String

    Job execution object creation time

    updated_at

    Yes

    String

    Job execution object update time

    start_time

    Yes

    String

    Job start time

    end_time

    Yes

    String

    Job end time

    return_code

    Yes

    String

    Response code after job execution

    input_id

    Yes

    String

    Input data source ID of a job execution object

    output_id

    Yes

    String

    Output data source ID of a job execution object

    is_protected

    No

    Bool

    Whether a job execution object is protected

    • true
    • false

    The current version does not support this function.

    is_public

    No

    Bool

    Whether a job execution object is public

    • true
    • false

    The current version does not support this function.

    job_configs

    Yes

    Object

    Key-value pair set for saving job running configurations

    For details, see Table 5.

    data_source_urls

    Yes

    Object

    Data source URL of a job execution object

    id

    Yes

    String

    Job execution object ID

    Table 5 job_configs parameter description

    Parameter

    Mandatory or Not

    Type

    Description

    configs

    No

    Object

    Key-value pair set configured for a job

    args

    No

    Array

    List of arguments

    params

    No

    Object

    Key-value pair set for running a job

Status Code

Table 6 describes the status code of this API.

Table 6 Status code

Status Code

Description

200

The job execution object list is queried successfully.

For the description about error status codes, see section Status Codes.