vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/obs/api-ref/obs_04_0005.html
zhangyue 8ba86cabc9 OBS API DOC 
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2024-05-28 10:01:19 +00:00

436 lines
39 KiB
HTML
Raw Blame History

<a name="obs_04_0005"></a><a name="obs_04_0005"></a>
<h1 class="topictitle1">API Overview</h1>
<div id="body62526833"><div class="section" id="obs_04_0005__section23599591419"><h4 class="sectiontitle">API Operations on Buckets</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0005__table1255720201424" frame="border" border="1" rules="all"><caption><b>Table 1 </b>API operations on buckets</caption><thead align="left"><tr id="obs_04_0005__row3576720428"><th align="left" class="cellrowborder" valign="top" width="39.61%" id="mcps1.3.1.2.2.3.1.1"><p id="obs_04_0005__p659812206210">Operation</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.39%" id="mcps1.3.1.2.2.3.1.2"><p id="obs_04_0005__p27521233191612">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0005__row136091220422"><td class="cellrowborder" valign="top" width="39.61%" headers="mcps1.3.1.2.2.3.1.1 "><p id="obs_04_0005__p3618142011217"><a href="obs_04_0020.html">Listing Buckets</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.39%" headers="mcps1.3.1.2.2.3.1.2 "><p id="obs_04_0005__p575353312164">Queries the list of buckets created by the user.</p>
</td>
</tr>
<tr id="obs_04_0005__row162814201210"><td class="cellrowborder" valign="top" width="39.61%" headers="mcps1.3.1.2.2.3.1.1 "><p id="obs_04_0005__p463782010220"><a href="obs_04_0021.html">Creating a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.39%" headers="mcps1.3.1.2.2.3.1.2 "><p id="obs_04_0005__p675343311164">Creates a bucket. You can add different request headers to specify the region, storage class, and permission control policy.</p>
</td>
</tr>
<tr id="obs_04_0005__row16642920222"><td class="cellrowborder" valign="top" width="39.61%" headers="mcps1.3.1.2.2.3.1.1 "><p id="obs_04_0005__p126521620523"><a href="obs_04_0022.html">Listing Objects in a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.39%" headers="mcps1.3.1.2.2.3.1.2 "><p id="obs_04_0005__p117534339163">Lists objects in a bucket. You can add different request headers to obtain objects that match the specified prefix, identifier, and other requirements.</p>
</td>
</tr>
<tr id="obs_04_0005__row15656520821"><td class="cellrowborder" valign="top" width="39.61%" headers="mcps1.3.1.2.2.3.1.1 "><p id="obs_04_0005__p7666520126"><a href="obs_04_0023.html">Obtaining Bucket Metadata</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.39%" headers="mcps1.3.1.2.2.3.1.2 "><p id="obs_04_0005__p175383321619">Checks whether the bucket metadata exists. You can query the information about the bucket region, storage class, OBS version number, and CORS configuration.</p>
</td>
</tr>
<tr id="obs_04_0005__row1669020726"><td class="cellrowborder" valign="top" width="39.61%" headers="mcps1.3.1.2.2.3.1.1 "><p id="obs_04_0005__p196825201627"><a href="obs_04_0024.html">Obtaining Bucket Location</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.39%" headers="mcps1.3.1.2.2.3.1.2 "><p id="obs_04_0005__p147531633171617">Obtains the bucket region information.</p>
</td>
</tr>
<tr id="obs_04_0005__row9685320623"><td class="cellrowborder" valign="top" width="39.61%" headers="mcps1.3.1.2.2.3.1.1 "><p id="obs_04_0005__p669612015212"><a href="obs_04_0025.html">Deleting Buckets</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.39%" headers="mcps1.3.1.2.2.3.1.2 "><p id="obs_04_0005__p1375316339165">Deletes a specified bucket. Before deleting a bucket, ensure that the bucket is empty.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0005__section222510319219"><h4 class="sectiontitle">API Operations on Advanced Bucket Settings</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0005__table21787787" frame="border" border="1" rules="all"><caption><b>Table 2 </b>API operations on advanced bucket settings</caption><thead align="left"><tr id="obs_04_0005__row11729601"><th align="left" class="cellrowborder" valign="top" width="39.910000000000004%" id="mcps1.3.2.2.2.3.1.1"><p id="obs_04_0005__p51157822">Operation</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.089999999999996%" id="mcps1.3.2.2.2.3.1.2"><p id="obs_04_0005__p163114411185">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0005__row50142950"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p20245582"><a href="obs_04_0027.html">Configuring a Bucket Policy</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p19398145175212">Creates or modifies a bucket policy. If the specified bucket already has a policy, the policy in the request will overwrite the existing one.</p>
</td>
</tr>
<tr id="obs_04_0005__row47992515"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p4104320"><a href="obs_04_0028.html">Obtaining Bucket Policy Information</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p2318471813">Obtains the policy information of a specified bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row36938882"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p25902344"><a href="obs_04_0029.html">Deleting a Bucket Policy</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p203154101814">Deletes the policy of a specified bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row31794505"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p29399851"><a href="obs_04_0030.html">Configuring a Bucket ACL</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p43314414187">Configures the ACL of a specified bucket. You can control the read and write permissions of a bucket through ACL settings.</p>
</td>
</tr>
<tr id="obs_04_0005__row63272067"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p59713398"><a href="obs_04_0031.html">Obtaining Bucket ACL Information</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p14335481815">Obtains the ACL information of a specified bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row549671"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p49625342"><a href="obs_04_0032.html">Configuring Logging for a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p93312419189">Enables or disables the log management function of a bucket. When this function is enabled, a log record is generated for each operation on a bucket. Multiple log records are packed into a log file, which will be saved in a specified location.</p>
</td>
</tr>
<tr id="obs_04_0005__row43974897"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p18295456"><a href="obs_04_0033.html">Obtaining a Bucket Logging Configuration</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p12332481814">Obtains the logging configuration of the current bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row461412618318"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p146159261310"><a href="obs_04_0034.html">Configuring Bucket Lifecycle Rules</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p1633748182">Configures rules to automatically delete or migrate objects in a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row5886350183216"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p1188810501325"><a href="obs_04_0035.html">Obtaining Bucket Lifecycle Configuration</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p333154191816">Obtains the lifecycle rules configured for a specified bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row49401830133618"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p694013043619"><a href="obs_04_0036.html">Deleting Lifecycle Rules</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p13331344183">Deletes the lifecycle configuration of a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row30441382"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p9930306"><a href="obs_04_0037.html">Configuring Versioning for a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p13313411814">Enables or disables versioning for a bucket. When this function is enabled, objects of different versions can be retrieved and restored, and data can be quickly restored in case of accidental operations or application faults.</p>
</td>
</tr>
<tr id="obs_04_0005__row22263891"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p44503567"><a href="obs_04_0038.html">Obtaining Bucket Versioning Status</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p933343189">Obtains the versioning status of a specified bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row979014491077"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p2067152785"><a href="obs_04_0039.html">Configuring Event Notification for a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p17339401817">Configures the event notification for a bucket to ensure that the bucket owner is notified about events occur on the bucket in a secure and timely manner.</p>
</td>
</tr>
<tr id="obs_04_0005__row64987789"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p42274750"><a href="obs_04_0040.html">Obtaining the Event Notification Configuration of a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p43313471818">Obtains the notification configuration of a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row44928433"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p33324491"><a href="obs_04_0044.html">Configuring Storage Class for a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p173334111817">Creates or updates the default storage class configuration of a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row31484965"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p11774651"><a href="obs_04_0045.html">Obtaining Bucket Storage Class Information</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p63334141820">Obtains the default storage class configuration of a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row38862996"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p33548891"><a href="obs_04_0046.html">Configuring Cross-Region Replication for a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p733154121819">Configures the cross-region replication function for a bucket. By activating cross-region replication, OBS can copy new objects and modified objects from a source bucket in one region to a destination bucket in a different region.</p>
</td>
</tr>
<tr id="obs_04_0005__row33504565"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p41925888"><a href="obs_04_0047.html">Obtaining the Cross-Region Replication Configuration of a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p11331411184">Obtains the cross-region replication configuration of a specified bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row1149592412327"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p2925172593216"><a href="obs_04_0048.html">Deleting the Cross-Region Replication Configuration of a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p103384161815">Deletes the cross-region replication configuration of a specified bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row293325416321"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p4935115411325"><a href="obs_04_0049.html">Configuring Tags for a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p233104181813">Adds a tag to an existing bucket. <span style="color:#3D3F43;">After tags are added to a bucket, all service detail records (SDRs) generated by the requests for this bucket will have the same tags. You can categorize the SDRs for detailed cost analysis.</span></p>
</td>
</tr>
<tr id="obs_04_0005__row16359036133610"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p15359123613616"><a href="obs_04_0050.html">Obtaining Bucket Tags</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p933164141812">Obtains the tags of a specified bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row41788676"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p35797191"><a href="obs_04_0051.html">Deleting Tags</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p23313416184">Deletes the tags of a specified bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row53739270"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p60490966"><a href="obs_04_0052.html">Configuring Bucket Storage Quota</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p23314417181">Sets the bucket space quota to limit the maximum storage capacity of the bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row1728134011366"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p11282184017369"><a href="obs_04_0053.html">Querying Bucket Storage Quota</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p1133840184">Obtains the bucket space quota.</p>
</td>
</tr>
<tr id="obs_04_0005__row93371813141816"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p47704802516"><a href="obs_04_0054.html">Obtaining Storage Information of a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p1833144131810">Obtains the number of objects in a bucket and the space occupied by the objects.</p>
</td>
</tr>
<tr id="obs_04_0005__row671581513918"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p171661510393"><a href="obs_04_0055.html">Configuring Bucket Inventories</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p07169158390">Configures an inventory rule for a bucket. OBS provides bucket inventories to facilitate your management of objects in a bucket. You can configure bucket inventories to periodically list objects in a bucket. During the listing of objects, object metadata is saved in a CSV file, which is uploaded to the specified bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row198981329183914"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p38981329113912"><a href="obs_04_0056.html">Obtaining a Specific Inventory of a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p14898429193916">Obtains an inventory rule of a specified bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row828195163913"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p11281551123914"><a href="obs_04_0057.html">Listing All Inventories of a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p10281451113910">Obtains all inventory rules of a specified bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row1122449183910"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p2123154983916"><a href="obs_04_0058.html">Deleting Bucket Inventories</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p112316495391">Deletes an inventory rule of a specified bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row17362143213398"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p10362332203918"><a href="obs_04_0059.html">Configuring a Custom Domain Name for a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p736283212397">Configures a custom domain name for a bucket. <span style="color:#3D3F43;">Once a user-defined domain name is successfully configured, the bucket can be accessed through the user-defined domain name.</span></p>
</td>
</tr>
<tr id="obs_04_0005__row1620363515398"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p22031435153916"><a href="obs_04_0060.html">Obtaining the Custom Domain Name of a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p6203173517390">Queries the custom domain name of a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row1884093953912"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p11840143953915"><a href="obs_04_0061.html">Deleting the Custom Domain Name of a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p1884053916398">Deletes the custom domain name of a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row14569184217390"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p657015421395"><a href="obs_04_0062.html">Configuring Bucket Encryption</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p199653120135">Creates or updates the default server-side encryption configuration for a bucket. After encryption is enabled for a bucket, objects uploaded to the bucket are encrypted with the encryption configuration the bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row31612477390"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p11664714393"><a href="obs_04_0063.html">Obtaining Bucket Encryption Configuration</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p7166472397">Queries the default server-side encryption configuration of a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row4195192718395"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p2195162793919"><a href="obs_04_0064.html">Deleting the Encryption Configuration of a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p1319516275397">Deletes the default server-side encryption configuration of a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row371106105512"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p117111762552"><a href="obs_04_0068.html">Configuring the Requester-Pays Function for a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p167116635515">Configures the requester-pays function for a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row1817219965519"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p1317218925518"><a href="obs_04_0069.html">Obtaining the Requester-Pays Configuration Information of a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p617219155513">Obtains the requester-pays configuration information of a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row74799439161"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p9479114321619"><a href="obs_04_0167.html">Configuring a Default WORM Policy for a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p11479164301618">Configures the default WORM policy and a retention period for a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row1795746121614"><td class="cellrowborder" valign="top" width="39.910000000000004%" headers="mcps1.3.2.2.2.3.1.1 "><p id="obs_04_0005__p495164691617"><a href="obs_04_0168.html">Obtaining the Default WORM Policy of a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="60.089999999999996%" headers="mcps1.3.2.2.2.3.1.2 "><p id="obs_04_0005__p3951946131619">Returns the default WORM policy of a bucket.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0005__section13506949424"><h4 class="sectiontitle">API Operations for Static Website Hosting</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0005__table19980316" frame="border" border="1" rules="all"><caption><b>Table 3 </b>API Operations for Static Website Hosting</caption><thead align="left"><tr id="obs_04_0005__row61781656"><th align="left" class="cellrowborder" valign="top" width="40.5%" id="mcps1.3.3.2.2.3.1.1"><p id="obs_04_0005__p11912107">Operation</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.5%" id="mcps1.3.3.2.2.3.1.2"><p id="obs_04_0005__p1310420962620">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0005__row25356585"><td class="cellrowborder" valign="top" width="40.5%" headers="mcps1.3.3.2.2.3.1.1 "><p id="obs_04_0005__p1680854"><a href="obs_04_0071.html">Configuring Static Website Hosting for a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.5%" headers="mcps1.3.3.2.2.3.1.2 "><p id="obs_04_0005__p17104149102614">Creates or updates the website hosting configuration of a bucket. <span style="color:#3D3F43;">OBS allows you to store static web page resources such as HTML web pages, flash files, videos, and audios in a bucket. When a client accesses these resources from the website endpoint of the bucket, the browser can directly resolve and present the resources to the client.</span></p>
</td>
</tr>
<tr id="obs_04_0005__row15127689"><td class="cellrowborder" valign="top" width="40.5%" headers="mcps1.3.3.2.2.3.1.1 "><p id="obs_04_0005__p65870035"><a href="obs_04_0072.html">Obtaining the Static Website Hosting Configuration of a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.5%" headers="mcps1.3.3.2.2.3.1.2 "><p id="obs_04_0005__p1210413922613">Obtains the website hosting configuration of a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row55959406"><td class="cellrowborder" valign="top" width="40.5%" headers="mcps1.3.3.2.2.3.1.1 "><p id="obs_04_0005__p64177416"><a href="obs_04_0073.html">Deleting the Static Website Hosting Configuration of a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.5%" headers="mcps1.3.3.2.2.3.1.2 "><p id="obs_04_0005__p110419122619">Deletes the website hosting configuration of a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row40725835"><td class="cellrowborder" valign="top" width="40.5%" headers="mcps1.3.3.2.2.3.1.1 "><p id="obs_04_0005__p41821194"><a href="obs_04_0074.html">Configuring Bucket CORS</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.5%" headers="mcps1.3.3.2.2.3.1.2 "><p id="obs_04_0005__p91042095267">Configures the cross-origin resource sharing (CORS) configuration of a bucket. <span style="color:#3D3F43;">OBS allows static web page resources to be stored in buckets. The buckets can be used as website resources</span><span style="color:#3D3F43;">. A website hosted by OBS can respond to cross-domain requests from another website only after the CORS rule is configured.</span></p>
</td>
</tr>
<tr id="obs_04_0005__row40846431"><td class="cellrowborder" valign="top" width="40.5%" headers="mcps1.3.3.2.2.3.1.1 "><p id="obs_04_0005__p27744054"><a href="obs_04_0075.html">Obtaining the CORS Configuration of a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.5%" headers="mcps1.3.3.2.2.3.1.2 "><p id="obs_04_0005__p1010416917268">Obtains the CORS configuration of a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row48369902"><td class="cellrowborder" valign="top" width="40.5%" headers="mcps1.3.3.2.2.3.1.1 "><p id="obs_04_0005__p64221938"><a href="obs_04_0076.html">Deleting the CORS Configuration of a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.5%" headers="mcps1.3.3.2.2.3.1.2 "><p id="obs_04_0005__p141054915263">Deletes the CORS configuration of a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row41126533"><td class="cellrowborder" valign="top" width="40.5%" headers="mcps1.3.3.2.2.3.1.1 "><p id="obs_04_0005__p53554153"><a href="obs_04_0077.html">OPTIONS Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.5%" headers="mcps1.3.3.2.2.3.1.2 "><p id="obs_04_0005__p141056919268">Checks whether the client has the permission to perform operations on the server. It is usually performed before the cross-domain access.</p>
</td>
</tr>
<tr id="obs_04_0005__row12225337"><td class="cellrowborder" valign="top" width="40.5%" headers="mcps1.3.3.2.2.3.1.1 "><p id="obs_04_0005__p15349330"><a href="obs_04_0078.html">OPTIONS Object</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.5%" headers="mcps1.3.3.2.2.3.1.2 "><p id="obs_04_0005__p31051896266">Checks whether the client has the permission to perform operations on the server. It is usually performed before the cross-domain access.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0005__section17527191838"><h4 class="sectiontitle">API Operations on Objects</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0005__table7792865" frame="border" border="1" rules="all"><caption><b>Table 4 </b>API operations on objects</caption><thead align="left"><tr id="obs_04_0005__row57419561"><th align="left" class="cellrowborder" valign="top" width="40.8%" id="mcps1.3.4.2.2.3.1.1"><p id="obs_04_0005__p47689484">Operation</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.199999999999996%" id="mcps1.3.4.2.2.3.1.2"><p id="obs_04_0005__p1295124252711">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0005__row37643023"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p15255933"><a href="obs_04_0080.html">Uploading an Object - PUT</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p102951542152717">Uploads an object to a specified bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row3085673"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p45338652"><a href="obs_04_0081.html">Uploading an Object - POST</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p1429514422273">Uploads an object to a specified bucket based on tables.</p>
</td>
</tr>
<tr id="obs_04_0005__row5394690"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p28194798"><a href="obs_04_0082.html">Copying an Object</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p52951742162720">Creates a copy for an existing object in OBS.</p>
</td>
</tr>
<tr id="obs_04_0005__row52426590"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p37933718"><a href="obs_04_0083.html">Downloading an Object</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p429514212716">Downloads an object.</p>
</td>
</tr>
<tr id="obs_04_0005__row5859146"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p55591939"><a href="obs_04_0084.html">Querying Object Metadata</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p122951426278">Obtains the object metadata. Information such as object expiration time, version number, and CORS configuration is the object metadata.</p>
</td>
</tr>
<tr id="obs_04_0005__row30565404"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p18330024"><a href="obs_04_0085.html">Deleting an Object</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p92951642182712">Deletes a specified object. You can also carry the <span style="color:#3D3F43;">versionId</span> field to delete the specified object version.</p>
</td>
</tr>
<tr id="obs_04_0005__row30752495"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p37876676"><a href="obs_04_0086.html">Deleting Objects</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p929574214277">Deletes a batch of objects from a bucket permanently. Objects deleted in this way cannot be recovered.</p>
</td>
</tr>
<tr id="obs_04_0005__row5345769"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p42768539"><a href="obs_04_0087.html">Restoring Cold Objects</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p99055582354">Restores objects in the Cold storage class. You can download these objects only after they are restored.</p>
</td>
</tr>
<tr id="obs_04_0005__row55629712"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p48538422"><a href="obs_04_0089.html">Configuring an Object ACL</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p1129554282719">Configures the ACL of a specified object. You can control the read and write permissions of objects through ACL settings.</p>
</td>
</tr>
<tr id="obs_04_0005__row111314360133"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p913293641310"><a href="obs_04_0090.html">Obtaining Object ACL Configuration</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p2791121115375">Obtains the ACL configuration of a specified object.</p>
</td>
</tr>
<tr id="obs_04_0005__row425845519482"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p18740181219490"><a href="obs_04_0091.html">Modifying Object Metadata</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p1425810552488">Adds, modifies, or deletes metadata of uploaded objects.</p>
</td>
</tr>
<tr id="obs_04_0005__row99230312496"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p13405131324916"><a href="obs_04_0092.html">Modifying an Object</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p39236374910">Modifies the content of an object in a specified parallel file system from the specified location.</p>
</td>
</tr>
<tr id="obs_04_0005__row1720913144914"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p18251131464915"><a href="obs_04_0093.html">Truncating an Object</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p8209114497">Truncates an object in a specified parallel file system to the specified size.</p>
</td>
</tr>
<tr id="obs_04_0005__row7735155824811"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p129488145497"><a href="obs_04_0094.html">Renaming an Object</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p14735135813486">Renames an object in a specified parallel file system.</p>
</td>
</tr>
<tr id="obs_04_0005__row227915791819"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p428055718180"><a href="obs_04_0166.html">Configuring WORM Retention for an Object</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p1828055717189">Configures or updates the retention period for objects uploaded to a bucket with WORM enabled.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0005__section34583211319"><h4 class="sectiontitle">API Operations for Multipart Tasks</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0005__table27242306" frame="border" border="1" rules="all"><caption><b>Table 5 </b>API operations for multipart tasks</caption><thead align="left"><tr id="obs_04_0005__row59968749"><th align="left" class="cellrowborder" valign="top" width="40.65%" id="mcps1.3.5.2.2.3.1.1"><p id="obs_04_0005__p62802766">Operation</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.35%" id="mcps1.3.5.2.2.3.1.2"><p id="obs_04_0005__p10296113133019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0005__row53859287"><td class="cellrowborder" valign="top" width="40.65%" headers="mcps1.3.5.2.2.3.1.1 "><p id="obs_04_0005__p42619108"><a href="obs_04_0097.html">Listing Initiated Multipart Uploads in a Bucket</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.35%" headers="mcps1.3.5.2.2.3.1.2 "><p id="obs_04_0005__p118121583383">Queries all the multipart upload tasks that have not been merged or canceled in a bucket.</p>
</td>
</tr>
<tr id="obs_04_0005__row48027654"><td class="cellrowborder" valign="top" width="40.65%" headers="mcps1.3.5.2.2.3.1.1 "><p id="obs_04_0005__p33322246"><a href="obs_04_0098.html">Initiating a Multipart Upload</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.35%" headers="mcps1.3.5.2.2.3.1.2 "><p id="obs_04_0005__p172967323016">Initiates a multipart upload task, and obtains the globally unique multipart upload task ID for subsequent operations, such as uploading, merging, and listing parts.</p>
</td>
</tr>
<tr id="obs_04_0005__row31464766"><td class="cellrowborder" valign="top" width="40.65%" headers="mcps1.3.5.2.2.3.1.1 "><p id="obs_04_0005__p13467047"><a href="obs_04_0099.html">Uploading Parts</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.35%" headers="mcps1.3.5.2.2.3.1.2 "><p id="obs_04_0005__p142960311301">Uploads parts for a specific multipart task.</p>
</td>
</tr>
<tr id="obs_04_0005__row54094565"><td class="cellrowborder" valign="top" width="40.65%" headers="mcps1.3.5.2.2.3.1.1 "><p id="obs_04_0005__p42774091"><a href="obs_04_0100.html">Copying Parts</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.35%" headers="mcps1.3.5.2.2.3.1.2 "><p id="obs_04_0005__p1056291419425">Copies an object or a part of the object as a part of a multipart task.</p>
</td>
</tr>
<tr id="obs_04_0005__row49422505"><td class="cellrowborder" valign="top" width="40.65%" headers="mcps1.3.5.2.2.3.1.1 "><p id="obs_04_0005__p58136511"><a href="obs_04_0101.html">Listing Uploaded Parts</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.35%" headers="mcps1.3.5.2.2.3.1.2 "><p id="obs_04_0005__p1429613313017">Queries information about all parts of a multipart task.</p>
</td>
</tr>
<tr id="obs_04_0005__row53466558"><td class="cellrowborder" valign="top" width="40.65%" headers="mcps1.3.5.2.2.3.1.1 "><p id="obs_04_0005__p16056153"><a href="obs_04_0102.html">Completing a Multipart Upload</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.35%" headers="mcps1.3.5.2.2.3.1.2 "><p id="obs_04_0005__p182961319305">Merges the specified parts into a complete object.</p>
</td>
</tr>
<tr id="obs_04_0005__row10287649"><td class="cellrowborder" valign="top" width="40.65%" headers="mcps1.3.5.2.2.3.1.1 "><p id="obs_04_0005__p52856884"><a href="obs_04_0103.html">Canceling a Multipart Upload Task</a></p>
</td>
<td class="cellrowborder" valign="top" width="59.35%" headers="mcps1.3.5.2.2.3.1.2 "><p id="obs_04_0005__p72960363010">Cancels a multipart upload task.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
View Git Blame Copy Permalink