forked from docs/doc-exports
Yang, Tong
bd2b57f749
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Yang, Tong <yangtong2@huawei.com> Co-committed-by: Yang, Tong <yangtong2@huawei.com>
229 lines
15 KiB
HTML
229 lines
15 KiB
HTML
<a name="mrs_02_0035"></a><a name="mrs_02_0035"></a>
|
|
|
|
<h1 class="topictitle1">Updating a Job Binary Object</h1>
|
|
<div id="body1484186386751"><div class="section" id="mrs_02_0035__section13541137101416"><h4 class="sectiontitle">Function</h4><p id="mrs_02_0035__p63692365101419">This API is used to update a job binary object. This API is compatible with Sahara.</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_0035__section49980811101439"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_0035__ul51297400104752"><li id="mrs_02_0035__li8839334104752">Format<p id="mrs_02_0035__p59199782104818"><a name="mrs_02_0035__li8839334104752"></a><a name="li8839334104752"></a>PUT /v1.1/{project_id}/job-binaries/{job_binary_id}</p>
|
|
</li><li id="mrs_02_0035__li62270340104756">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0035__table49499141194754" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter description</caption><thead align="left"><tr id="mrs_02_0035__row33700024194754"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="mrs_02_0035__p16571835194812">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="mrs_02_0035__p141410194812">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="mrs_02_0035__p11454278194812">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0035__row6505449415356"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0035__p3492262515356">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0035__p1016041415356">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0035__p1768719515356">Project ID. For details on how to obtain the project ID, see <a href="mrs_02_0011.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0035__row61502886104852"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0035__p15677856104852">job_binary_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0035__p61946843104852">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0035__p51638399104852">Binary object ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="mrs_02_0035__section7976792193238"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0035__table51257841151049" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter description</caption><thead align="left"><tr id="mrs_02_0035__row8480851151049"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.2.5.1.1"><p id="mrs_02_0035__p15860319151049">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.5.1.2"><p id="mrs_02_0035__p9617423151049">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.5.1.3"><p id="mrs_02_0035__p40813771151049">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.3.2.2.5.1.4"><p id="mrs_02_0035__p17581180151049">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0035__row33862023103039"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0035__p66764558103051">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0035__p39220083103051">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0035__p22710132103051">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0035__p27581435103051">Binary object name</p>
|
|
<p id="mrs_02_0035__p3904672811352">Contains 1 to 80 characters and consists of letters, digits, hyphens (-), and underscores (_) only.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0035__row4719796510464"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0035__p6521450910469">url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0035__p4788387310469">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0035__p5338853410469">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0035__p2950402010469">Binary object URL, which contains of 1 to 255 characters.</p>
|
|
<p id="mrs_02_0035__p4805152516398">The URL must start with <strong id="mrs_02_0035__b1932717215405">s3a://</strong> or <strong id="mrs_02_0035__b1066213397426">/</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0035__row60274821103112"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0035__p16682465103121">is_protected</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0035__p653385121120">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0035__p66208658103121">Bool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0035__p61301077103121">Whether a binary object is protected</p>
|
|
<ul id="mrs_02_0035__ul24233663152954"><li id="mrs_02_0035__li16776383152954">true</li><li id="mrs_02_0035__li16769724152954">false</li></ul>
|
|
<p id="mrs_02_0035__p16709791152954">The current version does not support this function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0035__row6726034151222"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0035__p20438892151640">is_public</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0035__p378209391120">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0035__p16062920151640">Bool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0035__p26028163151640">Whether a binary object is public</p>
|
|
<ul id="mrs_02_0035__ul6551573216658"><li id="mrs_02_0035__li5277068216658">true</li><li id="mrs_02_0035__li517409416658">false</li></ul>
|
|
<p id="mrs_02_0035__p4656684916658">The current version does not support this function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0035__row1546567016045"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0035__p2185314916152">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0035__p79012551120">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0035__p3397791716152">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0035__p74792916152">Binary object description</p>
|
|
<p id="mrs_02_0035__p19803155762718">Contains a maximum of 65535 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_0035__section38599577193858"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0035__table65392315111353" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter description</caption><thead align="left"><tr id="mrs_02_0035__row34315492111353"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.4.1.1"><p id="mrs_02_0035__p28091506111353">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.4.1.2"><p id="mrs_02_0035__p27434435111353">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.2.4.1.3"><p id="mrs_02_0035__p7596758111353">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0035__row11357670111353"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0035__p47556058111353">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0035__p26190480111353">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0035__p41054113111353">Binary object description</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0035__row33942704111353"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0035__p65004536111353">url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0035__p17931936111353">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0035__p43200721111353">Binary object URL</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0035__row53262173111353"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0035__p19268770111353">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0035__p56411121111353">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0035__p7857191573713">Project ID. For details on how to obtain the project ID, see <a href="mrs_02_0011.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0035__row53082533111353"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0035__p4717921111353">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0035__p17096362111353">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0035__p42628104111353">Binary object creation time</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0035__row65080540154130"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0035__p37032416154130">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0035__p35596989154130">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0035__p64783846154130">Binary object update time</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0035__row48108617111353"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0035__p4483910111353">is_protected</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0035__p25255806111353">Bool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0035__p32454409111353">Whether a binary object is protected</p>
|
|
<ul id="mrs_02_0035__ul3762529416743"><li id="mrs_02_0035__li308333016743">true</li><li id="mrs_02_0035__li2774997416743">false</li></ul>
|
|
<p id="mrs_02_0035__p4842317916743">The current version does not support this function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0035__row23654226111353"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0035__p36944171111353">is_public</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0035__p60598757111353">Bool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0035__p9552279111353">Whether a binary object is public</p>
|
|
<ul id="mrs_02_0035__ul6035424216746"><li id="mrs_02_0035__li631726816746">true</li><li id="mrs_02_0035__li5685541816746">false</li></ul>
|
|
<p id="mrs_02_0035__p4193671516746">The current version does not support this function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0035__row18861649111353"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0035__p51398639111353">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0035__p4432992111353">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0035__p23528067111353">Binary object ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0035__row10426016111353"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0035__p39200957111353">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0035__p36313784111353">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0035__p55735398111353">Binary object name</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_0035__section1210015461189"><h4 class="sectiontitle">Example</h4><ul id="mrs_02_0035__ul1958913536182"><li id="mrs_02_0035__li1558945321814">Example request<pre class="screen" id="mrs_02_0035__screen1465322611625">{
|
|
"name": "my-job-binary-update",
|
|
"url": "/simple/mapreduce/program",
|
|
"is_protected": false,
|
|
"is_public": false,
|
|
"description": "this is the job binary template"
|
|
}</pre>
|
|
</li><li id="mrs_02_0035__li543710159193">Example response<pre class="screen" id="mrs_02_0035__screen64036754103834">{
|
|
"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
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="mrs_02_0035__section19688788101519"><h4 class="sectiontitle">Status Code</h4><p id="mrs_02_0035__p5547365016031"><a href="#mrs_02_0035__table1584477916050">Table 4</a> describes the status code of this API.</p>
|
|
|
|
<div class="tablenoborder"><a name="mrs_02_0035__table1584477916050"></a><a name="table1584477916050"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0035__table1584477916050" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="mrs_02_0035__row1339492016050"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.3.2.3.1.1"><p id="mrs_02_0035__p3411176516050">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.6.3.2.3.1.2"><p id="mrs_02_0035__p1158961516050">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0035__row3719767816050"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.3.2.3.1.1 "><p id="mrs_02_0035__p6022194016050">202</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.3.2.3.1.2 "><p id="mrs_02_0035__p4613894216050">The binary object has been updated successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="mrs_02_0035__p166341959135115">For the description about error status codes, see <a href="mrs_02_0015.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0033.html">Job Binary Object APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|