forked from docs/doc-exports
Su, Xiaomeng
483e5cc6cc
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Su, Xiaomeng <suxiaomeng1@huawei.com> Co-committed-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
134 lines
10 KiB
HTML
134 lines
10 KiB
HTML
<a name="dli_02_0225"></a><a name="dli_02_0225"></a>
|
|
|
|
<h1 class="topictitle1">Granting OBS Permissions to DLI</h1>
|
|
<div id="body1574749523863"><div class="section" id="dli_02_0225__s9b3bf6d5478e4f40809183a8e4c945c8"><h4 class="sectiontitle">Function</h4><p id="dli_02_0225__p1119545861312">This API is used to grant DLI the permission to access OBS buckets for saving job checkpoints and run logs.</p>
|
|
<div class="note" id="dli_02_0225__note794562214412"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dli_02_0225__dli_02_0298_p69451622184111">This API has been discarded and is not recommended.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="dli_02_0225__s6a7bbfd0e1f9428cb2a117c6209d3ecc"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0225__u855db85bb6f7486480fb706df5879055"><li id="dli_02_0225__le839394b8a104991ad6145e79126cccd">URI format<p id="dli_02_0225__a8ff286c518f34de3b1c17de5dc2ada10"><a name="dli_02_0225__le839394b8a104991ad6145e79126cccd"></a><a name="le839394b8a104991ad6145e79126cccd"></a>POST /v1.0/{project_id}/dli/obs-authorize</p>
|
|
</li><li id="dli_02_0225__lc56f09ab3740467f97c309160cbcb391">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0225__tbaca857a157e4997b5dbb988edcf993c" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dli_02_0225__r03e4a55add6647aca133cd70d01d82aa"><th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0225__aa631a19e68664105b7cc08c51b3bd00d">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.819999999999999%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0225__en-us_topic_0064335565_p141410194812">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.24%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0225__p1442181214592">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.79%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0225__a3119b8debd144b84aa0801c3b984f22d">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0225__rc2d25e8962944b0b9d498c736bc7c1df"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0225__p3492262515356">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.819999999999999%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0225__p1016041415356">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0225__p14442141205914">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.79%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0225__p1310472724012">Project ID, which is used for resource isolation. For details about how to obtain its value, see <a href="dli_02_0183.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0225__s90a833072d73410195d15a24ded71831"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0225__t3c2a16bb2526480f9ae1cfcc5bd53cd9" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="dli_02_0225__rb6596f648dee4d66b67623a5a840bc08"><th align="left" class="cellrowborder" valign="top" width="19.32%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_02_0225__a50ff33b347ac4474b6c7e31bff2ea607">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.07%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_02_0225__a464d26a0587d4b39af84eee1ff9edc54">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.61%" id="mcps1.3.3.2.2.5.1.3"><p id="dli_02_0225__en-us_topic_0064335565_p748325710328">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.3.2.2.5.1.4"><p id="dli_02_0225__en-us_topic_0064335565_p216409810328">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0225__rf2382b882efa4356b7c44ae02a200e9f"><td class="cellrowborder" valign="top" width="19.32%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0225__p1626317114212">obs_buckets</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.07%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0225__p26642427151446">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0225__p25392734151446">Array of Strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0225__p144408974115">List of OBS buckets.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0225__sb9b709576ce84cc5aeb28d9133e7741b"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0225__t0d27d7cf309a4b078789fdce81be4b36" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0225__rb20a976e281f4bb7bf0c3d7458d6ddf7"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0225__en-us_topic_0064335565_p42893210328">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0225__aa5a1673b8e9149d09001628e9caa78d9">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0225__afd1d2e67cf4b4a3e8d2a5a02c7d145f1">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0225__a82881821f59f40c0b0bb4b6b34d6ea76">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0225__raf7543ddbbd7434680507661da53b6f6"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0225__p19731617125720">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0225__p1497341705714">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0225__p1297214176578">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0225__p109711817125720">Whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0225__parmvalue4993877595041"><b>true</b></span> indicates that the request is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0225__row146054616226"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0225__p166111464229">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0225__p146224619228">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0225__p12625467227">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0225__p1162144612211">Message content.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0225__section1130754105710"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0225__p45987618491">Grant DLI the permission to access the OBS bucket <strong id="dli_02_0225__b2237310122816">bucket1</strong> so that DLI can save job checkpoints and run logs to the bucket.</p>
|
|
<pre class="screen" id="dli_02_0225__screen14250721184412">{
|
|
"obs_buckets": [
|
|
"bucket1"
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0225__section714718486414"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0225__screen29022464518">{
|
|
"is_success": "true",
|
|
"message": "The following OBS bucket is authorized successfully, bucket1."
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0225__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0225__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0225__tb12870f1c5f24b27abd55ca24264af36">Table 4</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0225__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0225__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status codes</caption><thead align="left"><tr id="dli_02_0225__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0225__ab49d21f312644072a331f43e92baf853">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.7.3.2.3.1.2"><p id="dli_02_0225__aea1d3bd107bb4c499da79a88832d256c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0225__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0225__a3153e07b3a9749adba92599fe6628fbf">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0225__p10675142010516">Authorization succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0225__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0225__p184941532219">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0225__p2049413539219">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0225__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0225__p420584425712">If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see <a href="dli_02_0056.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0333.html">APIs Related to Flink Jobs (Discarded)</a></div>
|
|
</div>
|
|
</div>
|
|
|