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>
237 lines
16 KiB
HTML
237 lines
16 KiB
HTML
<a name="mrs_02_0036"></a><a name="mrs_02_0036"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Binary Object List</h1>
|
|
<div id="body1484186386751"><div class="section" id="mrs_02_0036__section13541137101416"><h4 class="sectiontitle">Function</h4><p id="mrs_02_0036__p63692365101419">This API is used to query the binary object list. This API is compatible with Sahara.</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_0036__section49980811101439"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_0036__ul1953618811730"><li id="mrs_02_0036__li1967839611730">Format<p id="mrs_02_0036__p265226051185"><a name="mrs_02_0036__li1967839611730"></a><a name="li1967839611730"></a>GET /v1.1/{project_id}/job-binaries</p>
|
|
</li><li id="mrs_02_0036__li6612766411737">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0036__table49499141194754" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter description</caption><thead align="left"><tr id="mrs_02_0036__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_0036__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_0036__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_0036__p11454278194812">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0036__row6505449415356"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0036__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_0036__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_0036__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_0036__row20659256153330"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0036__p10159747154837">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0036__p44704178154837">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0036__p49662373154837">Maximum number of objects in response data</p>
|
|
<p id="mrs_02_0036__p31788692155324">Value range: 1 to 1073741822</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0036__row6317415154849"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0036__p41948639154849">marker</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0036__p42396583154849">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0036__p6627529811145">Job binary object ID</p>
|
|
<p id="mrs_02_0036__p11571175154849">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.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0036__row36517032111447"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0036__p5089576111447">sort_by</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0036__p9602484111447">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0036__p4862929713590">Sort field</p>
|
|
<p id="mrs_02_0036__p1758085093716">A hyphen (-) before the sort field indicates to sort in descending order. Example:</p>
|
|
<ul id="mrs_02_0036__ul5167941115195"><li id="mrs_02_0036__li4752566615198"><strong id="mrs_02_0036__b20718183818237">sort_by=name</strong> indicates to sort by name in ascending order.</li><li id="mrs_02_0036__li3034789115195"><strong id="mrs_02_0036__b13180444132316">sort_by=-name</strong> indicates to sort by name in descending order.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="mrs_02_0036__section7976792193238"><h4 class="sectiontitle">Request</h4><p id="mrs_02_0036__p1842961591514"><strong id="mrs_02_0036__b139822112354">Request parameters</strong></p>
|
|
<p id="mrs_02_0036__p106160258151">None.</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_0036__section38599577193858"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0036__table51257841151049" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter description</caption><thead align="left"><tr id="mrs_02_0036__row8480851151049"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.4.1.1"><p id="mrs_02_0036__p15860319151049">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_0036__p40813771151049">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_0036__p17581180151049">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0036__row16731987111557"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0036__p13113722111557">markers</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0036__p5571942111557">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0036__p48674171111557">Markers object</p>
|
|
<p id="mrs_02_0036__p16522192210405">For details, see <a href="#mrs_02_0036__table35904709104244">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0036__row64063916111610"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0036__p21794736111610">binaries</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0036__p53385869111610">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0036__p11305534104017">Binary object list</p>
|
|
<p id="mrs_02_0036__p29288118111610">For details, see <a href="#mrs_02_0036__table5646270112712">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="mrs_02_0036__table35904709104244"></a><a name="table35904709104244"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0036__table35904709104244" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="mrs_02_0036__b5750106114110">markers</strong> parameter description</caption><thead align="left"><tr id="mrs_02_0036__row49938240104244"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="mrs_02_0036__p18465671104244">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="mrs_02_0036__p21768128104244">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="mrs_02_0036__p18387972104244">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0036__row13030764104244"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0036__p63118498104319">prev</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0036__p43381604104319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0036__p39594016104319">Marker on the previous page</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0036__row58460908104244"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0036__p46558357104319">next</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0036__p66061904104319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0036__p53737691104319">Marker on the next page</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="mrs_02_0036__table5646270112712"></a><a name="table5646270112712"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0036__table5646270112712" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="mrs_02_0036__b87891589421">binaries</strong> parameter description</caption><thead align="left"><tr id="mrs_02_0036__row41235644112712"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="mrs_02_0036__p51752871112712">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="mrs_02_0036__p46844898112712">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="mrs_02_0036__p36340354112712">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0036__row16789243112712"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="mrs_02_0036__p17751420112712">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="mrs_02_0036__p33193333112712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="mrs_02_0036__p4305468112712">Binary object name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0036__row38749219112712"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="mrs_02_0036__p51679044112712">url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="mrs_02_0036__p32230151112712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="mrs_02_0036__p60505466112712">Binary object URL</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0036__row7678284112712"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="mrs_02_0036__p17961238112712">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="mrs_02_0036__p519192112712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="mrs_02_0036__p42054559112712">Binary object description</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0036__row42946717112712"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="mrs_02_0036__p56132075112712">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="mrs_02_0036__p56208447112712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="mrs_02_0036__p56590358112712">Binary object creation time</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0036__row39551177112712"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="mrs_02_0036__p49528772112712">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="mrs_02_0036__p17154847112712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="mrs_02_0036__p47365327112712">Binary object update time</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0036__row23634760112712"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="mrs_02_0036__p35367402112712">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="mrs_02_0036__p50183839112712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="mrs_02_0036__p38359171112712">Binary object ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0036__row9688219112712"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="mrs_02_0036__p46548270112712">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="mrs_02_0036__p57872178112712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="mrs_02_0036__p98891143183718">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_0036__row44451467112712"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="mrs_02_0036__p43799081112712">is_public</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="mrs_02_0036__p5621264112712">Bool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="mrs_02_0036__p52669224112712">Whether a binary object is public</p>
|
|
<ul id="mrs_02_0036__ul24233663152954"><li id="mrs_02_0036__li16776383152954">true</li><li id="mrs_02_0036__li16769724152954">false</li></ul>
|
|
<p id="mrs_02_0036__p16709791152954">The current version does not support this function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0036__row4260969112712"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="mrs_02_0036__p9594237112712">is_protected</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="mrs_02_0036__p66786682112712">Bool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="mrs_02_0036__p41012147112712">Whether a binary object is protected</p>
|
|
<ul id="mrs_02_0036__ul5782838616950"><li id="mrs_02_0036__li5069343016950">true</li><li id="mrs_02_0036__li5358768616950">false</li></ul>
|
|
<p id="mrs_02_0036__p1252713316950">The current version does not support this function.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_0036__section1210015461189"><h4 class="sectiontitle">Example</h4><ul id="mrs_02_0036__ul1958913536182"><li id="mrs_02_0036__li1558945321814">Example request<pre class="screen" id="mrs_02_0036__screen22812175334">GET /v1.1/{project_id}/job-binaries?limit=1&sort_by=name&marker= eadfb8ec-760b-499f-b8df-00a6def854f8</pre>
|
|
</li><li id="mrs_02_0036__li543710159193">Example response<pre class="screen" id="mrs_02_0036__screen2999310411349">{
|
|
"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
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="mrs_02_0036__section19688788101519"><h4 class="sectiontitle">Status Code</h4><p id="mrs_02_0036__p5547365016031"><a href="#mrs_02_0036__table1584477916050">Table 5</a> describes the status code of this API.</p>
|
|
|
|
<div class="tablenoborder"><a name="mrs_02_0036__table1584477916050"></a><a name="table1584477916050"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0036__table1584477916050" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status code</caption><thead align="left"><tr id="mrs_02_0036__row1339492016050"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.3.2.3.1.1"><p id="mrs_02_0036__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_0036__p1158961516050">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0036__row3719767816050"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.3.2.3.1.1 "><p id="mrs_02_0036__p6022194016050">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.3.2.3.1.2 "><p id="mrs_02_0036__p4613894216050">The binary object list is queried successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="mrs_02_0036__p103993265215">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>
|
|
|