yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

OBS Util 0115 Version

Browse Source 
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: weihongmin1 <weihongmin1@huawei.com>
Co-committed-by: weihongmin1 <weihongmin1@huawei.com>
This commit is contained in:
Wei, Hongmin
2026-02-17 10:18:57 +00:00
committed by zuul
parent affc0093ff
commit a41a4e0331
97 changed files with 10128 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1410
docs/obs/tool-obsutil/ALL_META.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

704
docs/obs/tool-obsutil/CLASS.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

3
docs/obs/tool-obsutil/PARAMETERS.txt Normal file
View File

@ -0,0 +1,3 @@
version=""
language="en-us"
type=""

33
docs/obs/tool-obsutil/obs_11_0000.html Normal file
View File

@ -0,0 +1,33 @@
<a name="obs_11_0000"></a><a name="obs_11_0000"></a>
<h1 class="topictitle1">Change History</h1>
<div id="body1542438931293">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_11_0000__table1356142351914" frame="border" border="1" rules="all"><thead align="left"><tr id="obs_11_0000__row93579238197"><th align="left" class="cellrowborder" valign="top" width="24.240000000000002%" id="mcps1.3.1.1.3.1.1"><p id="obs_11_0000__p535752301918">Released On</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="75.76%" id="mcps1.3.1.1.3.1.2"><p id="obs_11_0000__p103571923161916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_11_0000__row9868833136"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="obs_11_0000__p188681235133">2026-02-12</p>
</td>
<td class="cellrowborder" valign="top" width="75.76%" headers="mcps1.3.1.1.3.1.2 "><p id="obs_11_0000__p0160139137">This issue is the third official release.</p>
<p id="obs_11_0000__p1228521151312">Updated <a href="obs_11_0003.html">Downloading and Installing obsutil</a> by adding obsutil signature files.</p>
</td>
</tr>
<tr id="obs_11_0000__row5922711149"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="obs_11_0000__p12923101171418">2025-12-03</p>
</td>
<td class="cellrowborder" valign="top" width="75.76%" headers="mcps1.3.1.1.3.1.2 "><p id="obs_11_0000__p492341161420">This issue is the second official release.</p>
<p id="obs_11_0000__p11502019131415">Updated <a href="obs_11_0003.html">Downloading and Installing obsutil</a> by adding download links of obsutil.</p>
</td>
</tr>
<tr id="obs_11_0000__row14357523201918"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="obs_11_0000__p4357172310194">2025-11-21</p>
</td>
<td class="cellrowborder" valign="top" width="75.76%" headers="mcps1.3.1.1.3.1.2 "><p id="obs_11_0000__p13571623111914">This issue is the first official release.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div></div>

84
docs/obs/tool-obsutil/obs_11_0001.html Normal file
View File

@ -0,0 +1,84 @@
<a name="obs_11_0001"></a><a name="obs_11_0001"></a>
<h1 class="topictitle1">obsutil Introduction</h1>
<div id="body1542943180895"><p id="obs_11_0001__p8060118">obsutil is a command line tool for accessing and managing OBS. You can use this tool to create buckets and upload, download, or delete files/folders. If you are familiar with the command line interface (CLI), obsutil is a good choice in batch processing and automatic tasks.</p>
<p id="obs_11_0001__p1135113471344">obsutil is compatible with Windows, Linux, and macOS. <a href="#obs_11_0001__table1282175018104">Table 1</a> lists the recommended operating system (OS) versions. </p>
<div class="tablenoborder"><a name="obs_11_0001__table1282175018104"></a><a name="table1282175018104"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_11_0001__table1282175018104" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Recommended OS versions for obsutil</caption><thead align="left"><tr id="obs_11_0001__row1083550111016"><th align="left" class="cellrowborder" valign="top" width="22.97%" id="mcps1.3.3.2.3.1.1"><p id="obs_11_0001__p78385041015">OS</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="77.03%" id="mcps1.3.3.2.3.1.2"><p id="obs_11_0001__p14841250121019">Recommended Version</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_11_0001__row17841250151013"><td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.3.2.3.1.1 "><p id="obs_11_0001__p984850121013">Windows</p>
</td>
<td class="cellrowborder" valign="top" width="77.03%" headers="mcps1.3.3.2.3.1.2 "><ul id="obs_11_0001__ul1569975214153"><li id="obs_11_0001__li1670045231516">Windows 7</li><li id="obs_11_0001__li155119411944">Windows 8</li><li id="obs_11_0001__li101943439412">Windows 10</li><li id="obs_11_0001__li1022510381598">Windows 11</li><li id="obs_11_0001__li6478105914155">Windows Server 2016</li><li id="obs_11_0001__li1640702155419">Windows Server 2019</li></ul>
</td>
</tr>
<tr id="obs_11_0001__row13841150191018"><td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.3.2.3.1.1 "><p id="obs_11_0001__p88475041016">Linux</p>
</td>
<td class="cellrowborder" valign="top" width="77.03%" headers="mcps1.3.3.2.3.1.2 "><ul id="obs_11_0001__ul9872184517166"><li id="obs_11_0001__li118721445111610">SUSE 11</li><li id="obs_11_0001__li104009390915">EulerOS 2</li><li id="obs_11_0001__li49891744102816">CentOS 7</li></ul>
</td>
</tr>
<tr id="obs_11_0001__row1384185091013"><td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.3.2.3.1.1 "><p id="obs_11_0001__p158410500108">macOS</p>
</td>
<td class="cellrowborder" valign="top" width="77.03%" headers="mcps1.3.3.2.3.1.2 "><p id="obs_11_0001__p17842505108">macOS 10.13.4</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="obs_11_0001__section1963918332594"><h4 class="sectiontitle">Advantages</h4><p id="obs_11_0001__p894415449448">obsutil has the following advantages:</p>
<ol id="obs_11_0001__ol2088681194515"><li id="obs_11_0001__li7886211184519">Easy to use</li><li id="obs_11_0001__li16446102954513">Lightweight and installation-free</li><li id="obs_11_0001__li81671334175015">Compatible with Windows, Linux, and macOS</li><li id="obs_11_0001__li411611064613">Excellent performance and diversified configurations</li></ol>
</div>
<div class="section" id="obs_11_0001__section38975716584"><h4 class="sectiontitle">Application Scenarios</h4><ul id="obs_11_0001__ul170673213246"><li id="obs_11_0001__li470614326244">Automatic backup and archiving, for example, periodically uploading local data to OBS</li><li id="obs_11_0001__li635516119218">Operations that you cannot perform using other tools (like OBS Browser+). Such operations include synchronously uploading, downloading, and copying objects.</li></ul>
</div>
<div class="section" id="obs_11_0001__section3951253155910"><h4 class="sectiontitle">Functions</h4><p id="obs_11_0001__p20196241083"><a href="#obs_11_0001__table1233162315227">Table 2</a> lists the functions of obsutil.</p>
<div class="tablenoborder"><a name="obs_11_0001__table1233162315227"></a><a name="table1233162315227"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_11_0001__table1233162315227" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Functions of obsutil</caption><thead align="left"><tr id="obs_11_0001__row034112362217"><th align="left" class="cellrowborder" valign="top" width="27.51%" id="mcps1.3.6.3.2.3.1.1"><p id="obs_11_0001__p1734192382220">Function</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="72.49%" id="mcps1.3.6.3.2.3.1.2"><p id="obs_11_0001__p134162392219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_11_0001__row1934162372212"><td class="cellrowborder" valign="top" width="27.51%" headers="mcps1.3.6.3.2.3.1.1 "><p id="obs_11_0001__p53462315226"><a href="obs_11_0007.html">Basic bucket management</a></p>
</td>
<td class="cellrowborder" valign="top" width="72.49%" headers="mcps1.3.6.3.2.3.1.2 "><p id="obs_11_0001__p8529162815477">Allows you to:</p>
<ul id="obs_11_0001__ul3120154594714"><li id="obs_11_0001__li5120174584718">Create buckets of different storage classes in specific regions.</li><li id="obs_11_0001__li8120134534716">Delete buckets.</li><li id="obs_11_0001__li6120174574710">Get the bucket list or configuration information.</li></ul>
</td>
</tr>
<tr id="obs_11_0001__row33415236221"><td class="cellrowborder" valign="top" width="27.51%" headers="mcps1.3.6.3.2.3.1.1 "><p id="obs_11_0001__p4341423112213"><a href="obs_11_0012.html">Basic object management</a></p>
</td>
<td class="cellrowborder" valign="top" width="72.49%" headers="mcps1.3.6.3.2.3.1.2 "><p id="obs_11_0001__p15341923152219">Allows you to upload, download, delete, and list objects. In detail, you can:</p>
<ul id="obs_11_0001__ul12642182419529"><li id="obs_11_0001__li764212415211">Upload one or more files or folders.</li><li id="obs_11_0001__li1590173085414">Upload large files in multipart uploads.</li><li id="obs_11_0001__li2774134519212">Synchronously upload, download, and copy incremental objects.</li><li id="obs_11_0001__li1465273410116">Copy a single object or a batch of objects sharing the same prefix.</li><li id="obs_11_0001__li18481351155216">Move a single object or a batch of objects sharing the same prefix.</li><li id="obs_11_0001__li18561144325">Resume failed upload, download, or copy tasks.</li></ul>
</td>
</tr>
<tr id="obs_11_0001__row181665745717"><td class="cellrowborder" valign="top" width="27.51%" headers="mcps1.3.6.3.2.3.1.1 "><p id="obs_11_0001__p13166074572"><a href="obs_11_0056.html">Logging</a></p>
</td>
<td class="cellrowborder" valign="top" width="72.49%" headers="mcps1.3.6.3.2.3.1.2 "><p id="obs_11_0001__p616618717570">Provides logging on your client to record operations on buckets and objects for analysis.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_11_0001__section547113329618"><h4 class="sectiontitle">Command Line Structures</h4><p id="obs_11_0001__p236115413127">Below describes how to use commands in obsutil:</p>
<ul id="obs_11_0001__ul76317975017"><li id="obs_11_0001__li116359175019">In Windows<p id="obs_11_0001__p1790953211619"><a name="obs_11_0001__li116359175019"></a><a name="li116359175019"></a><strong id="obs_11_0001__b15672515141519">obsutil </strong><em id="obs_11_0001__i103686209158">command</em> <em id="obs_11_0001__i20561425151511">[parameters...]</em> <em id="obs_11_0001__i634062931511">[options...]</em></p>
</li><li id="obs_11_0001__li11399121645012">In Linux or macOS<p id="obs_11_0001__p2143927135012"><a name="obs_11_0001__li11399121645012"></a><a name="li11399121645012"></a><strong id="obs_11_0001__b12431423202411"><strong id="obs_11_0001__b9243142317241">./</strong>obsutil </strong><em id="obs_11_0001__i10743162417246">command [parameters...] [options...]</em></p>
</li></ul>
<div class="note" id="obs_11_0001__note243793631714"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="obs_11_0001__ul1941842151711"><li id="obs_11_0001__li139411442151716"><em id="obs_11_0001__i5488114417405">command</em> indicates the command to execute, for example, <strong id="obs_11_0001__b1419719384206">ls</strong> or <strong id="obs_11_0001__b619911380202">cp</strong>.</li><li id="obs_11_0001__li3148110101815"><em id="obs_11_0001__i0884172519426">parameters</em> indicates mandatory parameters, for example, the bucket name during bucket creation.</li><li id="obs_11_0001__li10580165711819"><em id="obs_11_0001__i19267611164315">options</em> indicates optional parameters. They must start with a hyphen (-).</li><li id="obs_11_0001__li18236578264">Square brackets ([]) are not part of a command. Remove them before executing a specific command.</li><li id="obs_11_0001__li138084514549">You must escape special characters (including &amp; &lt; &gt; and spaces) in a command using quotation marks. Single quotation marks are for Linux or macOS, and double quotation marks for Windows.</li><li id="obs_11_0001__li1599012256714">You can pass additional parameters in the <strong id="obs_11_0001__b2035734912219">-</strong><em id="obs_11_0001__i876825022212">key</em><strong id="obs_11_0001__b1784219591225">=</strong><em id="obs_11_0001__i66911162317">value</em> or <strong id="obs_11_0001__b1927130112310">-</strong><em id="obs_11_0001__i13931830152311">key</em><strong id="obs_11_0001__b1113863692318"> </strong><em id="obs_11_0001__i1999553715238">value</em> format, for example, <strong id="obs_11_0001__b1079615911207">-acl=private</strong>, or <strong id="obs_11_0001__b15798195902013">-acl private</strong>. Both formats are the same. Choose one as you like.</li><li id="obs_11_0001__li1172724912524">In Windows, you can execute <strong id="obs_11_0001__b19656615163910">obsutil.exe</strong> to enter interactive mode. In this mode, you can run <em id="obs_11_0001__i127091507427">command [parameters...] [options...]</em> where <strong id="obs_11_0001__b20857143624016">obsutil</strong> is not needed. Below gives an example:<pre class="screen" id="obs_11_0001__screen1512410439281">Enter "exit" or "quit" to logout
Enter "help" or "help command" to show help docs
Input your command:
--&gt;<strong id="obs_11_0001__b1037101413017">ls -limit=3 -s</strong>
obs://bucket-001
obs://bucket-002
obs://bucket-003
Bucket number: 3
Input your command:
--&gt;</pre>
</li><li id="obs_11_0001__li19286114217412">If you log in to a remote macOS or Linux via SSH to use obsutil, set <strong id="obs_11_0001__b85548772416">TMOUT</strong> to <strong id="obs_11_0001__b19487833121311">0</strong> to prevent obsutil from logging out due to SSH timeout.</li></ul>
</div></div>
</div>
</div>

15
docs/obs/tool-obsutil/obs_11_0002.html Normal file
View File

@ -0,0 +1,15 @@
<a name="obs_11_0002"></a><a name="obs_11_0002"></a>
<h1 class="topictitle1">Getting Started</h1>
<div id="body39451090"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_11_0061.html">Creating Access Keys (AK and SK)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0005.html">Initializing the Configuration</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0006.html">Quick Start</a></strong><br>
</li>
</ul>
</div>

