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>
159 lines
11 KiB
HTML
159 lines
11 KiB
HTML
<a name="mrs_02_0037"></a><a name="mrs_02_0037"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Binary Object Details</h1>
|
|
<div id="body1484186386751"><div class="section" id="mrs_02_0037__section13541137101416"><h4 class="sectiontitle">Function</h4><p id="mrs_02_0037__p63692365101419">This API is used to query detailed information about a binary object. This API is compatible with Sahara.</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_0037__section49980811101439"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_0037__ul65449209111945"><li id="mrs_02_0037__li56298886111945">Format<p id="mrs_02_0037__p498590111205"><a name="mrs_02_0037__li56298886111945"></a><a name="li56298886111945"></a>GET /v1.1/{project_id}/job-binaries/{job_binary_id}</p>
|
|
</li><li id="mrs_02_0037__li29570299111956">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0037__table49499141194754" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter description</caption><thead align="left"><tr id="mrs_02_0037__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_0037__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_0037__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_0037__p11454278194812">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0037__row6505449415356"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0037__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_0037__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_0037__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_0037__row61502886104852"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0037__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_0037__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_0037__p51638399104852">Binary object ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="mrs_02_0037__section7976792193238"><h4 class="sectiontitle">Request</h4><p id="mrs_02_0037__p1842961591514"><strong id="mrs_02_0037__b139822112354">Request parameters</strong></p>
|
|
<p id="mrs_02_0037__p106160258151">None</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_0037__section38599577193858"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0037__table51257841151049" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter description</caption><thead align="left"><tr id="mrs_02_0037__row8480851151049"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.4.1.1"><p id="mrs_02_0037__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_0037__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_0037__p17581180151049">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0037__row6726034151222"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0037__p20438892151640">is_public</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0037__p16062920151640">Bool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0037__p26028163151640">Whether a binary object is public</p>
|
|
<ul id="mrs_02_0037__ul24233663152954"><li id="mrs_02_0037__li16776383152954">true</li><li id="mrs_02_0037__li16769724152954">false</li></ul>
|
|
<p id="mrs_02_0037__p16709791152954">The current version does not support this function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0037__row35088736111441"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0037__p2935166111454">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0037__p64495288111454">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0037__p56735821111454">Binary object description</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0037__row3560250611155"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0037__p42933867111518">url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0037__p33200524111518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0037__p4887925111518">Binary object URL</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0037__row1794513155918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0037__p25070059155926">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0037__p835343155926">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0037__p1158920103815">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_0037__row23363161601"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0037__p6056003416010">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0037__p4991056416010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0037__p1622389816010">Binary object creation time</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0037__row15896716111552"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0037__p12565602111552">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0037__p33235893111552">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0037__p7752833111552">Binary object update time</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0037__row8652083151249"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0037__p29730140151249">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0037__p17113312151828">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0037__p39995064151249">Binary object ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0037__row12228393151256"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0037__p50975775151256">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0037__p21869845151828">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0037__p43580859151256">Binary object name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0037__row4419889616034"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0037__p37826600111641">is_protected</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0037__p11748871111641">Bool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0037__p12134505111641">Whether a binary object is protected</p>
|
|
<ul id="mrs_02_0037__ul3872134516111"><li id="mrs_02_0037__li1294778516111">true</li><li id="mrs_02_0037__li4942120716111">false</li></ul>
|
|
<p id="mrs_02_0037__p4213768316111">The current version does not support this function.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_0037__section1210015461189"><h4 class="sectiontitle">Example</h4><ul id="mrs_02_0037__ul1958913536182"><li id="mrs_02_0037__li1558945321814">Example request<p id="mrs_02_0037__p8671133419191"><a name="mrs_02_0037__li1558945321814"></a><a name="li1558945321814"></a>None</p>
|
|
</li><li id="mrs_02_0037__li543710159193">Example response<pre class="screen" id="mrs_02_0037__screen6477696911182">{
|
|
"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_0037__section19688788101519"><h4 class="sectiontitle">Status Code</h4><p id="mrs_02_0037__p5547365016031"><a href="#mrs_02_0037__table1584477916050">Table 3</a> describes the status code of this API.</p>
|
|
|
|
<div class="tablenoborder"><a name="mrs_02_0037__table1584477916050"></a><a name="table1584477916050"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0037__table1584477916050" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="mrs_02_0037__row1339492016050"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.3.2.3.1.1"><p id="mrs_02_0037__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_0037__p1158961516050">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0037__row3719767816050"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.3.2.3.1.1 "><p id="mrs_02_0037__p6022194016050">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.3.2.3.1.2 "><p id="mrs_02_0037__p4613894216050">The binary object details are queried successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="mrs_02_0037__p189130465218">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>
|
|
|