forked from docs/doc-exports
Lai, Weijian
1ad28cc33e
Reviewed-by: Jiang, Beibei <beibei.jiang@t-systems.com> Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Lai, Weijian <laiweijian4@huawei.com> Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>
92 lines
9.3 KiB
HTML
92 lines
9.3 KiB
HTML
<a name="modelarts_04_0218"></a><a name="modelarts_04_0218"></a>
|
|
|
|
<h1 class="topictitle1">Uploading a File to OBS</h1>
|
|
<div id="body8662426"><div class="section" id="modelarts_04_0218__en-us_topic_0220956295_section68941956195211"><h4 class="sectiontitle">Sample Code</h4><p id="modelarts_04_0218__en-us_topic_0220956295_p10770125203813">In the ModelArts notebook instance, you do not need to enter authentication parameters for session authentication. For details about session authentication of other development environments, see <a href="modelarts_04_0153.html">Session Authentication</a>.</p>
|
|
<div class="codecoloring" codetype="Python" id="modelarts_04_0218__en-us_topic_0220956295_screen15218201814910"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
|
|
<span class="normal">2</span>
|
|
<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><span class="kn">from</span> <span class="nn">modelarts.session</span> <span class="kn">import</span> <span class="n">Session</span>
|
|
<span class="n">session</span> <span class="o">=</span> <span class="n">Session</span><span class="p">()</span>
|
|
<span class="n">session</span><span class="o">.</span><span class="n">obs</span><span class="o">.</span><span class="n">upload_file</span><span class="p">(</span><span class="n">src_local_file</span><span class="o">=</span><span class="s1">'/home/ma-user/file1.txt'</span><span class="p">,</span> <span class="n">dst_obs_dir</span><span class="o">=</span><span class="s1">'obs://bucket-name/dir1/'</span><span class="p">)</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</div>
|
|
<p id="modelarts_04_0218__en-us_topic_0220956295_p42371748385">After the sample code is executed, the local source file <span class="filepath" id="modelarts_04_0218__en-us_topic_0220956295_filepath1719510318193"><b>file1.txt</b></span> is uploaded to the <span class="filepath" id="modelarts_04_0218__en-us_topic_0220956295_filepath168361847192220"><b>dir1</b></span> folder in the <span class="filepath" id="modelarts_04_0218__en-us_topic_0220956295_filepath8772165191914"><b>bucket-name</b></span> bucket. The path is <span class="filepath" id="modelarts_04_0218__en-us_topic_0220956295_filepath421118162195"><b>obs://bucket-name/dir1/file1.txt</b></span>. The bucket name and folder name are user-defined.</p>
|
|
<div class="section" id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_section520413412065"><h4 class="sectiontitle">Parameter Description</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_table155461191218" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_row254817912212"><th align="left" class="cellrowborder" valign="top" width="19.869999999999997%" id="mcps1.3.3.2.2.5.1.1"><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p12549899214">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.32%" id="mcps1.3.3.2.2.5.1.2"><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p3552101193813">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.32%" id="mcps1.3.3.2.2.5.1.3"><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p1755169172118">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.49%" id="mcps1.3.3.2.2.5.1.4"><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p55521998211">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_row8893215413"><td class="cellrowborder" valign="top" width="19.869999999999997%" headers="mcps1.3.3.2.2.5.1.1 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p6891421842">session</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.32%" headers="mcps1.3.3.2.2.5.1.2 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p68972047">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.32%" headers="mcps1.3.3.2.2.5.1.3 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p158912219419">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.49%" headers="mcps1.3.3.2.2.5.1.4 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p1689152543">Session object</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_row1530181931"><td class="cellrowborder" valign="top" width="19.869999999999997%" headers="mcps1.3.3.2.2.5.1.1 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p8675871731">src_local_file</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.32%" headers="mcps1.3.3.2.2.5.1.2 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p6675978319">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.32%" headers="mcps1.3.3.2.2.5.1.3 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p46751171339">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.49%" headers="mcps1.3.3.2.2.5.1.4 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p467516712319">Path to the local file to be uploaded</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_row167932713277"><td class="cellrowborder" valign="top" width="19.869999999999997%" headers="mcps1.3.3.2.2.5.1.1 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p5794079274">dst_obs_dir</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.32%" headers="mcps1.3.3.2.2.5.1.2 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p77948710279">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.32%" headers="mcps1.3.3.2.2.5.1.3 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p3794167192716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.49%" headers="mcps1.3.3.2.2.5.1.4 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p461991742117">Path to the target OBS bucket. The path must start with <span class="filepath" id="modelarts_04_0218__en-us_topic_0220956295_filepath416152032116"><b>obs://</b></span> and end with a slash (/).</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_table55928961173927" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Failed response parameters</caption><thead align="left"><tr id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_row40618446173927"><th align="left" class="cellrowborder" valign="top" width="24.86%" id="mcps1.3.4.2.4.1.1"><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p1631242217407">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.75%" id="mcps1.3.4.2.4.1.2"><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p5427574117407">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.39000000000001%" id="mcps1.3.4.2.4.1.3"><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p12364118914">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_row11062410173927"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.4.2.4.1.1 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p688954611624">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.75%" headers="mcps1.3.4.2.4.1.2 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p3804851211624">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.39000000000001%" headers="mcps1.3.4.2.4.1.3 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p156551524172412">Error code when the API call fails.</p>
|
|
<p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p6203060911624">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_row52351653173927"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.4.2.4.1.1 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p4368550411624">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.75%" headers="mcps1.3.4.2.4.1.2 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p6574380911624">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.39000000000001%" headers="mcps1.3.4.2.4.1.3 "><p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p1277593619">Error message when the API call fails.</p>
|
|
<p id="modelarts_04_0218__en-us_topic_0220956295_en-us_topic_0173848862_p2364831411624">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="modelarts_04_0006.html">OBS Management (Recommended)</a></div>
|
|
</div>
|
|
</div>
|
|
|