89
docs/obs/tool-obsutil/obs_11_0003.html Normal file
View File

@ -0,0 +1,89 @@
<a name="obs_11_0003"></a><a name="obs_11_0003"></a>
<h1 class="topictitle1">Downloading and Installing obsutil</h1>
<div id="body1542440101579"><div class="section" id="obs_11_0003__section9569141920115"><h4 class="sectiontitle">Download Links</h4><div class="p" id="obs_11_0003__p15702618900"><a href="#obs_11_0003__table57021618505">Table 1</a> lists the download links of obsutil for different OSs.
<div class="tablenoborder"><a name="obs_11_0003__table57021618505"></a><a name="table57021618505"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_11_0003__table57021618505" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Download links of obsutil</caption><thead align="left"><tr id="obs_11_0003__row770310181303"><th align="left" class="cellrowborder" valign="top" width="25.202520252025206%" id="mcps1.3.1.2.2.2.5.1.1"><p id="obs_11_0003__p17031184013">OS</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="32.31323132313232%" id="mcps1.3.1.2.2.2.5.1.2"><p id="obs_11_0003__p47039187019">Software Package</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.88218821882188%" id="mcps1.3.1.2.2.2.5.1.3"><p id="obs_11_0003__p1320910253455">Manual Verification Signature File</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.602060206020603%" id="mcps1.3.1.2.2.2.5.1.4"><p id="obs_11_0003__p266820124514">Automatic Verification Signature File</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_11_0003__row16703418109"><td class="cellrowborder" valign="top" width="25.202520252025206%" headers="mcps1.3.1.2.2.2.5.1.1 "><p id="obs_11_0003__p3703518503">Windows (64-bit)</p>
</td>
<td class="cellrowborder" valign="top" width="32.31323132313232%" headers="mcps1.3.1.2.2.2.5.1.2 "><p id="obs_11_0003__p177030181608"><a href="https://obsutil.obs.eu-de.otc.t-systems.com/obsutil_hcso_windows_amd64_5.7.9.zip" target="_blank" rel="noopener noreferrer">obsutil_windows64</a></p>
</td>
<td class="cellrowborder" valign="top" width="21.88218821882188%" headers="mcps1.3.1.2.2.2.5.1.3 "><p id="obs_11_0003__p16209102534514"><a href="https://obsutil.obs.eu-de.otc.t-systems.com/obsutil_hcso_windows_amd64_5.7.9.zip.asc" target="_blank" rel="noopener noreferrer">pgp</a></p>
</td>
<td class="cellrowborder" valign="top" width="20.602060206020603%" headers="mcps1.3.1.2.2.2.5.1.4 "><p id="obs_11_0003__p9664203453"><a href="https://obsutil.obs.eu-de.otc.t-systems.com/obsutil_hcso_windows_amd64_5.7.9.zip.p7s" target="_blank" rel="noopener noreferrer">cms</a></p>
</td>
</tr>
<tr id="obs_11_0003__row8703151812011"><td class="cellrowborder" valign="top" width="25.202520252025206%" headers="mcps1.3.1.2.2.2.5.1.1 "><p id="obs_11_0003__p87038181605">Linux AMD (64-bit)</p>
</td>
<td class="cellrowborder" valign="top" width="32.31323132313232%" headers="mcps1.3.1.2.2.2.5.1.2 "><p id="obs_11_0003__p1070317181010"><a href="https://obsutil.obs.eu-de.otc.t-systems.com/obsutil_hcso_linux_amd64_5.7.9.tar.gz" target="_blank" rel="noopener noreferrer">obsutil_linux_amd64</a></p>
</td>
<td class="cellrowborder" valign="top" width="21.88218821882188%" headers="mcps1.3.1.2.2.2.5.1.3 "><p id="obs_11_0003__p5737723141"><a href="https://obsutil.obs.eu-de.otc.t-systems.com/obsutil_hcso_linux_amd64_5.7.9.tar.gz.asc" target="_blank" rel="noopener noreferrer">pgp</a></p>
</td>
<td class="cellrowborder" valign="top" width="20.602060206020603%" headers="mcps1.3.1.2.2.2.5.1.4 "><p id="obs_11_0003__p973712231342"><a href="https://obsutil.obs.eu-de.otc.t-systems.com/obsutil_hcso_linux_amd64_5.7.9.tar.gz.p7s" target="_blank" rel="noopener noreferrer">cms</a></p>
</td>
</tr>
<tr id="obs_11_0003__row770314181102"><td class="cellrowborder" valign="top" width="25.202520252025206%" headers="mcps1.3.1.2.2.2.5.1.1 "><p id="obs_11_0003__p670316184011">Linux Arm (64-bit)</p>
</td>
<td class="cellrowborder" valign="top" width="32.31323132313232%" headers="mcps1.3.1.2.2.2.5.1.2 "><p id="obs_11_0003__p470314189012"><a href="https://obsutil.obs.eu-de.otc.t-systems.com/obsutil_hcso_linux_arm64_5.7.9.tar.gz" target="_blank" rel="noopener noreferrer">obsutil_linux_arm64</a></p>
</td>
<td class="cellrowborder" valign="top" width="21.88218821882188%" headers="mcps1.3.1.2.2.2.5.1.3 "><p id="obs_11_0003__p1588415245416"><a href="https://obsutil.obs.eu-de.otc.t-systems.com/obsutil_hcso_linux_arm64_5.7.9.tar.gz.asc" target="_blank" rel="noopener noreferrer">pgp</a></p>
</td>
<td class="cellrowborder" valign="top" width="20.602060206020603%" headers="mcps1.3.1.2.2.2.5.1.4 "><p id="obs_11_0003__p158844248419"><a href="https://obsutil.obs.eu-de.otc.t-systems.com/obsutil_hcso_linux_arm64_5.7.9.tar.gz.p7s" target="_blank" rel="noopener noreferrer">cms</a></p>
</td>
</tr>
<tr id="obs_11_0003__row187032187019"><td class="cellrowborder" valign="top" width="25.202520252025206%" headers="mcps1.3.1.2.2.2.5.1.1 "><p id="obs_11_0003__p107031618304">macOS (64-bit)</p>
</td>
<td class="cellrowborder" valign="top" width="32.31323132313232%" headers="mcps1.3.1.2.2.2.5.1.2 "><p id="obs_11_0003__p1670361811017"><a href="https://obsutil.obs.eu-de.otc.t-systems.com/obsutil_hcso_darwin_amd64_5.7.9.tar.gz" target="_blank" rel="noopener noreferrer">obsutil_mac64</a></p>
</td>
<td class="cellrowborder" valign="top" width="21.88218821882188%" headers="mcps1.3.1.2.2.2.5.1.3 "><p id="obs_11_0003__p1038817261848"><a href="https://obsutil.obs.eu-de.otc.t-systems.com/obsutil_hcso_darwin_amd64_5.7.9.tar.gz.asc" target="_blank" rel="noopener noreferrer">pgp</a></p>
</td>
<td class="cellrowborder" valign="top" width="20.602060206020603%" headers="mcps1.3.1.2.2.2.5.1.4 "><p id="obs_11_0003__p1338813261048"><a href="https://obsutil.obs.eu-de.otc.t-systems.com/obsutil_hcso_darwin_amd64_5.7.9.tar.gz.p7s" target="_blank" rel="noopener noreferrer">cms</a></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="obs_11_0003__section172833121114"><h4 class="sectiontitle">Getting Started with obsutil</h4><p id="obs_11_0003__p43711128152512">You can download obsutil and then use it without installation. Methods of downloading obsutil vary depending on the OS type.</p>
<div class="note" id="obs_11_0003__note11919123713248"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_11_0003__p1191923713245">Make sure that your cloud server has been connected to the Internet, or the obsutil installation will fail.</p>
</div></div>
<p id="obs_11_0003__p1557764102011"><strong id="obs_11_0003__b5762113892117">Windows</strong></p>
<ol id="obs_11_0003__ol240420147203"><li id="obs_11_0003__li240416148207"><span>Click the link provided on OBS Console to download the obsutil package to your local PC.</span></li><li id="obs_11_0003__li1040461462012"><span>Decompress the software package.</span></li><li id="obs_11_0003__li15404181462013"><span>Use Command Prompt to go to the decompressed folder and run obsutil commands.</span></li></ol>
<p id="obs_11_0003__p158064513221"></p>
<p id="obs_11_0003__p18169143402012"><strong id="obs_11_0003__b29631717154318">Linux</strong></p>
<ol id="obs_11_0003__ol59911607214"><li id="obs_11_0003__li893918282217"><span>Open the CLI and run the <strong id="obs_11_0003__b4178320145518">wget</strong> command for the download link provided on OBS Console to download obsutil to your local PC.</span><p><p id="obs_11_0003__p21598201912">Linux AMD (64-bit) and Linux x86 (64-bit):</p>
<div class="note" id="obs_11_0003__note1037074016226"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="obs_11_0003__ul171642313617"><li id="obs_11_0003__li9171123665">The URL after <strong id="obs_11_0003__b54901081154">wget</strong> is the download link of the installation package, for which you do not need to make any adaptations. To download the package, just copy and run the whole <strong id="obs_11_0003__b18823716830">wget</strong> command.</li><li id="obs_11_0003__li2174235612">You can also download the obsutil package from a PC running Windows and then use a cross-platform transfer tool (such as WinSCP) to transfer the package to your Linux host.</li></ul>
</div></div>
</p></li><li id="obs_11_0003__li12542182611218"><span>Run the following command in the directory where the obsutil package resides:</span><p><pre class="screen" id="obs_11_0003__screen1589045816445">tar -xzvf obsutil_linux_amd64.tar.gz</pre>
</p></li><li id="obs_11_0003__li1549455312119"><span>List the obsutil directory. <strong id="obs_11_0003__b3801751172610">x.x.x</strong> indicates the obsutil version.</span><p><pre class="screen" id="obs_11_0003__screen91591748416">ll
dr-x------ 2 root root 4096 Jan 5 2024 obsutil_linux_amd64_x.x.x
-rw------- 1 root root 3845484 Mar 27 17:05 obsutil_linux_amd64.tar.gz</pre>
</p></li><li id="obs_11_0003__li1669719945510"><span>Go to the directory where obsutil resides. <strong id="obs_11_0003__b0738144911279">x.x.x</strong> indicates the obsutil version.</span><p><pre class="screen" id="obs_11_0003__screen16340124610553">cd obsutil_linux_amd64_x.x.x</pre>
</p></li><li id="obs_11_0003__li165391822236"><span>Run the following command to grant the execute permissions for obsutil:</span><p><pre class="screen" id="obs_11_0003__screen13404138134911">chmod 755 obsutil</pre>
<div class="note" id="obs_11_0003__note16463737173119"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_11_0003__p18132124212313">This step is required, or error "No such file or directory" will be reported when you are querying the obsutil version number.</p>
</div></div>
</p></li><li id="obs_11_0003__li1747311498216"><span>Continue to run the following command in the directory. If the version number of obsutil is returned, the installation is successful.</span><p><pre class="screen" id="obs_11_0003__screen339273131612">./obsutil version
obsutil version:5.7.9, obssdk version:3.24.12
operating system:linux, arch:amd64</pre>
</p></li></ol>
<p id="obs_11_0003__p244811410225"></p>
<p id="obs_11_0003__p101818112220"><strong id="obs_11_0003__b151721947144510">macOS</strong></p>
<ol id="obs_11_0003__ol14254522182215"><li id="obs_11_0003__li225412228223"><span>Click the link provided on OBS Console to download the obsutil package to your local PC.</span></li><li id="obs_11_0003__li3255142219226"><span>Decompress the software package.</span></li><li id="obs_11_0003__li1025516221223"><span>Open the CLI, go to the directory where obsutil belongs, and run the following command to add execute permissions to obsutil:</span><p><pre class="screen" id="obs_11_0003__screen1832236145510">chmod 755 obsutil</pre>
</p></li></ol>
</div>
<div class="section" id="obs_11_0003__section164351032071"><h4 class="sectiontitle">References</h4><ul id="obs_11_0003__ul312475917719"><li id="obs_11_0003__li7124175919712"><a href="obs_11_0006.html">Quick Start</a></li><li id="obs_11_0003__li18437101799"><a href="obs_11_0066.html">Using the obsutil help Command to Search for Functions</a></li></ul>
</div>
</div>
<div></div>

144
docs/obs/tool-obsutil/obs_11_0005.html Normal file
View File

File diff suppressed because it is too large Load Diff

50
docs/obs/tool-obsutil/obs_11_0006.html Normal file
View File

