• MapReduce Service

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

Querying the Binary Object List

Function

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

URI

  • Format:

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

  • 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 binary object ID

    Query the job binary object list, and select one job binary object 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-binaries?limit=3&sort_by=name&marker=eadfb8ec-760b-499f-b8df-00a6def854f8

  • Parameter description

    None.

Response

  • Example:
    {
        "markers": {
            "prev": "ddf13f9d-93e8-4999-b860-0dc0c01c517d",
            "next": null
        },
        "binaries": [
            {
                "name": "my-job-binary-update",
                "url": "/simple/mapreduce/program",
                "description": "this is the job binary template",
                "created_at": "2017-06-22T09:04:53",
                "updated_at": "2017-06-22T09:06:50",
                "id": "da37b581-042f-4d7a-9378-f628f32bd9ae",
                "tenant_id": "5a3314075bfa49b9ae360f4ecd333695",
                "is_public": false,
                "is_protected": false
            }
        ]
    }
  • Parameter description
    Table 2 Response parameter description

    Parameter

    Mandatory or Not

    Type

    Description

    markers

    No

    Object

    Marker object

    For details, see Table 3.

    binaries

    Yes

    Array

    Binary object 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 binaries parameter description

    Parameter

    Mandatory or Not

    Type

    Description

    name

    Yes

    String

    Binary object name

    url

    Yes

    String

    Binary object URL

    description

    Yes

    String

    Binary object description

    created_at

    Yes

    String

    Binary object creation time

    updated_at

    No

    String

    Binary object update time

    id

    Yes

    String

    Binary object ID

    tenant_id

    Yes

    String

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

    is_public

    No

    Bool

    Whether a binary object is public

    • true
    • false

    The current version does not support this function.

    is_protected

    No

    Bool

    Whether a binary object is protected

    • true
    • false

    The current version does not support this function.

Status Code

Table 5 describes the status code of this API.

Table 5 Status code

Status Code

Description

200

The binary object list is queried successfully.

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