Updating a Job Binary Object¶

Function¶

This API is used to update a job binary object. This API is compatible with Sahara.

URI¶

Format
PUT /v1.1/{project_id}/job-binaries/{job_binary_id}
Parameter description
Table 1 URI parameter description¶
Parameter
Mandatory
Description
project_id
Yes
Project ID. For details on how to obtain the project ID, see Obtaining a Project ID.
job_binary_id
Yes
Binary object ID

**Table 1** URI parameter description¶
Parameter	Mandatory	Description
project_id	Yes	Project ID. For details on how to obtain the project ID, see Obtaining a Project ID.
job_binary_id	Yes	Binary object ID

Request¶

**Table 2** Request parameter description¶
Parameter	Mandatory	Type	Description
name	No	String	Binary object name Contains 1 to 80 characters and consists of letters, digits, hyphens (-), and underscores (_) only.
url	No	String	Binary object URL, which contains of 1 to 255 characters. The URL must start with s3a:// or /.
is_protected	No	Bool	Whether a binary object is protected true false The current version does not support this function.
is_public	No	Bool	Whether a binary object is public true false The current version does not support this function.
description	Yes	String	Binary object description Contains a maximum of 65535 characters.

Response¶

**Table 3** Response parameter description¶
Parameter	Type	Description
description	String	Binary object description
url	String	Binary object URL
tenant_id	String	Project ID. For details on how to obtain the project ID, see Obtaining a Project ID.
created_at	String	Binary object creation time
updated_at	String	Binary object update time
is_protected	Bool	Whether a binary object is protected true false The current version does not support this function.
is_public	Bool	Whether a binary object is public true false The current version does not support this function.
id	String	Binary object ID
name	String	Binary object name

Example¶

Example request

{
    "name": "my-job-binary-update",
    "url": "/simple/mapreduce/program",
    "is_protected": false,
    "is_public": false,
    "description": "this is the job binary template"
}

Example response

{
    "job_binary": {
        "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
    }
}

Status Code¶

Table 4 describes the status code of this API.

**Table 4** Status code¶
Status Code	Description
202	The binary object has been updated successfully.

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

last updated: 2024-11-14 12:28 UTC - commit: 9d95be538b931742820cff066f12ce18f037ed96