@ -0,0 +1,50 @@
<a name="obs_11_0006"></a><a name="obs_11_0006"></a>
<h1 class="topictitle1">Quick Start</h1>
<div id="body1543223109231"><p id="obs_11_0006__p139221232154714">This section uses the Linux OS as an example to describe how to use obsutil to perform basic operations in OBS. For details, see .</p>
<div class="section" id="obs_11_0006__section16839141103914"><h4 class="sectiontitle">Prerequisites</h4><ul id="obs_11_0006__ul5731242256"><li id="obs_11_0006__li67313421456">You have obtained obsutil and completed <a href="obs_11_0005.html">initial configuration</a>.</li><li id="obs_11_0006__li167459436511">The directory saving obsutil is accessed.</li></ul>
</div>
<div class="section" id="obs_11_0006__section135809001613"><h4 class="sectiontitle">Procedure</h4><ol id="obs_11_0006__ol3968102411523"><li id="obs_11_0006__li396882414524"><span>Run the <strong id="obs_11_0006__b5989104805118">./obsutil mb obs://bucket-test</strong> command to create a bucket named <strong id="obs_11_0006__b132621652192518">bucket-test</strong> in the region.</span><p><pre class="screen" id="obs_11_0006__screen13835524185118"><strong id="obs_11_0006__b69984416325">./obsutil mb obs://bucket-test</strong>
Create bucket [bucket-test] successfully!</pre>
</p></li><li id="obs_11_0006__li09681624125214"><span>Run the <strong id="obs_11_0006__b1023912618181">./obsutil cp /temp/test.txt obs://bucket-test/test.txt</strong> command to upload the <strong id="obs_11_0006__b1510114622715">test.txt</strong> file to bucket <strong id="obs_11_0006__b0427175619278">bucket-test</strong>.</span><p><pre class="screen" id="obs_11_0006__screen11498175213334"><strong id="obs_11_0006__b1596785533418">./obsutil cp /temp/test.txt obs://bucket-test/test.txt</strong>
Parallel: 5 Jobs: 5
Threshold: 52428800 PartSize: 5242880
VerifyLength: false VerifyMd5: false
CheckpointDir: /temp/.obsutil_checkpoint
test.txt:[==============================================] 100.00% 48.47 KB/s 0s
Upload successfully, 4.44KB, /temp/test.txt --&gt; obs://bucket-test1/test.txt</pre>
<div class="note" id="obs_11_0006__note1277380127"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_11_0006__p137733019215">To upload local folder <strong id="obs_11_0006__b133117369333">test</strong> to the OBS bucket, run the following command:</p>
<pre class="screen" id="obs_11_0006__screen25741116634"><strong id="obs_11_0006__b135749165315">./obsutil cp /test/ obs://bucket-test -r -f</strong></pre>
<ul id="obs_11_0006__ul10521171019720"><li id="obs_11_0006__li769210121774">For details about the <strong id="obs_11_0006__b14434115212341">cp</strong> command, see <a href="obs_11_0013.html">Uploading an Object</a>.</li><li id="obs_11_0006__li95215101178">For more upload scenarios, see <a href="obs_11_0028.html">Upload</a>.</li></ul>
</div></div>
</p></li><li id="obs_11_0006__li149681624135218"><span>Run the <strong id="obs_11_0006__b73482127375">./obsutil cp obs://bucket-test/test.txt</strong> <strong id="obs_11_0006__b11350312103713">/temp/test1.txt</strong> command to download <strong id="obs_11_0006__b16843916143018">test.txt</strong> from bucket <strong id="obs_11_0006__b141083673016">bucket-test</strong> to a local PC.</span><p><pre class="screen" id="obs_11_0006__screen58581878364"><strong id="obs_11_0006__b26051549113611">./obsutil cp obs://bucket-test/test.txt</strong> <strong id="obs_11_0006__b36064490365">/temp/test1.txt</strong>
Parallel: 5 Jobs: 5
Threshold: 52428800 PartSize: 5242880
VerifyLength: false VerifyMd5: false
CheckpointDir: /temp/.obsutil_checkpoint
test.txt:[=============================================] 100.00% 775.52 KB/s 0s
Download successfully, 4.44KB, obs://bucket-test1/test.txt --&gt; /temp/test1.txt</pre>
<div class="note" id="obs_11_0006__note453713311673"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_11_0006__p1853711313713">To download directory <strong id="obs_11_0006__b3196201283814">test</strong> from the OBS bucket to the local folder <strong id="obs_11_0006__b19862630183810">temp</strong>, run the following command:</p>
<pre class="screen" id="obs_11_0006__screen16537931977"><strong id="obs_11_0006__b20537143119710">./obsutil cp obs://bucket-test/test /temp -r -f</strong></pre>
<ul id="obs_11_0006__ul353720312717"><li id="obs_11_0006__li1537183111716">For details about the <strong id="obs_11_0006__b3311626153917">cp</strong> command, see <a href="obs_11_0018.html">Downloading an Object</a>.</li><li id="obs_11_0006__li195374319716">For more download scenarios, see <a href="obs_11_0029.html">Download</a>.</li></ul>
</div></div>
</p></li><li id="obs_11_0006__li496812412526"><span>Run the <strong id="obs_11_0006__b457411313143">./obsutil rm obs://bucket-test/test.txt -f</strong> command to delete object <strong id="obs_11_0006__b208272459284">test.txt</strong> from bucket <strong id="obs_11_0006__b274119014294">bucket-test</strong>.</span><p><pre class="screen" id="obs_11_0006__screen114888144011"><strong id="obs_11_0006__b1946843954010">./obsutil rm obs://bucket-test/test.txt -f</strong>
Delete object [test.txt] in the bucket [bucket-test] successfully!</pre>
</p></li><li id="obs_11_0006__li17968172415521"><span>Run the <strong id="obs_11_0006__b1749332852013">./obsutil rm obs://bucket-test -f</strong> command to delete bucket <strong id="obs_11_0006__b14667152719299">bucket-test</strong>.</span><p><pre class="screen" id="obs_11_0006__screen3490488402"><strong id="obs_11_0006__b12402257144012">./obsutil rm obs://bucket-test -f</strong>
Delete bucket [bucket-test] successfully!</pre>
</p></li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0002.html">Getting Started</a></div>
</div>
</div>

19
docs/obs/tool-obsutil/obs_11_0007.html Normal file
View File

@ -0,0 +1,19 @@
<a name="obs_11_0007"></a><a name="obs_11_0007"></a>
<h1 class="topictitle1">Bucket Commands</h1>
<div id="body1542438931293"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_11_0008.html">Creating a Bucket</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0009.html">Listing Buckets</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0010.html">Querying Bucket Properties</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0040.html">Setting Bucket Properties</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0011.html">Deleting a Bucket</a></strong><br>
</li>
</ul>
</div>

94
docs/obs/tool-obsutil/obs_11_0008.html Normal file
View File

@ -0,0 +1,94 @@
<a name="obs_11_0008"></a><a name="obs_11_0008"></a>
<h1 class="topictitle1">Creating a Bucket</h1>
<div id="body1542440101580"><div class="section" id="obs_11_0008__section1479112110815"><h4 class="sectiontitle">Function</h4><p id="obs_11_0008__p11772825481">You can use this command to create a bucket. A bucket name must be unique in OBS. One account can create a maximum of 100 buckets.</p>
<div class="note" id="obs_11_0008__note722632711349"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_11_0008__p766115412477">If you create a bucket and name it the same as an existing one in the same account and region, no error will be reported and status code 200 is returned. The bucket properties comply with those set in the first creation request. In other cases, creating a bucket with the same name as an existing one will receive the status code 409, indicating that the bucket already exists.</p>
</div></div>
</div>
<div class="section" id="obs_11_0008__section1220752192216"><h4 class="sectiontitle">Command Line Structures</h4><ul id="obs_11_0008__ul832417119303"><li id="obs_11_0008__li19324181113010">Windows<pre class="screen" id="obs_11_0008__screen69741218113010">obsutil mb obs://bucket [-fs] [-acl=xxx] [-sc=xxx] [-location=xxx] [-config=xxx] </pre>
</li><li id="obs_11_0008__li1476086143015">macOS or Linux<pre class="screen" id="obs_11_0008__screen82451326103012">./obsutil mb obs://bucket [-fs] [-acl=xxx] [-sc=xxx] [-location=xxx] [-config=xxx] </pre>
</li></ul>
</div>
<div class="section" id="obs_11_0008__section1922135817426"><h4 class="sectiontitle">Examples</h4><ul id="obs_11_0008__ul11221105812429"><li id="obs_11_0008__li12211358154213">In Windows, run <strong id="obs_11_0008__b129741610194715">obsutil mb obs://bucket-test</strong> to create a bucket. The creation succeeds.<pre class="screen" id="obs_11_0008__screen9221195824210"><strong id="obs_11_0008__b222165810424">obsutil mb obs://bucket-test</strong>
Start at 2024-09-29 07:52:11.3769487 +0000 UTC
Create bucket [bucket-test] successfully, request id [000001923CC401864018BA75753D2D5F]
</pre>
</li></ul>
<ul id="obs_11_0008__ul17222155814420"><li id="obs_11_0008__li2222135818421">In Windows, run <strong id="obs_11_0008__b1831485734714">obsutil mb obs://bucket001</strong> to create a bucket with the same name as a bucket owned by another account. The creation fails.<pre class="screen" id="obs_11_0008__screen0222115810426"><strong id="obs_11_0008__b13222358164215">obsutil mb obs://bucket001</strong>
Start at 2024-09-30 07:03:50.1378331 +0000 UTC
Create bucket [bucket001] failed, status [409], error code [BucketAlreadyExists], error message [The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.], request id [0000019241BE18DB4019EDD66E135C56]</pre>
</li></ul>
</div>
<div class="section" id="obs_11_0008__section6559191102418"><h4 class="sectiontitle">Parameter Description</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_11_0008__table10831182114445" frame="border" border="1" rules="all"><thead align="left"><tr id="obs_11_0008__row683212154419"><th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.4.2.1.4.1.1"><p id="obs_11_0008__p118329219446">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.4.2.1.4.1.2"><p id="obs_11_0008__p15137125919108">Optional or Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="65%" id="mcps1.3.4.2.1.4.1.3"><p id="obs_11_0008__p12832121184414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_11_0008__row108328217449"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0008__p64495172515">bucket</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0008__p154316502519">Mandatory</p>
</td>
<td class="cellrowborder" valign="top" width="65%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0008__p17425512259">The bucket name</p>
<div class="p" id="obs_11_0008__p1748811361418">A bucket name:<ul id="obs_11_0008__ul1748816130141"><li id="obs_11_0008__li2488101341418">Must be 3 to 63 characters long and start with a digit or letter. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.</li><li id="obs_11_0008__li448821313144">Cannot be formatted as an IP address.</li><li id="obs_11_0008__li194885136143">Cannot start or end with a hyphen (-) or period (.).</li><li id="obs_11_0008__li0488191351418">Cannot contain two consecutive periods (.), for example, <strong id="obs_11_0008__b842352706191036">my..bucket</strong>.</li><li id="obs_11_0008__li194884137146">Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, <strong id="obs_11_0008__b53955432910">my-.bucket</strong> or <strong id="obs_11_0008__b139454102920">my.-bucket</strong>.</li></ul>
</div>
</td>
</tr>
<tr id="obs_11_0008__row1965719371463"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0008__p1765810371962">fs</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0008__p262154512618">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="65%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0008__p1765812372061">Creates a parallel file system.</p>
</td>
</tr>
<tr id="obs_11_0008__row19509222417"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0008__p159501222414">acl</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0008__p4950172216419">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="65%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0008__p538785162317">The access control policy that can be specified when creating a bucket</p>
<p id="obs_11_0008__p16811512123619">The value can be:</p>
<ul id="obs_11_0008__ul1273864144412"><li id="obs_11_0008__li17738649445"><strong id="obs_11_0008__b1653141954610">private</strong>: Only users granted permissions by the bucket ACL can access the bucket.</li><li id="obs_11_0008__li1551213137447"><strong id="obs_11_0008__b201358282509">public-read</strong>: Anyone can read objects in the bucket.</li><li id="obs_11_0008__li1287691813449"><strong id="obs_11_0008__b798925420505">public-read-write</strong>: Anyone can read, write, or delete objects in the bucket.</li></ul>
</td>
</tr>
<tr id="obs_11_0008__row8533319194211"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0008__p19533119154211">sc</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0008__p4533191944218">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="65%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0008__p7476142451913">The storage class of the bucket</p>
<p id="obs_11_0008__p17381132810197">Different storage classes meet customers' needs for storage performance and costs.</p>
<p id="obs_11_0008__p86547153813">The value can be:</p>
<ul id="obs_11_0008__ul175651814214"><li id="obs_11_0008__li1256512172114"><strong id="obs_11_0008__b5806518121118">standard</strong>: Standard storage class. It features low access latency and high throughput, and is applicable to storing frequently accessed data (multiple accesses per month) or data that is smaller than 1 MB.</li><li id="obs_11_0008__li10565181142113"><strong id="obs_11_0008__b16412411234">warm</strong>: Warm storage class. It is ideal for storing infrequently accessed (less than 12 times a year) data, but when needed, the access has to be fast.</li><li id="obs_11_0008__li756616110216"><strong id="obs_11_0008__b42301244122318">cold</strong>: Cold storage class. It provides secure, durable, and inexpensive storage for rarely-accessed (once a year) data.</li></ul>
</td>
</tr>
<tr id="obs_11_0008__row116471725174219"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0008__p16475251428">location</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0008__p62572833155512">Mandatory unless the requested OBS region is the default one (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="65%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0008__p5359820175320">The region where the bucket resides</p>
<p id="obs_11_0008__p18031111102213"></p>
<ul id="obs_11_0008__ul1316912157296"><li id="obs_11_0008__li19336162042916"><strong id="obs_11_0008__b42441216183512">Once the bucket is created, its region cannot be changed.</strong></li><li id="obs_11_0008__li16169315112920">For lower latency and faster access, select the region nearest to where the data will be accessed.</li></ul>
</td>
</tr>
<tr id="obs_11_0008__row03949318313"><td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0008__p153951131317">config</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0008__p12395135316">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="65%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0008__p1750111452317">The user-defined configuration file for executing the current command. For details about parameters that can be configured, see <a href="obs_11_0035.html">Configuration Parameters</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0007.html">Bucket Commands</a></div>
</div>
</div>

96
docs/obs/tool-obsutil/obs_11_0009.html Normal file
View File

@ -0,0 +1,96 @@
<a name="obs_11_0009"></a><a name="obs_11_0009"></a>
<h1 class="topictitle1">Listing Buckets</h1>
<div id="body1542440101580"><div class="section" id="obs_11_0009__section1479112110815"><h4 class="sectiontitle">Function</h4><p id="obs_11_0009__p07733388177">You can use this command to obtain the bucket list. In the list, bucket names are displayed in lexicographical order.</p>
</div>
<div class="section" id="obs_11_0009__section1220752192216"><h4 class="sectiontitle">Command Line Structure</h4><ul id="obs_11_0009__ul45221840132020"><li id="obs_11_0009__li12524194015203">In Windows<pre class="screen" id="obs_11_0009__screen1959918571209">obsutil ls [-s] [-sc] [-du] [-fs] [-j=1] [-limit=1] [-config=xxx] </pre>
</li><li id="obs_11_0009__li8135134682010">In Linux or macOS<pre class="screen" id="obs_11_0009__screen18417544214">./obsutil ls [-s] [-sc] [-du] [-fs] [-j=1] [-limit=1] [-config=xxx] </pre>
</li></ul>
</div>
<div class="section" id="obs_11_0009__section1364541974317"><h4 class="sectiontitle">Examples</h4><ul id="obs_11_0009__ul6645219174310"><li id="obs_11_0009__li36461519174314">Take the Windows OS as an example. Run the <strong id="obs_11_0009__b129741610194715">obsutil ls -limit=5</strong> command to obtain the bucket list.<pre class="screen" id="obs_11_0009__screen2646161915433"><strong id="obs_11_0009__b36461519194313">obsutil ls -limit=5</strong>
Start at 2024-09-29 07:58:46.0506904 +0000 UTC
Bucket CreationDate Location BucketType
obs://bucket001 2018-09-03T01:53:02Z example OBJECT
obs://bucket002 2018-11-01T01:40:01Z example OBJECT
obs://bucket003 2018-10-25T11:45:45Z example OBJECT
obs://bucket004 2018-10-26T02:33:09Z example OBJECT
obs://bucket005 2018-10-26T02:34:50Z example OBJECT
Bucket number : 5</pre>
</li></ul>
</div>
<div class="section" id="obs_11_0009__section6559191102418"><h4 class="sectiontitle">Parameter Description</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_11_0009__table10831182114445" frame="border" border="1" rules="all"><thead align="left"><tr id="obs_11_0009__row683212154419"><th align="left" class="cellrowborder" valign="top" width="18.07%" id="mcps1.3.4.2.1.4.1.1"><p id="obs_11_0009__p118329219446">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.2%" id="mcps1.3.4.2.1.4.1.2"><p id="obs_11_0009__p15137125919108">Optional or Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.730000000000004%" id="mcps1.3.4.2.1.4.1.3"><p id="obs_11_0009__p12832121184414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_11_0009__row167881281811"><td class="cellrowborder" valign="top" width="18.07%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0009__p37889281012">s</p>
</td>
<td class="cellrowborder" valign="top" width="33.2%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0009__p177888281316">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="48.730000000000004%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0009__p1378816281111">Displays simplified query result.</p>
<div class="note" id="obs_11_0009__note1452085114212"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="obs_11_0009__p252035122111">In the simplified format, the returned result contains only the bucket name.</p>
</div></div>
</td>
</tr>
<tr id="obs_11_0009__row03718287317"><td class="cellrowborder" valign="top" width="18.07%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0009__p93721828432">sc</p>
</td>
<td class="cellrowborder" valign="top" width="33.2%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0009__p15372132812313">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="48.730000000000004%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0009__p13372228533">Queries the storage classes of the buckets when listing buckets.</p>
</td>
</tr>
<tr id="obs_11_0009__row191337306418"><td class="cellrowborder" valign="top" width="18.07%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0009__p1913323010414">j</p>
</td>
<td class="cellrowborder" valign="top" width="33.2%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0009__p171337309410">Optional (additional parameter). It must be used together with <strong id="obs_11_0009__b770944718612">sc</strong>.</p>
</td>
<td class="cellrowborder" valign="top" width="48.730000000000004%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0009__p1513363013419">The maximum number of concurrent tasks for querying the bucket storage class. The default value is the value of <strong id="obs_11_0009__b129310433513">defaultJobs</strong> in the configuration file.</p>
<div class="note" id="obs_11_0009__note891964620819"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="obs_11_0009__p1091964618820">The value is ensured to be greater than or equal to 1.</p>
</div></div>
</td>
</tr>
<tr id="obs_11_0009__row3926112051616"><td class="cellrowborder" valign="top" width="18.07%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0009__p1192652014163">du</p>
</td>
<td class="cellrowborder" valign="top" width="33.2%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0009__p6926120161618">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="48.730000000000004%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0009__p11926720121619">Quickly returns the total size of listed objects, without displaying detailed object information. This parameter can be used together with other parameters.</p>
<div class="note" id="obs_11_0009__note149111923132813"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="obs_11_0009__p1788521362916">This parameter takes effect only on listing objects, but not on listing buckets.</p>
</div></div>
</td>
</tr>
<tr id="obs_11_0009__row918019240510"><td class="cellrowborder" valign="top" width="18.07%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0009__p1918111241654">limit</p>
</td>
<td class="cellrowborder" valign="top" width="33.2%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0009__p218113247513">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="48.730000000000004%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0009__p310214615616">The maximum number of buckets that can be queried. If the value is less than 0, all buckets are listed. If it is left blank, a maximum of 1000 buckets can be listed by default.</p>
</td>
</tr>
<tr id="obs_11_0009__row617302812339"><td class="cellrowborder" valign="top" width="18.07%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0009__p153951131317">config</p>
</td>
<td class="cellrowborder" valign="top" width="33.2%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0009__p12395135316">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="48.730000000000004%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0009__obs_11_0008_p1750111452317">The user-defined configuration file for executing the current command. For details about parameters that can be configured, see <a href="obs_11_0035.html">Configuration Parameters</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="note" id="obs_11_0009__note95319172523"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_11_0009__p1253817115217">In a bucket listing result, <strong id="obs_11_0009__b1051714190219">BucketType</strong> indicates the bucket type. <strong id="obs_11_0009__b152214462110">OBJECT</strong> indicates an object storage bucket, while <strong id="obs_11_0009__b972216919224">POSIX</strong> indicates a parallel file system.</p>
</div></div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0007.html">Bucket Commands</a></div>
</div>
</div>

153
docs/obs/tool-obsutil/obs_11_0010.html Normal file
View File

File diff suppressed because it is too large Load Diff

68
docs/obs/tool-obsutil/obs_11_0011.html Normal file
View File

@ -0,0 +1,68 @@
<a name="obs_11_0011"></a><a name="obs_11_0011"></a>
<h1 class="topictitle1">Deleting a Bucket</h1>
<div id="body1542440101580"><div class="section" id="obs_11_0011__section1479112110815"><h4 class="sectiontitle">Function</h4><p id="obs_11_0011__p11772825481">You can use this command to delete a bucket. The bucket to be deleted must be empty (containing no objects, historical versions, or fragments).</p>
<div class="note" id="obs_11_0011__note1711716215438"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_11_0011__p1611722112431">To delete a non-empty bucket, run the commands in <a href="obs_11_0020.html">Deleting a Multipart Upload Task</a> and <a href="obs_11_0021.html">Deleting an Object</a> to clear the bucket, and then run the following command to delete the bucket.</p>
</div></div>
</div>
<div class="section" id="obs_11_0011__section1220752192216"><h4 class="sectiontitle">Command Line Structure</h4><ul id="obs_11_0011__ul244723415233"><li id="obs_11_0011__li14447534112318">In Windows<pre class="screen" id="obs_11_0011__screen14572446102313">obsutil rm obs://bucket [-f] [-config=xxx] </pre>
</li><li id="obs_11_0011__li15751935112310">In Linux or macOS<pre class="screen" id="obs_11_0011__screen172710523237">./obsutil rm obs://bucket [-f] [-config=xxx] </pre>
</li></ul>
</div>
<div class="section" id="obs_11_0011__section105489664410"><h4 class="sectiontitle">Examples</h4><ul id="obs_11_0011__ul0548196134413"><li id="obs_11_0011__li1548146114410">Take the Windows OS as an example. Run the <strong id="obs_11_0011__b1749332852013">obsutil rm obs://bucket-test</strong> command to delete bucket <strong id="obs_11_0011__b1590635151018">bucket-test</strong>.<pre class="screen" id="obs_11_0011__screen154996164419"><strong id="obs_11_0011__b954936184420">obsutil rm obs://bucket-test</strong>
Start at 2024-09-30 07:58:33.736622 +0000 UTC
Do you want to delete bucket [bucket-test] ? Please input (y/n) to confirm:
y
Delete bucket [bucket-test] successfully!</pre>
</li></ul>
</div>
<div class="section" id="obs_11_0011__section6559191102418"><h4 class="sectiontitle">Parameter Description</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_11_0011__table10831182114445" frame="border" border="1" rules="all"><thead align="left"><tr id="obs_11_0011__row683212154419"><th align="left" class="cellrowborder" valign="top" width="16.16161616161616%" id="mcps1.3.4.2.1.4.1.1"><p id="obs_11_0011__p118329219446">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.28282828282828%" id="mcps1.3.4.2.1.4.1.2"><p id="obs_11_0011__p15137125919108">Optional or Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.55555555555556%" id="mcps1.3.4.2.1.4.1.3"><p id="obs_11_0011__p12832121184414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_11_0011__row108328217449"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0011__p64495172515">bucket</p>
</td>
<td class="cellrowborder" valign="top" width="28.28282828282828%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0011__p154316502519">Mandatory</p>
</td>
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0011__p17425512259">The bucket name</p>
</td>
</tr>
<tr id="obs_11_0011__row107241436114819"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0011__p5724123684813">f</p>
</td>
<td class="cellrowborder" valign="top" width="28.28282828282828%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0011__p1272453612483">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0011__p972417362487">Runs in force mode.</p>
</td>
</tr>
<tr id="obs_11_0011__row1660212336344"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0011__p153951131317">config</p>
</td>
<td class="cellrowborder" valign="top" width="28.28282828282828%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0011__p12395135316">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0011__obs_11_0008_p1750111452317">The user-defined configuration file for executing the current command. For details about parameters that can be configured, see <a href="obs_11_0035.html">Configuration Parameters</a>.</p>
</td>
</tr>
<tr id="obs_11_0011__row770220073410"><td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0011__p1966666191820">payer</p>
</td>
<td class="cellrowborder" valign="top" width="28.28282828282828%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0011__p1266611611820">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="55.55555555555556%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0011__p1166617619181">Specifies that requester pays is enabled.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0007.html">Bucket Commands</a></div>
</div>
</div>

53
docs/obs/tool-obsutil/obs_11_0012.html Normal file
View File

@ -0,0 +1,53 @@
<a name="obs_11_0012"></a><a name="obs_11_0012"></a>
<h1 class="topictitle1">Object Commands</h1>
<div id="body1542943180896"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_11_0050.html">Creating a Folder</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0013.html">Uploading an Object</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0015.html">Querying Object Properties</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0041.html">Setting Object Properties</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0014.html">Listing Objects</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0017.html">Copying an Object</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0053.html">Moving an Object</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0018.html">Downloading an Object</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0051.html">Generating the Download Link of an Object</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0021.html">Deleting an Object</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0042.html">Synchronously Uploading Incremental Objects</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0044.html">Synchronously Copying Incremental Objects</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0043.html">Synchronously Downloading Incremental Objects</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0016.html">Restoring Objects from the Cold Storage</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0036.html">Resuming a Failed Upload Task</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0037.html">Resuming a Failed Copy Task</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0038.html">Resuming a Failed Download Task</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0019.html">Listing Multipart Upload Tasks</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0020.html">Deleting a Multipart Upload Task</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0062.html">Creating an Authorization Code for Directory Sharing</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0063.html">Listing Objects by Using an Authorization Code</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0064.html">Downloading Objects by Using an Authorization Code</a></strong><br>
</li>
</ul>
</div>

492
docs/obs/tool-obsutil/obs_11_0013.html Normal file
View File

File diff suppressed because it is too large Load Diff

246
docs/obs/tool-obsutil/obs_11_0014.html Normal file
View File

File diff suppressed because it is too large Load Diff

165
docs/obs/tool-obsutil/obs_11_0015.html Normal file
View File

File diff suppressed because it is too large Load Diff

156
docs/obs/tool-obsutil/obs_11_0016.html Normal file
View File

File diff suppressed because it is too large Load Diff

329
docs/obs/tool-obsutil/obs_11_0017.html Normal file
View File

File diff suppressed because it is too large Load Diff

298
docs/obs/tool-obsutil/obs_11_0018.html Normal file
View File

File diff suppressed because it is too large Load Diff

144
docs/obs/tool-obsutil/obs_11_0019.html Normal file
View File

File diff suppressed because it is too large Load Diff

134
docs/obs/tool-obsutil/obs_11_0020.html Normal file
View File

File diff suppressed because it is too large Load Diff

156
docs/obs/tool-obsutil/obs_11_0021.html Normal file
View File

File diff suppressed because it is too large Load Diff

19
docs/obs/tool-obsutil/obs_11_0022.html Normal file
View File

@ -0,0 +1,19 @@
<a name="obs_11_0022"></a><a name="obs_11_0022"></a>
<h1 class="topictitle1">Auxiliary Commands</h1>
<div id="body1542438931293"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_11_0023.html">Updating a Configuration File</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0024.html">Deleting Part Records</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0025.html">Viewing Command Help Information</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0026.html">Querying the Version Number</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0045.html">Archiving Log Files</a></strong><br>
</li>
</ul>
</div>

85
docs/obs/tool-obsutil/obs_11_0023.html Normal file
View File

@ -0,0 +1,85 @@
<a name="obs_11_0023"></a><a name="obs_11_0023"></a>
<h1 class="topictitle1">Updating a Configuration File</h1>
<div id="body1542440101580"><div class="section" id="obs_11_0023__section1479112110815"><h4 class="sectiontitle">Function</h4><p id="obs_11_0023__p383175684016">You can update items in the <strong id="obs_11_0023__b6913161817">.obsutilconfig</strong> file, including the endpoint, AK, SK, and token.</p>
<p id="obs_11_0023__p11772825481"><a href="obs_11_0035.html">Configuration Parameters</a> describes parameters in the <strong id="obs_11_0023__b1292416325715">.obsutilconfig</strong> file.</p>
</div>
<div class="section" id="obs_11_0023__section1220752192216"><h4 class="sectiontitle">Command Line Structure</h4><ul id="obs_11_0023__ul10922428121013"><li id="obs_11_0023__li79221528121010">In Windows<pre class="screen" id="obs_11_0023__screen1230482601819">obsutil config -interactive [-crr] [-config=xxx]</pre>
</li><li id="obs_11_0023__li106087324101">In Linux or macOS<pre class="screen" id="obs_11_0023__screen82312020141914">./obsutil config -interactive [-crr] [-config=xxx]</pre>
</li></ul>
</div>
<div class="section" id="obs_11_0023__section16155112411445"><h4 class="sectiontitle">Examples</h4><ul id="obs_11_0023__ul155769421319"><li id="obs_11_0023__li115761746133">Take Windows as an example. Run the <strong id="obs_11_0023__b369616289395">obsutil config -interactive</strong> command to update the access keys and OBS endpoint in the default configuration file.<pre class="screen" id="obs_11_0023__screen41561524164419"><strong id="obs_11_0023__b1415632419447">obsutil config -interactive</strong>
Please input your ak:
xxxxxxxxxxxxxxxxxxxxxxxxx
Please input your sk:
xxxxxxxxxxxxxxxxxxxxxxxxx
Please input your endpoint:
xxxxxxxxxxxxxxxxxxxxxxxxx
Please input your token:
xxxxxxxxxxxxxxxxxxxxxxxxx
Config file url:
C:\Users\tools\.obsutilconfig
Update config file successfully!</pre>
</li><li id="obs_11_0023__li1760158161313">Take Linux as an example. Run the <strong id="obs_11_0023__b127711743182719">./obsutil config -interactive</strong> command to update the access keys and OBS endpoint in the default configuration file.<pre class="screen" id="obs_11_0023__screen237717508120"><strong id="obs_11_0023__b037713505122">./obsutil config -interactive</strong>
Please input your ak:
xxxxxxxxxxxxxxxxxxxxxxxxx
Please input your sk:
xxxxxxxxxxxxxxxxxxxxxxxxx
Please input your endpoint:
xxxxxxxxxxxxxxxxxxxxxxxxx
Please input your token:
xxxxxxxxxxxxxxxxxxxxxxxxx
Config file url:
/root/.obsutilconfig
Update config file successfully!</pre>
</li></ul>
</div>
<div class="section" id="obs_11_0023__section6559191102418"><h4 class="sectiontitle">Parameter Description</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_11_0023__table10831182114445" frame="border" border="1" rules="all"><thead align="left"><tr id="obs_11_0023__row683212154419"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.1.4.1.1"><p id="obs_11_0023__p118329219446">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.999999999999996%" id="mcps1.3.4.2.1.4.1.2"><p id="obs_11_0023__p15137125919108">Optional or Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.00000000000001%" id="mcps1.3.4.2.1.4.1.3"><p id="obs_11_0023__p12832121184414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_11_0023__row16853134519558"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0023__p8853194565517">interactive</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0023__p58549456559">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0023__p1585474515513">Updates settings in interactive mode.</p>
</td>
</tr>
<tr id="obs_11_0023__row95195143518"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0023__p185285143520">crr</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0023__p466619556356">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0023__p1052135112358">Updates the settings of client-side cross-region replication.</p>
<div class="note" id="obs_11_0023__note1841535164114"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="obs_11_0023__p1839858112920">If this parameter is not specified, <strong id="obs_11_0023__b18914112963817">endpoint</strong>, <strong id="obs_11_0023__b195731832173813">ak</strong>, <strong id="obs_11_0023__b2762234103813">sk</strong>, and <strong id="obs_11_0023__b6572204315382">token</strong> will be updated.</p>
<p id="obs_11_0023__p784163511412">If this parameter is specified, <strong id="obs_11_0023__b13673175820438">endpointCrr</strong>, <strong id="obs_11_0023__b11638219449">akCrr</strong>, <strong id="obs_11_0023__b125108544411">skCrr</strong>, and <strong id="obs_11_0023__b1014619108447">tokenCrr</strong> will be updated.</p>
</div></div>
</td>
</tr>
<tr id="obs_11_0023__row9445101517387"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0023__p153951131317">config</p>
</td>
<td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0023__p12395135316">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0023__p732245114477">The user-defined configuration file for executing the current command. For details about parameters that can be configured, see <a href="obs_11_0035.html">Configuration Parameters</a>.</p>
<p id="obs_11_0023__p43952034313">By specifying this parameter and a path, you can update parameters in the user-defined configuration file. Otherwise, parameters in the default configuration file will be updated.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0022.html">Auxiliary Commands</a></div>
</div>
</div>

80
docs/obs/tool-obsutil/obs_11_0024.html Normal file
View File

@ -0,0 +1,80 @@
<a name="obs_11_0024"></a><a name="obs_11_0024"></a>
<h1 class="topictitle1">Deleting Part Records</h1>
<div id="body1542440101580"><div class="section" id="obs_11_0024__section1479112110815"><h4 class="sectiontitle">Function</h4><p id="obs_11_0024__p11772825481">You can use this command to delete part records from a specified directory.</p>
</div>
<div class="section" id="obs_11_0024__section1220752192216"><h4 class="sectiontitle">Command Line Structure</h4><ul id="obs_11_0024__ul8701213201118"><li id="obs_11_0024__li27013135110">In Windows<pre class="screen" id="obs_11_0024__screen8653829141115">obsutil clear [checkpoint_dir] [-u] [-d] [-c] [-config=xxx] </pre>
</li><li id="obs_11_0024__li14931417171112">In Linux or macOS<pre class="screen" id="obs_11_0024__screen36512381111">./obsutil clear [checkpoint_dir] [-u] [-d] [-c] [-config=xxx] </pre>
</li></ul>
</div>
<div class="section" id="obs_11_0024__section571274494420"><h4 class="sectiontitle">Examples</h4><ul id="obs_11_0024__ul1771284454418"><li id="obs_11_0024__li197121444144411">Take the Windows OS as an example. Run the <strong id="obs_11_0024__b369616289395">obsutil clear -u</strong> command to delete the part records of multipart upload tasks in the default directory.<pre class="screen" id="obs_11_0024__screen14712144424410"><strong id="obs_11_0024__b14713124416448">obsutil clear -u</strong>
Clear checkpoint files for uploading in folder [xxxxx]
Start at 2024-10-08 01:49:37.6541204 +0000 UTC
[==================================================================] 100.00% 0s
Succeed files is: 1 Failed files is: 0</pre>
</li></ul>
</div>
<div class="section" id="obs_11_0024__section6559191102418"><h4 class="sectiontitle">Parameter Description</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_11_0024__table10831182114445" frame="border" border="1" rules="all"><thead align="left"><tr id="obs_11_0024__row683212154419"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.1.4.1.1"><p id="obs_11_0024__p118329219446">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.4.2.1.4.1.2"><p id="obs_11_0024__p15137125919108">Optional or Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61%" id="mcps1.3.4.2.1.4.1.3"><p id="obs_11_0024__p12832121184414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_11_0024__row108328217449"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0024__p64495172515">checkpoint_dir</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0024__p154316502519">Optional</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0024__p17425512259">The folder where the part records reside. The default value is <strong id="obs_11_0024__b5631204151111">.obsutil_checkpoint</strong>, the same subfolder where obsutil commands reside.</p>
</td>
</tr>
<tr id="obs_11_0024__row32014962815"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0024__p82054920283">u</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0024__p4454146102911">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0024__p52015497289">Deletes the part records of all multipart upload tasks.</p>
<div class="note" id="obs_11_0024__note148764412348"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="obs_11_0024__p184871144203418">At the same time, the system attempts to delete the multipart upload tasks in the part records.</p>
</div></div>
</td>
</tr>
<tr id="obs_11_0024__row1155655010280"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0024__p1655610501288">d</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0024__p124553652918">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0024__p1055655042814">Deletes the part records of all multipart download tasks.</p>
<div class="note" id="obs_11_0024__note1018343543718"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="obs_11_0024__p18183183523719">At the same time, the system attempts to delete the fragments in the part records.</p>
</div></div>
</td>
</tr>
<tr id="obs_11_0024__row5616115192814"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0024__p561675112281">c</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0024__p745815619297">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0024__p14616651172819">Deletes the part records of all multipart copy tasks.</p>
<div class="note" id="obs_11_0024__note28911225113717"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="obs_11_0024__p12892112516371">At the same time, the system attempts to delete the multipart copy tasks in the part records.</p>
</div></div>
</td>
</tr>
<tr id="obs_11_0024__row20579102283818"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0024__p153951131317">config</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0024__p12395135316">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0024__p43952034313">The user-defined configuration file for executing a command. For details about parameters that can be configured, see <a href="obs_11_0035.html">Configuration Parameters</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="obs_11_0024__note6773171042911"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_11_0024__p9773171010299">You must configure at least one among the <strong id="obs_11_0024__b672519523478">u</strong>, <strong id="obs_11_0024__b10994195434711">d</strong> and <strong id="obs_11_0024__b114516582478">c</strong> parameters.</p>
</div></div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0022.html">Auxiliary Commands</a></div>
</div>
</div>

105
docs/obs/tool-obsutil/obs_11_0025.html Normal file
View File

File diff suppressed because it is too large Load Diff

22
docs/obs/tool-obsutil/obs_11_0026.html Normal file
View File

@ -0,0 +1,22 @@
<a name="obs_11_0026"></a><a name="obs_11_0026"></a>
<h1 class="topictitle1">Querying the Version Number</h1>
<div id="body1542440101580"><div class="section" id="obs_11_0026__section1479112110815"><h4 class="sectiontitle">Function</h4><p id="obs_11_0026__p11772825481">You can use this command to query the current version of obsutil.</p>
</div>
<div class="section" id="obs_11_0026__section1220752192216"><h4 class="sectiontitle">Command Line Structure</h4><ul id="obs_11_0026__ul15143334141212"><li id="obs_11_0026__li19143634121216">In Windows<pre class="screen" id="obs_11_0026__screen445811487122">obsutil version</pre>
</li><li id="obs_11_0026__li1572043717123">In Linux or macOS<pre class="screen" id="obs_11_0026__screen1627105541213">./obsutil version</pre>
</li></ul>
</div>
<div class="section" id="obs_11_0026__section15899161919244"><h4 class="sectiontitle">Examples</h4><p id="obs_11_0026__p2085423874611">Take the Windows OS as an example.</p>
<pre class="screen" id="obs_11_0026__screen1917381703"><strong id="obs_11_0026__b19991745205">obsutil version</strong>
obsutil version:5.1.9, obssdk version:2.2.12
operating system:windows, arch:amd64</pre>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0022.html">Auxiliary Commands</a></div>
</div>
</div>

27
docs/obs/tool-obsutil/obs_11_0027.html Normal file
View File

@ -0,0 +1,27 @@
<a name="obs_11_0027"></a><a name="obs_11_0027"></a>
<h1 class="topictitle1">Common Examples</h1>
<div id="body1543383727788"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_11_0028.html">Upload</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0046.html">Synchronous Upload</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0029.html">Download</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0047.html">Synchronous Download</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0030.html">Copy</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0048.html">Synchronous Copy</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0031.html">Listing</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0032.html">Listing Multipart Upload Tasks</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0065.html">Deleting All Multipart Upload Tasks in a Bucket</a></strong><br>
</li>
</ul>
</div>

106
docs/obs/tool-obsutil/obs_11_0028.html Normal file
View File

File diff suppressed because it is too large Load Diff

83
docs/obs/tool-obsutil/obs_11_0029.html Normal file
View File

@ -0,0 +1,83 @@
<a name="obs_11_0029"></a><a name="obs_11_0029"></a>
<h1 class="topictitle1">Download</h1>
<div id="body1543383727788"><p id="obs_11_0029__p12118334192812">All commands in this section use the Linux operating system as an example to describe how to download files.</p>
<p id="obs_11_0029__p4927118201719">Assume that bucket <strong id="obs_11_0029__b785561814118">bucket-test</strong> contains the following objects:</p>
<pre class="screen" id="obs_11_0029__screen776818585566">obs://bucket-test/test1.txt
obs://bucket-test/test2.txt
obs://bucket-test/test3.txt
obs://bucket-test/test4.txt
obs://bucket-test/test5.txt
obs://bucket-test/test6.txt
obs://bucket-test/src1/
obs://bucket-test/src1/test7.txt
obs://bucket-test/src2/
obs://bucket-test/src2/test8.txt
obs://bucket-test/src2/src3/
obs://bucket-test/src2/src3/test9.txt</pre>
<p id="obs_11_0029__p0873101916261">Based on the structure of objects in the bucket, different download scenarios require different commands.</p>
<ul id="obs_11_0029__ul174731818476"><li id="obs_11_0029__li1830605242615">To download the <strong id="obs_11_0029__b10644143692215">test1.txt</strong> file from bucket <strong id="obs_11_0029__b106981022236">bucket-test</strong> to the local <strong id="obs_11_0029__b7255151910231">src1</strong> folder, the command is as follows:<pre class="screen" id="obs_11_0029__screen1824094893113">./obsutil cp obs://bucket-test/test1.txt /src1</pre>
<p id="obs_11_0029__p398225316315">After the download is complete, the following file is generated on the local PC:</p>
<pre class="screen" id="obs_11_0029__screen251512321320"><span style="color:#666600;">└──</span> src1
<span style="color:#666600;">└──</span> test1.txt</pre>
</li><li id="obs_11_0029__li116837346319">Run the following command to download the <strong id="obs_11_0029__b12949322173019">test1.txt</strong> file to your local PC. If there is no <strong id="obs_11_0029__b139502022103014">test.txt</strong> on the local PC, the <strong id="obs_11_0029__b209519221304">test1.txt</strong> file is directly downloaded and you can rename it to <strong id="obs_11_0029__b19951132218304">test.txt</strong>. If <strong id="obs_11_0029__b395252293015">test.txt</strong> already exists, <strong id="obs_11_0029__b1495372217305">test1.txt</strong> is downloaded and overwrites the original local <strong id="obs_11_0029__b195316227307">test.txt</strong> file after renaming.<pre class="screen" id="obs_11_0029__screen18345312154212">./obsutil cp obs://bucket-test/test1.txt /test.txt</pre>
<p id="obs_11_0029__p664518192425">After the download is complete, the following file is generated on the local PC:</p>
<pre class="screen" id="obs_11_0029__screen719113424214"><span style="color:#666600;">└──</span> test.txt</pre>
</li><li id="obs_11_0029__li1261911034212">To recursively download the entire <strong id="obs_11_0029__b692395819425">src2</strong> folder from bucket <strong id="obs_11_0029__b20771274471">bucket-test</strong> to the local <strong id="obs_11_0029__b109242582427">src1</strong> folder in force mode, the command is as follows:<pre class="screen" id="obs_11_0029__screen17906155535618">./obsutil cp obs://bucket-test/src2 /src1 -r -f</pre>
<p id="obs_11_0029__p11605111105719">After the download is complete, the following files are generated on the local PC:</p>
<pre class="screen" id="obs_11_0029__screen91301738185716"><span style="color:#666600;">└──</span> src1
<span style="color:#666600;">└──</span> src2
<span style="color:#666600;"> ├──</span> src3
<span style="color:#666600;"> └──</span> test9.txt
<span style="color:#666600;"> └──</span> test8.txt</pre>
</li><li id="obs_11_0029__li1218311447562">To recursively download all files and subfolders in the <strong id="obs_11_0029__b195612824910">src2</strong> folder from bucket <strong id="obs_11_0029__b759112812491">bucket-test</strong> to the local <strong id="obs_11_0029__b196062812497">src1</strong> folder in force mode, the command is as follows:<pre class="screen" id="obs_11_0029__screen129059169590">./obsutil cp obs://bucket-test/src2 /src1 -r -f -flat</pre>
<p id="obs_11_0029__p7171129202">After the download is complete, the following files are generated on the local PC:</p>
<pre class="screen" id="obs_11_0029__screen1565013581502"><span style="color:#666600;">└──</span> src1
<span style="color:#666600;"> ├──</span> src3
<span style="color:#666600;"> └──</span> test9.txt
<span style="color:#666600;">└──</span> test8.txt</pre>
</li><li id="obs_11_0029__li13172115610584">To recursively download the all objects in bucket <strong id="obs_11_0029__b589718805516">bucket-test</strong> to the local <strong id="obs_11_0029__b1789718845517">src0</strong> folder in force mode, the command is as follows:<pre class="screen" id="obs_11_0029__screen6155127538">./obsutil cp obs://bucket-test /src0 -r -f</pre>
<p id="obs_11_0029__p1093315343315">After the download is complete, the following files are generated on the local PC:</p>
<pre class="screen" id="obs_11_0029__screen77316291358"><span style="color:#666600;">└──</span> src0
<span style="color:#666600;"> ├──</span> test1.txt
<span style="color:#666600;"> ├──</span> test2.txt
<span style="color:#666600;"> ├──</span> test3.txt
<span style="color:#666600;"> ├──</span> test4.txt
<span style="color:#666600;"> ├──</span> test5.txt
<span style="color:#666600;"> ├──</span> test6.txt
<span style="color:#666600;"> ├──</span> src1
<span style="color:#666600;"> └──</span> test7.txt
<span style="color:#666600;">└──</span> src2
<span style="color:#666600;">├──</span> src3
<span style="color:#666600;"> └──</span> test9.txt
<span style="color:#666600;"> └──</span> test8.txt</pre>
</li><li id="obs_11_0029__li2897203195717">Run the following command to exclude the <strong id="obs_11_0029__b1599122866">src2</strong> folder (including all files and folders contained) when downloading the <strong id="obs_11_0029__b10991121662">src1</strong> folder from the <strong id="obs_11_0029__b929020391761">bucket-test</strong> bucket:<pre class="screen" id="obs_11_0029__screen862914360547">./obsutil cp obs://bucket-test/src1/ src1 -exclude "*src1/src2*" -r -f -mf</pre>
<p id="obs_11_0029__p1167442118577">Four objects are successfully downloaded, and the download information contains <strong id="obs_11_0029__b1726517432060">exclude</strong> and the specific content.</p>
<pre class="screen" id="obs_11_0029__screen1431438135811">./obsutil cp obs://bucket-test/src1/ src1 -exclude "*src1/src2*" -r -f -mf
Parallel: 5 Jobs: 5
Threshold: 50.00MB PartSize: auto
VerifyLength: false VerifyMd5: false
Exclude: *src1/src2*
Include:
CheckpointDir: xxxx
OutputDir: xxxx
TempFileDir: xxxx
[====================================================] 100.00% tps:87.78 ?/s 4/4 2.39KB/2.39KB 223ms
Succeed count: 4 Failed count: 0
Succeed bytes: 2.39KB
Metrics [max cost:147 ms, min cost:77 ms, average cost:56.00 ms, average tps:8.85, transferred size:2.39KB]</pre>
<p id="obs_11_0029__p163871543121710">After the download is complete, the following files are generated on the local PC:</p>
<pre class="screen" id="obs_11_0029__screen338744351719"><span style="color:#666600;">└──</span> src1
<span style="color:#666600;"> ├──</span> src3
<span style="color:#666600;"> └──</span> test9.txt
<span style="color:#666600;">└──</span> test7.txt</pre>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0027.html">Common Examples</a></div>
</div>
</div>

46
docs/obs/tool-obsutil/obs_11_0030.html Normal file
View File

@ -0,0 +1,46 @@
<a name="obs_11_0030"></a><a name="obs_11_0030"></a>
<h1 class="topictitle1">Copy</h1>
<div id="body1543383727788"><p id="obs_11_0030__p11572732132917">All commands in this section use the Linux operating system as an example to describe how to copy files.</p>
<p id="obs_11_0030__p4927118201719">Assume that bucket <strong id="obs_11_0030__b203161520172217">bucket-src</strong> contains the following objects:</p>
<pre class="screen" id="obs_11_0030__screen776818585566">obs://bucket-src/test1.txt
obs://bucket-src/test2.txt
obs://bucket-src/test3.txt
obs://bucket-src/test4.txt
obs://bucket-src/test5.txt
obs://bucket-src/test6.txt
obs://bucket-src/src1/
obs://bucket-src/src1/test7.txt
obs://bucket-src/src2/
obs://bucket-src/src2/test8.txt
obs://bucket-src/src2/src3/
obs://bucket-src/src2/src3/test9.txt</pre>
<p id="obs_11_0030__p4490143842915">Based on the structure of objects in the bucket, different copy scenarios require different commands.</p>
<ul id="obs_11_0030__ul174731818476"><li id="obs_11_0030__li23391442113117">To copy the <strong id="obs_11_0030__b195901924133613">test1.txt</strong> file from bucket <strong id="obs_11_0030__b38601828143610">bucket-src</strong> to bucket <strong id="obs_11_0030__b1679284483610">bucket-dest</strong>, the command is as follows:<pre class="screen" id="obs_11_0030__screen134701607338">./obsutil cp obs://bucket-src/test1.txt obs://bucket-dest</pre>
<p id="obs_11_0030__p421814820337">After the copy is complete, the following object is generated in bucket <strong id="obs_11_0030__b54714489394">bucket-dest</strong>:</p>
<pre class="screen" id="obs_11_0030__screen24831326184214">obs://bucket-dest/test1.txt</pre>
</li><li id="obs_11_0030__li156448133217">To copy the content of the <strong id="obs_11_0030__b143881558173911">test1.txt</strong> file in bucket <strong id="obs_11_0030__b939385813916">bucket-src</strong> to the <strong id="obs_11_0030__b1688312918441">text.txt</strong> file in bucket <strong id="obs_11_0030__b5397105823910">bucket-dest</strong>, the command is as follows:<pre class="screen" id="obs_11_0030__screen35103318446">./obsutil cp obs://bucket-src/test1.txt obs://bucket-dest/test.txt</pre>
<p id="obs_11_0030__p2355435104418">After the copy is complete, the following object is generated in bucket <strong id="obs_11_0030__b9841532124517">bucket-dest</strong>:</p>
<pre class="screen" id="obs_11_0030__screen1131134814447">obs://bucket-dest/test.txt</pre>
</li><li id="obs_11_0030__li49953160445">To copy the <strong id="obs_11_0030__b778384264516">test1.txt</strong> file in bucket <strong id="obs_11_0030__b67842425459">bucket-src</strong> to the <strong id="obs_11_0030__b37851942114517">text</strong> folder in bucket <strong id="obs_11_0030__b978654213456">bucket-dest</strong>, the command is as follows:<pre class="screen" id="obs_11_0030__screen13166164513203">./obsutil cp obs://bucket-src/test1.txt obs://bucket-dest/test/</pre>
<p id="obs_11_0030__p187128417465">After the copy is complete, the following object is generated in bucket <strong id="obs_11_0030__b1620903104819">bucket-dest</strong>:</p>
<pre class="screen" id="obs_11_0030__screen1078720511468">obs://bucket-dest/test/test1.txt</pre>
</li><li id="obs_11_0030__li133851558134412">Run the following command to recursively copy the entire <strong id="obs_11_0030__b1861203810489">src2</strong> folder in bucket <strong id="obs_11_0030__b13711436124914">bucket-src</strong> to bucket <strong id="obs_11_0030__b206583811487">bucket-dest</strong> in force mode:<pre class="screen" id="obs_11_0030__screen107719526203">./obsutil cp obs://bucket-src/src2 obs://bucket-dest -r -f</pre>
<p id="obs_11_0030__p2062213345403">After the copy is complete, the following objects are generated in bucket <strong id="obs_11_0030__b116361229125017">bucket-dest</strong>:</p>
<pre class="screen" id="obs_11_0030__screen18781194620460">obs://bucket-dest/src2/
obs://bucket-dest/src2/test8.txt
obs://bucket-dest/src2/src3/
obs://bucket-dest/src2/src3/test9.txt</pre>
</li><li id="obs_11_0030__li1668483194517">To recursively copy all files and subfolders in the <strong id="obs_11_0030__b887214398506">src2</strong> folder in bucket <strong id="obs_11_0030__b9875153913503">bucket-src</strong> to bucket <strong id="obs_11_0030__b887815399507">bucket-dest</strong> in force mode, the command is as follows:<pre class="screen" id="obs_11_0030__screen18112009214">./obsutil cp obs://bucket-src/src2 obs://bucket-dest -r -f -flat</pre>
<p id="obs_11_0030__p11489103718404">After the copy is complete, the following objects are generated in bucket <strong id="obs_11_0030__b196018720517">bucket-dest</strong>:</p>
<pre class="screen" id="obs_11_0030__screen8497114114461">obs://bucket-dest/test8.txt
obs://bucket-dest/src3/
obs://bucket-dest/src3/test9.txt</pre>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0027.html">Common Examples</a></div>
</div>
</div>

44
docs/obs/tool-obsutil/obs_11_0031.html Normal file
View File

@ -0,0 +1,44 @@
<a name="obs_11_0031"></a><a name="obs_11_0031"></a>
<h1 class="topictitle1">Listing</h1>
<div id="body1543383727788"><p id="obs_11_0031__p9795101319301">All commands in this section use the Linux operating system as an example to describe how to list files.</p>
<p id="obs_11_0031__p0386153185616">Assume that bucket <strong id="obs_11_0031__b12714011584">bucket-test</strong> contains the following objects:</p>
<pre class="screen" id="obs_11_0031__screen776818585566">obs://bucket-test/test1.txt
obs://bucket-test/test2.txt
obs://bucket-test/test3.txt
obs://bucket-test/test4.txt
obs://bucket-test/test5.txt
obs://bucket-test/test6.txt
obs://bucket-test/src1/
obs://bucket-test/src1/test7.txt
obs://bucket-test/src2/
obs://bucket-test/src2/test8.txt</pre>
<p id="obs_11_0031__p6890155720220">Based on the structure of objects in the bucket, different object listing scenarios require different commands.</p>
<ul id="obs_11_0031__ul174731818476"><li id="obs_11_0031__li97601771879">To list three objects in bucket <strong id="obs_11_0031__b10740311310">bucket-test</strong>, the command is as follows:<pre class="screen" id="obs_11_0031__screen663013515912">./obsutil ls obs://bucket-test -limit=3</pre>
<p id="obs_11_0031__p163819424915">The returned result is listed in lexicographical order by object name and version ID as follows:</p>
<pre class="screen" id="obs_11_0031__screen1413213287128">obs://bucket-test/test1.txt
obs://bucket-test/test2.txt
obs://bucket-test/test3.txt</pre>
</li><li id="obs_11_0031__li63641711819">To list three objects following <strong id="obs_11_0031__b49378207255">test3.txt</strong> in bucket <strong id="obs_11_0031__b169781540112311">bucket-test</strong>, the command is as follows:<pre class="screen" id="obs_11_0031__screen16647138191720">./obsutil ls obs://bucket-test -limit=3 -marker=test3.txt</pre>
<p id="obs_11_0031__p338414270177">The returned result is listed in lexicographical order by object name and version ID as follows:</p>
<pre class="screen" id="obs_11_0031__screen9165534181813">obs://bucket-test/test4.txt
obs://bucket-test/test5.txt
obs://bucket-test/test6.txt</pre>
</li><li id="obs_11_0031__li6423193851816">To list the files and subdirectories in the root directory of bucket <strong id="obs_11_0031__b11694201513294">bucket-test</strong> in non-recursive mode, that is, files in the subdirectories are not listed, the command is as follows:<pre class="screen" id="obs_11_0031__screen5833109165713">./obsutil ls obs://bucket-test -d</pre>
<p id="obs_11_0031__p7917133819528">The returned result is listed in lexicographical order by object name and version ID as follows:</p>
<pre class="screen" id="obs_11_0031__screen1534182520569">obs://bucket-test/test1.txt
obs://bucket-test/test2.txt
obs://bucket-test/test3.txt
obs://bucket-test/test4.txt
obs://bucket-test/test5.txt
obs://bucket-test/test6.txt
obs://bucket-test/src1/
obs://bucket-test/src2/</pre>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0027.html">Common Examples</a></div>
</div>
</div>

31
docs/obs/tool-obsutil/obs_11_0032.html Normal file
View File

@ -0,0 +1,31 @@
<a name="obs_11_0032"></a><a name="obs_11_0032"></a>
<h1 class="topictitle1">Listing Multipart Upload Tasks</h1>
<div id="body1543385601588"><p id="obs_11_0032__p5105648193014">All commands in this section use the Linux operating system as an example to describe how to list multipart upload tasks.</p>
<p id="obs_11_0032__p0386153185616">Assume that bucket <strong id="obs_11_0032__b66191323730">bucket-test</strong> contains the following multipart upload tasks:</p>
<pre class="screen" id="obs_11_0032__screen776818585566">obs://bucket-test/task1.txt uploadid1
obs://bucket-test/task1.txt uploadid2
obs://bucket-test/task2.txt uploadid3
obs://bucket-test/task3.txt uploadid4
obs://bucket-test/src1/
obs://bucket-test/src1/task4.txt uploadid5
obs://bucket-test/src2/
obs://bucket-test/src2/task5.txt uploadid6</pre>
<ul id="obs_11_0032__ul174731818476"><li id="obs_11_0032__li439345014019">Run the following command to list three multipart upload tasks in bucket <strong id="obs_11_0032__b245610293418">bucket-test</strong>:<pre class="screen" id="obs_11_0032__screen8875601439">./obsutil ls obs://bucket-test -m -limit=3</pre>
<p id="obs_11_0032__p9306746318">The returned result is listed in lexicographical order by object name as follows:</p>
<pre class="screen" id="obs_11_0032__screen157442318310">obs://bucket-test/task1.txt uploadid1
obs://bucket-test/task1.txt uploadid2
obs://bucket-test/task2.txt uploadid3</pre>
</li><li id="obs_11_0032__li17287144811211">To list the rest multipart upload tasks following <strong id="obs_11_0032__b231462818104">uploadid1</strong>, the command is as follows:<pre class="screen" id="obs_11_0032__screen89067480710">./obsutil ls obs://bucket-test -m -limit=3 -marker=task1.txt -uploadIdMarker=uploadid1</pre>
<p id="obs_11_0032__p08249101476">The returned result is listed in lexicographical order by object name and upload ID as follows:</p>
<pre class="screen" id="obs_11_0032__screen873812618711">obs://bucket-test/task1.txt uploadid2
obs://bucket-test/task2.txt uploadid3
obs://bucket-test/task3.txt uploadid4</pre>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0027.html">Common Examples</a></div>
</div>
</div>

29
docs/obs/tool-obsutil/obs_11_0033.html Normal file
View File

@ -0,0 +1,29 @@
<a name="obs_11_0033"></a><a name="obs_11_0033"></a>
<h1 class="topictitle1">Best Practices</h1>
<div id="body1545109735702"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_11_0066.html">Using the obsutil help Command to Search for Functions</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0034.html">Configuring Scheduled Tasks Using the Crontab Command</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0049.html">Setting obsutil Commands as Built-in Commands</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0052.html">Fine-Tuning obsutil Performance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0059.html">Using obsutil for Resumable Data Transfer</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0060.html">Using obsutil to Upload a Symbolic Link</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0068.html">Configuring an HTTP Proxy for obsutil</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0069.html">Using obsutil to Share Directories</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0039.html">Using obsutil to Replicate Data Across Regions on the Client Side</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_11_0073.html">Limiting the Upload and Download Rate for obsutil</a></strong><br>
</li>
</ul>
</div>

25
docs/obs/tool-obsutil/obs_11_0034.html Normal file
View File

@ -0,0 +1,25 @@
<a name="obs_11_0034"></a><a name="obs_11_0034"></a>
<h1 class="topictitle1">Configuring Scheduled Tasks Using the Crontab Command</h1>
<div id="body1545109772221"><div class="section" id="obs_11_0034__section146005674214"><h4 class="sectiontitle">Scenario</h4><p id="obs_11_0034__p811715102429">Go to the <strong id="obs_11_0034__b196642317323">/root</strong> directory at 21:30 every day and upload the <strong id="obs_11_0034__b1358118115364">/src/src1</strong> folder to bucket <strong id="obs_11_0034__b184777156363">obs://bucket-test</strong> in the incremental mode.</p>
</div>
<div class="section" id="obs_11_0034__section16839141103914"><h4 class="sectiontitle">Prerequisites</h4><p id="obs_11_0034__p1733316613910">You have properly enabled the scheduled crond service in the Linux OS.</p>
<div class="note" id="obs_11_0034__note1681514816414"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_11_0034__p16815483419">Run the <strong id="obs_11_0034__b199373583618">service crond status</strong> command to check whether the service is enabled.</p>
</div></div>
</div>
<div class="section" id="obs_11_0034__section13314111314402"><h4 class="sectiontitle">Procedure</h4><ol id="obs_11_0034__ol1088611368423"><li id="obs_11_0034__li48864366429"><span>Run the <strong id="obs_11_0034__b426701719579">crontab -e</strong> command to open the configuration file for setting a scheduled task.</span></li><li id="obs_11_0034__li988683674212"><span>Enter the Insert mode to edit the configuration file.</span><p><pre class="screen" id="obs_11_0034__screen3265933142316">30 21 * * * cd /root &amp;&amp; nohup ./obsutil cp /src/src1 obs://bucket-test -r -f -u &amp;&gt;obsutil_crond.log &amp;</pre>
<div class="note" id="obs_11_0034__note54021727165315"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_11_0034__p1394918291536">Assume that the obsutil tool is in the <strong id="obs_11_0034__b16873104519368">/root</strong> directory. The preceding configuration is described as follows: Go to the <strong id="obs_11_0034__b1735019222480">/root</strong> directory at 21:30 every day, upload the <strong id="obs_11_0034__b113901340164810">/src/src1</strong> folder to bucket <strong id="obs_11_0034__b343284811485">obs://bucket-test</strong> in incremental mode, and redirect the command output to the <strong id="obs_11_0034__b186991139185117">obsutil_crond.log</strong> file in the <strong id="obs_11_0034__b158010442511">/root</strong> directory.</p>
</div></div>
</p></li><li id="obs_11_0034__li118861836194214"><span>Press <strong id="obs_11_0034__b1633191919527">Esc</strong> to exit the Insert mode. Then input <strong id="obs_11_0034__b1673482145319">:wq</strong> and press <strong id="obs_11_0034__b18489211242">Enter</strong> to save the configuration and exit.</span></li><li id="obs_11_0034__li18604552205515"><span>Run the <strong id="obs_11_0034__b20353123555816">crontab -l</strong> command to check whether the scheduled task is configured successfully.</span></li></ol>
</div>
<div class="section" id="obs_11_0034__section14418131348"><h4 class="sectiontitle">FAQs</h4><ol id="obs_11_0034__ol3240639153512"><li id="obs_11_0034__li1324013916355">How do I determine whether a scheduled task is being executed?<ul id="obs_11_0034__ul12144161133615"><li id="obs_11_0034__li1414413118365">Run the <strong id="obs_11_0034__b105331644662">tail /var/log/cron</strong> command to view the latest scheduled task execution records.</li><li id="obs_11_0034__li1614410117361">Run the <strong id="obs_11_0034__b1666117151272">ps -ef | grep obsutil</strong> command to check whether obsutil is being executed.</li></ul>
</li><li id="obs_11_0034__li414410153619">How do I forcibly stop an ongoing scheduled task?<ol type="a" id="obs_11_0034__ol10112155844217"><li id="obs_11_0034__li2112105874218">Run the <strong id="obs_11_0034__b2953121990">ps -ef | grep obsutil</strong> command to check the process of obsutil.</li><li id="obs_11_0034__li101122058174214">Run the <strong id="obs_11_0034__b1617118162317">kill -9 </strong><em id="obs_11_0034__i1114272042318">PID</em> command to forcibly stop the process, where <em id="obs_11_0034__i831643312238">PID</em> indicates the queried process ID.</li></ol>
</li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0033.html">Best Practices</a></div>
</div>
</div>

542
docs/obs/tool-obsutil/obs_11_0035.html Normal file
View File

File diff suppressed because it is too large Load Diff

258
docs/obs/tool-obsutil/obs_11_0036.html Normal file
View File

File diff suppressed because it is too large Load Diff

256
docs/obs/tool-obsutil/obs_11_0037.html Normal file
View File

File diff suppressed because it is too large Load Diff

224
docs/obs/tool-obsutil/obs_11_0038.html Normal file
View File

File diff suppressed because it is too large Load Diff

34
docs/obs/tool-obsutil/obs_11_0039.html Normal file
View File

@ -0,0 +1,34 @@
<a name="obs_11_0039"></a><a name="obs_11_0039"></a>
<h1 class="topictitle1">Using obsutil to Replicate Data Across Regions on the Client Side</h1>
<div id="body1608118480698"><p id="obs_11_0039__p8060118">obsutil client supports cross-region replication. You can directly replicate data from a source bucket to the destination bucket through data streams. The source bucket and destination bucket can be any two OBS buckets. Objects can be replicated between buckets in different regions under the same account or across accounts. The following procedure describes how to replicate data between buckets across accounts and regions:</p>
<ol id="obs_11_0039__ol12439123364517"><li id="obs_11_0039__li12439193315455"><span>Run the <strong id="obs_11_0039__b9292171813165">obsutil config</strong> command to configure the AK, SK, and endpoint of the source bucket account.</span><p><ul id="obs_11_0039__ul1129174841612"><li id="obs_11_0039__li62911148141616">In Windows<pre class="screen" id="obs_11_0039__screen134141504119"><span>obsutil config -interactive -crr</span></pre>
</li><li id="obs_11_0039__li2065885410165">In Linux<pre class="screen" id="obs_11_0039__screen20510125011145"><span>./obsutil config -interactive -crr</span></pre>
</li></ul>
</p></li><li id="obs_11_0039__li4731615194713"><span>Run the <strong id="obs_11_0039__b11200822102516">obsutil config</strong> command to configure the AK, SK, and endpoint of the destination bucket account.</span><p><ul id="obs_11_0039__ul1054741111178"><li id="obs_11_0039__li754713115173">In Windows<pre class="screen" id="obs_11_0039__screen162586401510"><span>obsutil config -interactive</span></pre>
</li><li id="obs_11_0039__li16535141311171">In Linux<pre class="screen" id="obs_11_0039__screen1325894101510"><span>./obsutil config -interactive</span></pre>
</li></ul>
</p></li><li id="obs_11_0039__li1934120192169"><span>Check the connectivity to ensure that the destination bucket is correctly configured.</span><p><ul id="obs_11_0039__ul173105390185"><li id="obs_11_0039__li173101239121813">In Windows<pre class="screen" id="obs_11_0039__screen18391205165">obsutil ls -s</pre>
</li><li id="obs_11_0039__li681934171911">In Linux or macOS<pre class="screen" id="obs_11_0039__screen54471715121916">./obsutil ls -s</pre>
</li></ul>
<p id="obs_11_0039__p1452915815368">Check the command output:</p>
<ul id="obs_11_0039__ul157631931518"><li id="obs_11_0039__li376181991519">If it contains "Bucket number", the configuration is correct.</li><li id="obs_11_0039__li10711119141614">If it contains "Http status [403]", the access keys are wrong.</li><li id="obs_11_0039__li19649103911919">If it contains "A connection attempt failed", OBS cannot be connected. Then, check the network condition.</li><li id="obs_11_0039__li13706544314">If it contains "Error: cloud_url [url] is not in well format", the domain name to be accessed is incorrect. Check the domain name in the configuration file.</li></ul>
<div class="note" id="obs_11_0039__note139810916178"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_11_0039__p143981096179">If the command output contains "Http status [403]", you may not have the required permissions for obtaining the bucket list. A further analysis is required to identify the root cause.</p>
</div></div>
</p></li><li id="obs_11_0039__li20602103564710"><span>Run the <strong id="obs_11_0039__b24466339255">cp</strong> command to specify that cross-region replication method is used to copy objects from the source bucket to the destination bucket.</span><p><ul id="obs_11_0039__ul9749112711720"><li id="obs_11_0039__li1474902741715">In Windows<pre class="screen" id="obs_11_0039__screen5420916185119"><span>obsutil cp obs://src-bucket obs://dst-bucket -f -r -crr</span></pre>
</li></ul>
<ul id="obs_11_0039__ul175021299179"><li id="obs_11_0039__li185021129191719">In Linux<pre class="screen" id="obs_11_0039__screen1457461121612"><span>./obsutil cp obs://src-bucket obs://dst-bucket -f -r -crr</span></pre>
</li></ul>
</p></li></ol>
<div class="note" id="obs_11_0039__note1647002295216"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="obs_11_0039__ul63975143532"><li id="obs_11_0039__li4132467561">To use the cross-region replication function, you need to specify the <strong id="obs_11_0039__b183703536508">-crr</strong> parameter. If this parameter is specified, update the configuration of the client-side cross-region replication in the configuration file. For details, see <a href="obs_11_0023.html">Updating a Configuration File</a>.</li><li id="obs_11_0039__li17823184795519">The configurations of the source bucket and destination bucket are respectively <strong id="obs_11_0039__b1028317394322">akCrr/skCrr/tokenCrr/endpointCrr</strong> and <strong id="obs_11_0039__b19283203973211">ak/sk/token/endpoint</strong> in the configuration file.</li><li id="obs_11_0039__li3320747105414">The preceding procedure is also applicable to the situation when the source and destination buckets belong to the same account.</li></ul>
</div></div>
<div class="caution" id="obs_11_0039__note61815386279"><span class="cautiontitle"><img src="public_sys-resources/caution_3.0-en-us.png"> </span><div class="cautionbody"><p id="obs_11_0039__p1183389276">When the <strong id="obs_11_0039__b139671715066">-crr</strong> parameter is used, the source object's standard metadata, including <strong id="obs_11_0039__b39182056782">Cache-Control</strong>, <strong id="obs_11_0039__b1133220588814">Expires</strong>, <strong id="obs_11_0039__b11454165914813">Content-Encoding</strong>, <strong id="obs_11_0039__b1362640599">Content-Disposition</strong>, <strong id="obs_11_0039__b17359128912">Content-Type</strong>, and <strong id="obs_11_0039__b48191976916">Content-Language</strong>, will not be copied.</p>
<p id="obs_11_0039__p134833151078">When the <strong id="obs_11_0039__b1667195023214">-crr</strong> parameter is used for cross-region replication, the ACL of the source object will not be copied. You can use <strong id="obs_11_0039__b826321218422">[-acl=</strong><em id="obs_11_0039__i1410218514421">xxx</em><strong id="obs_11_0039__b22154147425">]</strong> to specify the ACL for the target object. If the ACL is not specified, the object inherits the ACL of the bucket by default.</p>
</div></div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0033.html">Best Practices</a></div>
</div>
</div>

116
docs/obs/tool-obsutil/obs_11_0040.html Normal file
View File

File diff suppressed because it is too large Load Diff

210
docs/obs/tool-obsutil/obs_11_0041.html Normal file
View File

File diff suppressed because it is too large Load Diff

294
docs/obs/tool-obsutil/obs_11_0042.html Normal file
View File

File diff suppressed because it is too large Load Diff

215
docs/obs/tool-obsutil/obs_11_0043.html Normal file
View File

File diff suppressed because it is too large Load Diff

261
docs/obs/tool-obsutil/obs_11_0044.html Normal file
View File

File diff suppressed because it is too large Load Diff

72
docs/obs/tool-obsutil/obs_11_0045.html Normal file
View File

@ -0,0 +1,72 @@
<a name="obs_11_0045"></a><a name="obs_11_0045"></a>
<h1 class="topictitle1">Archiving Log Files</h1>
<div id="body1547106819232"><div class="section" id="obs_11_0045__section1479112110815"><h4 class="sectiontitle">Function</h4><p id="obs_11_0045__p11772825481">You can use this command to archive log files to a local PC or to a specified bucket.</p>
</div>
<div class="section" id="obs_11_0045__section1220752192216"><h4 class="sectiontitle">Command Line Structure</h4><ul id="obs_11_0045__ul10922428121013"><li id="obs_11_0045__li79221528121010">In Windows<ul id="obs_11_0045__ul48751720253"><li id="obs_11_0045__li1012518598242">Archiving to a local PC<pre class="screen" id="obs_11_0045__screen10125859132415">obsutil archive [file_or_folder_url] [-config=xxx] </pre>
</li><li id="obs_11_0045__li162401213162513">Archiving to a specified bucket<pre class="screen" id="obs_11_0045__screen13477182952517">obsutil archive obs://bucket[/key] [-config=xxx] </pre>
</li></ul>
</li><li id="obs_11_0045__li106087324101">In Linux or macOS<ul id="obs_11_0045__ul540412358913"><li id="obs_11_0045__li12404163514917">Archiving to a local PC<pre class="screen" id="obs_11_0045__screen204052351997">obsutil archive [file_or_folder_url] [-config=xxx] </pre>
</li><li id="obs_11_0045__li040683511913">Archiving to a specified bucket<pre class="screen" id="obs_11_0045__screen740612351992">obsutil archive obs://bucket[/key] [-config=xxx] </pre>
</li></ul>
</li></ul>
</div>
<div class="section" id="obs_11_0045__section148621021184511"><h4 class="sectiontitle">Examples</h4><ul id="obs_11_0045__ul12862192116453"><li id="obs_11_0045__li886242124513">Take the Windows OS as an example. Run the <strong id="obs_11_0045__b369616289395">obsutil archive</strong> command to archive log files to the same directory where the tool is executed.<pre class="screen" id="obs_11_0045__screen9862132144515"><strong id="obs_11_0045__b6862142115450">obsutil <strong id="obs_11_0045__b78628212456">archive</strong></strong>
[----------------------------------------------------------] 100.00% 15/15 35ms
Succeed to archive log files to [D:\obsutil\obsutil_log.zip]</pre>
</li></ul>
</div>
<div class="section" id="obs_11_0045__section6559191102418"><h4 class="sectiontitle">Parameter Description</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_11_0045__table10831182114445" frame="border" border="1" rules="all"><thead align="left"><tr id="obs_11_0045__row683212154419"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.1.4.1.1"><p id="obs_11_0045__p118329219446">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.4.1.2"><p id="obs_11_0045__p15137125919108">Optional or Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59%" id="mcps1.3.4.2.1.4.1.3"><p id="obs_11_0045__p12832121184414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_11_0045__row108328217449"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0045__p64495172515">file_or_folder_url</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0045__p154316502519">Optional</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0045__p17425512259">The path to which log files are archived. The rules are as follows:</p>
<ul id="obs_11_0045__ul105928456532"><li id="obs_11_0045__li232373132116">If this parameter is left blank, log files are archived to the same directory where obsutil commands reside with <strong id="obs_11_0045__b1549218199916">obsutil_log.zip</strong> as the archive file name.</li><li id="obs_11_0045__li18704181916135">If this parameter specifies a file or folder path that does not exist, the tool checks whether the value ends with a slash (/) or backslash (\). If yes, a folder is created based on the path, and log files are archived to the newly created directory with <strong id="obs_11_0045__b19182195312314">obsutil_log.zip</strong> as the archive file name.</li><li id="obs_11_0045__li1230573911153">If this parameter specifies a file or folder path that does not exist and the value does not end with a slash (/) or backslash (\), log files are archived to a local PC with the value as the archive file name.</li><li id="obs_11_0045__li4953132119137">If this parameter specifies an existing .zip file, then log files are archived to a local PC overwriting the existing file, with the value as the archive file name.</li><li id="obs_11_0045__li1759284518535">If this parameter specifies an existing folder, then log files are archived to the specified directory with <strong id="obs_11_0045__b94473916314">obsutil_log.zip</strong> as the archive file name.</li></ul>
<div class="note" id="obs_11_0045__note2947114643"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="obs_11_0045__p394734546">All archive files are .zip files.</p>
</div></div>
</td>
</tr>
<tr id="obs_11_0045__row1583413141821"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0045__p154092113211">bucket</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0045__p105401120328">Mandatory for archiving log files to a specified bucket</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0045__p1954062113212">The bucket name</p>
</td>
</tr>
<tr id="obs_11_0045__row941361618217"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0045__p13233171113215">key</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0045__p152331511173216">Optional for archiving log files to a specified bucket</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0045__p16965474526">The object name or object name prefix when archiving log files to a specified bucket</p>
<p id="obs_11_0045__p060018221533">The rules are as follows:</p>
<ul id="obs_11_0045__ul7190122515538"><li id="obs_11_0045__li8801747252">If this parameter is left blank, log files are archived to the root directory of the bucket with <strong id="obs_11_0045__b4475192719426">obsutil_log.zip</strong> as the object name.</li><li id="obs_11_0045__li15190225135311">If the value ends with a slash (/), the value is used as the object name prefix when archiving log files, and the object name is the value plus <strong id="obs_11_0045__b1248317223469">obsutil_log.zip</strong>. Otherwise, log files are archived with the value as the object name.</li></ul>
</td>
</tr>
<tr id="obs_11_0045__row3739132910383"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.4.1.1 "><p id="obs_11_0045__p153951131317">config</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.4.1.2 "><p id="obs_11_0045__p12395135316">Optional (additional parameter)</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.4.2.1.4.1.3 "><p id="obs_11_0045__p43952034313">The user-defined configuration file for executing a command. For details about parameters that can be configured, see <a href="obs_11_0035.html">Configuration Parameters</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0022.html">Auxiliary Commands</a></div>
</div>
</div>

40
docs/obs/tool-obsutil/obs_11_0046.html Normal file
View File

@ -0,0 +1,40 @@
<a name="obs_11_0046"></a><a name="obs_11_0046"></a>
<h1 class="topictitle1">Synchronous Upload</h1>
<div id="body1547791494081"><p id="obs_11_0046__p182110247282">All commands in this section use the Linux operating system as an example to describe how to perform synchronous upload operations.</p>
<p id="obs_11_0046__p1693019466342">Assume that a local folder is in the following structure:</p>
<pre class="screen" id="obs_11_0046__screen1426863513468"><span style="color:#666600;">└──</span> src1
<span style="color:#666600;"> ├──</span> src2
<span style="color:#666600;"> ├──</span> test1.txt
<span style="color:#666600;"> └──</span> test2.txt
<span style="color:#666600;">├──</span> src3
<span style="color:#666600;">└──</span> test3.txt</pre>
<p id="obs_11_0046__p4927118201719">Assume that bucket <strong id="obs_11_0046__b1560111110326">bucket-test</strong> contains the following objects:</p>
<pre class="screen" id="obs_11_0046__screen776818585566">obs://bucket-test/src1/
obs://bucket-test/src1/src2/
obs://bucket-test/src1/src2/test1.txt
obs://bucket-test/src1/src3/</pre>
<p id="obs_11_0046__p515421611454">Based on the structure of the preceding local folder and objects in the bucket, different synchronous upload scenarios require different commands.</p>
<ul id="obs_11_0046__ul20301195665415"><li id="obs_11_0046__li1430185695420">To synchronize the <strong id="obs_11_0046__b3966315103415">test3.txt</strong> file in the local <strong id="obs_11_0046__b496651513345">src1</strong> folder to the root directory of bucket <strong id="obs_11_0046__b6967191523418">bucket-test</strong>, the command is as follows:<pre class="screen" id="obs_11_0046__screen27011879554">./obsutil sync /src1/test3.txt obs://bucket-test</pre>
<p id="obs_11_0046__p8859716195520">After the synchronization is successful, the <strong id="obs_11_0046__b18473175185612">test3.txt</strong> file is directly uploaded to the bucket because there is no <strong id="obs_11_0046__b13839164763610">test3.txt</strong> in bucket <strong id="obs_11_0046__b185541919165513">bucket-test</strong>. Then, objects in the bucket are as follows:</p>
<pre class="screen" id="obs_11_0046__screen1677410173567">obs://bucket-test/test3.txt
obs://bucket-test/src1/
obs://bucket-test/src1/src2/
obs://bucket-test/src1/src2/test1.txt
obs://bucket-test/src1/src3/</pre>
</li><li id="obs_11_0046__li18460634165719">To synchronize all files and subfolders in the local <strong id="obs_11_0046__b951055515375">src1</strong> folder to the <strong id="obs_11_0046__b12511105512370">src1</strong> folder in bucket <strong id="obs_11_0046__b251215543718">bucket-test</strong>, the command is as follows:<pre class="screen" id="obs_11_0046__screen31021421101319">./obsutil sync /src1 obs://bucket-test/src1</pre>
<p id="obs_11_0046__p176731231101315">After the synchronization, the objects in the bucket are as follows:</p>
<pre class="screen" id="obs_11_0046__screen981772017300">obs://bucket-test/src1/
obs://bucket-test/src1/test3.txt
obs://bucket-test/src1/src2/
obs://bucket-test/src1/src2/test1.txt
obs://bucket-test/src1/src2/test2.txt
obs://bucket-test/src1/src3/</pre>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0027.html">Common Examples</a></div>
</div>
</div>

31
docs/obs/tool-obsutil/obs_11_0047.html Normal file
View File

@ -0,0 +1,31 @@
<a name="obs_11_0047"></a><a name="obs_11_0047"></a>
<h1 class="topictitle1">Synchronous Download</h1>
<div id="body1547791494081"><p id="obs_11_0047__p489614582289">All commands in this section use the Linux operating system as an example to describe how to perform synchronous download operations.</p>
<p id="obs_11_0047__p4927118201719">Assume that bucket <strong id="obs_11_0047__b4867124125610">bucket-test</strong> contains the following objects:</p>
<pre class="screen" id="obs_11_0047__screen515823314463">obs://bucket-test/src1/
obs://bucket-test/src1/test3.txt
obs://bucket-test/src1/src2/
obs://bucket-test/src1/src2/test1.txt
obs://bucket-test/src1/src2/test2.txt
obs://bucket-test/src1/src3/</pre>
<p id="obs_11_0047__p1693019466342">Assume that a local folder is in the following structure:</p>
<pre class="screen" id="obs_11_0047__screen1426863513468"><span style="color:#666600;">└──</span> src1
<span style="color:#666600;">└──</span> test3.txt</pre>
<p id="obs_11_0047__p72561242278">Based on the structure of the preceding local folder and objects in the bucket, different synchronous download scenarios require different commands.</p>
<ul id="obs_11_0047__ul174731818476"><li id="obs_11_0047__li14521165111157">To synchronize all files and subfolders in the <strong id="obs_11_0047__b2043881188">src1</strong> folder in bucket <strong id="obs_11_0047__b172192017141115">bucket-test</strong> to the local <strong id="obs_11_0047__b129842841012">src1</strong> folder, the command is as follows:<pre class="screen" id="obs_11_0047__screen129934416261">./obsutil sync obs://bucket-test/src1 /src1</pre>
<p id="obs_11_0047__p463863152617">After the synchronization is successful, the following files are generated in the local <strong id="obs_11_0047__b16868112017213">src1</strong> folder:</p>
<pre class="screen" id="obs_11_0047__screen116391731192616"><span style="color:#666600;">└──</span> src1
<span style="color:#666600;"> ├──</span> src2
<span style="color:#666600;"> ├──</span> test1.txt
<span style="color:#666600;"> └──</span> test2.txt
<span style="color:#666600;">├──</span> src3
<span style="color:#666600;">└──</span> test3.txt</pre>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_11_0027.html">Common Examples</a></div>
</div>
</div>

Some files were not shown because too many files have changed in this diff Show More