diff --git a/docs/obs/api-ref/ALL_META.TXT.json b/docs/obs/api-ref/ALL_META.TXT.json index 516a71d6..36b3b322 100644 --- a/docs/obs/api-ref/ALL_META.TXT.json +++ b/docs/obs/api-ref/ALL_META.TXT.json @@ -523,10 +523,10 @@ "uri":"obs_04_0054.html", "product_code":"obs", "code":"53", - "des":"This operation queries the number of bucket objects and the space occupied by the objects. The size of the object space is a positive integer, measured by bytes.The OBS b", + "des":"This operation queries the number of bucket objects and the space occupied by the objects. The size of the object space is a positive integer, measured by bytes.Because O", "doc_type":"api", - "kw":"Querying Information About Used Space in a Bucket,Advanced Bucket Settings,API Reference", - "title":"Querying Information About Used Space in a Bucket", + "kw":"Obtaining Storage Information of a Bucket,Advanced Bucket Settings,API Reference", + "title":"Obtaining Storage Information of a Bucket", "githuburl":"" }, { @@ -610,9 +610,29 @@ "githuburl":"" }, { - "uri":"obs_04_0070.html", + "uri":"obs_04_0167.html", "product_code":"obs", "code":"62", + "des":"This operation enables WORM for a bucket and allows you to configure the default WORM policy and a retention period.With the bucket's default WORM policy, if you do not s", + "doc_type":"api", + "kw":"Configuring a Default WORM Policy for a Bucket,Advanced Bucket Settings,API Reference", + "title":"Configuring a Default WORM Policy for a Bucket", + "githuburl":"" + }, + { + "uri":"obs_04_0168.html", + "product_code":"obs", + "code":"63", + "des":"This operation returns the default WORM policy of a bucket.To perform this operation, you must have the GetBucketObjectLockConfiguration permission. The bucket owner can ", + "doc_type":"api", + "kw":"Obtaining the Default WORM Policy of a Bucket,Advanced Bucket Settings,API Reference", + "title":"Obtaining the Default WORM Policy of a Bucket", + "githuburl":"" + }, + { + "uri":"obs_04_0070.html", + "product_code":"obs", + "code":"64", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Static Website Hosting", @@ -622,7 +642,7 @@ { "uri":"obs_04_0071.html", "product_code":"obs", - "code":"63", + "code":"65", "des":"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 web", "doc_type":"api", "kw":"Configuring Static Website Hosting for a Bucket,Static Website Hosting,API Reference", @@ -632,7 +652,7 @@ { "uri":"obs_04_0072.html", "product_code":"obs", - "code":"64", + "code":"66", "des":"You can perform this operation to get the static website hosting configuration of a bucket.To perform this operation, you must have the GetBucketWebsite permission. By de", "doc_type":"api", "kw":"Obtaining the Static Website Hosting Configuration of a Bucket,Static Website Hosting,API Reference", @@ -642,7 +662,7 @@ { "uri":"obs_04_0073.html", "product_code":"obs", - "code":"65", + "code":"67", "des":"You can perform this operation to delete the website configuration of a bucket.To perform this operation, you must have the DeleteBucketWebsite permission. By default, on", "doc_type":"api", "kw":"Deleting the Static Website Hosting Configuration of a Bucket,Static Website Hosting,API Reference", @@ -652,7 +672,7 @@ { "uri":"obs_04_0074.html", "product_code":"obs", - "code":"66", + "code":"68", "des":"Cross-origin resource sharing (CORS) is a standard mechanism proposed by World Wide Web Consortium (W3C) and allows cross-origin requests from clients. For standard web p", "doc_type":"api", "kw":"Configuring Bucket CORS,Static Website Hosting,API Reference", @@ -662,7 +682,7 @@ { "uri":"obs_04_0075.html", "product_code":"obs", - "code":"67", + "code":"69", "des":"You can perform this operation to obtain CORS configuration information about a specified bucket.To perform this operation, you must have the GetBucketCORS permission. By", "doc_type":"api", "kw":"Obtaining the CORS Configuration of a Bucket,Static Website Hosting,API Reference", @@ -672,7 +692,7 @@ { "uri":"obs_04_0076.html", "product_code":"obs", - "code":"68", + "code":"70", "des":"This operation is used to delete the CORS configuration of a bucket. After the CORS configuration is deleted, the bucket and objects in it cannot be accessed by requests ", "doc_type":"api", "kw":"Deleting the CORS Configuration of a Bucket,Static Website Hosting,API Reference", @@ -682,7 +702,7 @@ { "uri":"obs_04_0077.html", "product_code":"obs", - "code":"69", + "code":"71", "des":"OPTIONS refers to pre-requests that are sent to servers by clients. Generally, the requests are used to check whether clients have permissions to perform operations on se", "doc_type":"api", "kw":"OPTIONS Bucket,Static Website Hosting,API Reference", @@ -692,7 +712,7 @@ { "uri":"obs_04_0078.html", "product_code":"obs", - "code":"70", + "code":"72", "des":"For details, see OPTIONS Bucket.With the OPTIONS Object, you need to specify an object name in the URL, but an object name is not required with the OPTIONS Bucket, which ", "doc_type":"api", "kw":"OPTIONS Object,Static Website Hosting,API Reference", @@ -702,7 +722,7 @@ { "uri":"obs_04_0079.html", "product_code":"obs", - "code":"71", + "code":"73", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Operations on Objects", @@ -712,8 +732,8 @@ { "uri":"obs_04_0080.html", "product_code":"obs", - "code":"72", - "des":"After bucket creation in OBS, you can use this operation to upload an object to the bucket. This operation uploads an object to a bucket. To use this operation, you must ", + "code":"74", + "des":"After creating a bucket in OBS, you can use this operation to upload an object to the bucket. This operation uploads an object to a bucket. To use this operation, you mus", "doc_type":"api", "kw":"Uploading Objects - PUT,Operations on Objects,API Reference", "title":"Uploading Objects - PUT", @@ -722,7 +742,7 @@ { "uri":"obs_04_0081.html", "product_code":"obs", - "code":"73", + "code":"75", "des":"This operation uploads an object to a bucket. To use this operation, you must have the write permission on the bucket.The name of each object in a bucket must be unique.W", "doc_type":"api", "kw":"Uploading Objects - POST,Operations on Objects,API Reference", @@ -732,7 +752,7 @@ { "uri":"obs_04_0082.html", "product_code":"obs", - "code":"74", + "code":"76", "des":"You can perform this operation to create a copy of an existing object in OBS.Users can determine whether to copy the metadata of the source object to the target object (b", "doc_type":"api", "kw":"Copying Objects,Operations on Objects,API Reference", @@ -742,7 +762,7 @@ { "uri":"obs_04_0083.html", "product_code":"obs", - "code":"75", + "code":"77", "des":"This operation downloads objects from OBS. Before using this GET operation, check that you have the read permission for the target object. If the object owner has granted", "doc_type":"api", "kw":"Downloading Objects,Operations on Objects,API Reference", @@ -752,7 +772,7 @@ { "uri":"obs_04_0084.html", "product_code":"obs", - "code":"76", + "code":"78", "des":"Users with the read permission on objects can perform the HeadObject operation to obtain metadata of objects. The object metadata is included in the response.This operati", "doc_type":"api", "kw":"Querying Object Metadata,Operations on Objects,API Reference", @@ -762,7 +782,7 @@ { "uri":"obs_04_0085.html", "product_code":"obs", - "code":"77", + "code":"79", "des":"You can perform this operation to delete an object. If you try to delete an object that does not exist, OBS will return a success message.When versioning is enabled for a", "doc_type":"api", "kw":"Deleting an Object,Operations on Objects,API Reference", @@ -772,7 +792,7 @@ { "uri":"obs_04_0086.html", "product_code":"obs", - "code":"78", + "code":"80", "des":"This operation can be used to batch delete some objects in a bucket. The deletion cannot be undone. After the operation is implemented, the returned information contains ", "doc_type":"api", "kw":"Deleting Objects,Operations on Objects,API Reference", @@ -782,7 +802,7 @@ { "uri":"obs_04_0087.html", "product_code":"obs", - "code":"79", + "code":"81", "des":"To obtain the content of an object in the Cold storage class, you need to restore the object first and then you can download it. After an object is restored, a copy of th", "doc_type":"api", "kw":"Restoring Cold Objects,Operations on Objects,API Reference", @@ -792,7 +812,7 @@ { "uri":"obs_04_0089.html", "product_code":"obs", - "code":"80", + "code":"82", "des":"OBS supports the control of access permission for objects. By default, only the object creator has the read and write permissions for the object. However, the creator can", "doc_type":"api", "kw":"Configuring an Object ACL,Operations on Objects,API Reference", @@ -802,7 +822,7 @@ { "uri":"obs_04_0090.html", "product_code":"obs", - "code":"81", + "code":"83", "des":"The implementation of this operation returns the ACL configuration of an object. You can perform this operation to view the ACL of an object, as long as you have the read", "doc_type":"api", "kw":"Obtaining Object ACL Configuration,Operations on Objects,API Reference", @@ -812,7 +832,7 @@ { "uri":"obs_04_0091.html", "product_code":"obs", - "code":"82", + "code":"84", "des":"This operation modifies, deletes, or adds metadata to uploaded objects in a bucket.OBS supports the six HTTP request headers: Cache-Control, Expires, Content-Encoding, Co", "doc_type":"api", "kw":"Modifying Object Metadata,Operations on Objects,API Reference", @@ -822,7 +842,7 @@ { "uri":"obs_04_0092.html", "product_code":"obs", - "code":"83", + "code":"85", "des":"This operation can modify an object from a specified position.This API is supported only by parallel file systems. For details about how to create a parallel file system,", "doc_type":"api", "kw":"Modifying an Object,Operations on Objects,API Reference", @@ -832,7 +852,7 @@ { "uri":"obs_04_0093.html", "product_code":"obs", - "code":"84", + "code":"86", "des":"This operation can truncate an object to a specified size.This API is supported only by parallel file systems. For details about how to create a parallel file system, see", "doc_type":"api", "kw":"Truncating an Object,Operations on Objects,API Reference", @@ -842,17 +862,27 @@ { "uri":"obs_04_0094.html", "product_code":"obs", - "code":"85", - "des":"This operation can rename an object.This API is supported only by parallel file systems. For details about how to create a parallel file system, see Sample Request 4. Ren", + "code":"87", + "des":"This operation can rename an object.This API is supported only by parallel file systems. For details about how to create a parallel file system, see Sample Request: Creat", "doc_type":"api", "kw":"Renaming an Object,Operations on Objects,API Reference", "title":"Renaming an Object", "githuburl":"" }, + { + "uri":"obs_04_0166.html", + "product_code":"obs", + "code":"88", + "des":"This operation configures or updates the retention period for objects uploaded to a bucket with WORM enabled.When you upload an object, if you do not configure a protecti", + "doc_type":"api", + "kw":"Configuring WORM Retention for an Object,Operations on Objects,API Reference", + "title":"Configuring WORM Retention for an Object", + "githuburl":"" + }, { "uri":"obs_04_0096.html", "product_code":"obs", - "code":"86", + "code":"89", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Operations on Multipart Upload", @@ -862,7 +892,7 @@ { "uri":"obs_04_0097.html", "product_code":"obs", - "code":"87", + "code":"90", "des":"This operation queries all the multipart upload tasks that are initialized but have not been merged or canceled in a bucket.This request uses parameters to specify the qu", "doc_type":"api", "kw":"Listing Initiated Multipart Uploads in a Bucket,Operations on Multipart Upload,API Reference", @@ -872,7 +902,7 @@ { "uri":"obs_04_0098.html", "product_code":"obs", - "code":"88", + "code":"91", "des":"Before using this operation, make an API operation call to create a multipart upload task. The system will return a globally unique upload ID as the multipart upload iden", "doc_type":"api", "kw":"Initiating a Multipart Upload,Operations on Multipart Upload,API Reference", @@ -882,27 +912,27 @@ { "uri":"obs_04_0099.html", "product_code":"obs", - "code":"89", + "code":"92", "des":"After initiating a multipart upload, you can use this operation to upload parts for the multipart upload using its task ID. When parts are uploaded in a multipart upload ", "doc_type":"api", - "kw":"Multipart Upload,Operations on Multipart Upload,API Reference", - "title":"Multipart Upload", + "kw":"Uploading Parts,Operations on Multipart Upload,API Reference", + "title":"Uploading Parts", "githuburl":"" }, { "uri":"obs_04_0100.html", "product_code":"obs", - "code":"90", + "code":"93", "des":"After creating a multipart upload job, you can specify its upload ID and upload a part to the job in OBS. Alternatively, you can make an API call to add a part (part of a", "doc_type":"api", - "kw":"Uploading a Part of an Object - Copy,Operations on Multipart Upload,API Reference", - "title":"Uploading a Part of an Object - Copy", + "kw":"Copying Parts,Operations on Multipart Upload,API Reference", + "title":"Copying Parts", "githuburl":"" }, { "uri":"obs_04_0101.html", "product_code":"obs", - "code":"91", + "code":"94", "des":"You can perform this operation to query all parts associated to a multipart upload. The size of each part listed by this API is the same as the size of the part uploaded.", "doc_type":"api", "kw":"Listing Uploaded Parts of an Object,Operations on Multipart Upload,API Reference", @@ -912,7 +942,7 @@ { "uri":"obs_04_0102.html", "product_code":"obs", - "code":"92", + "code":"95", "des":"After uploading all parts for a multipart upload, you can use this operation to complete the multipart upload. Before performing this operation, you cannot download the u", "doc_type":"api", "kw":"Completing a Multipart Upload,Operations on Multipart Upload,API Reference", @@ -922,7 +952,7 @@ { "uri":"obs_04_0103.html", "product_code":"obs", - "code":"93", + "code":"96", "des":"You can perform this operation to abort a multipart upload. You cannot upload or list parts after operations to merge parts or abort a multipart upload are performed.This", "doc_type":"api", "kw":"Canceling a Multipart Upload Task,Operations on Multipart Upload,API Reference", @@ -932,7 +962,7 @@ { "uri":"obs_04_0104.html", "product_code":"obs", - "code":"94", + "code":"97", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Server-Side Encryption", @@ -942,7 +972,7 @@ { "uri":"obs_04_0105.html", "product_code":"obs", - "code":"95", + "code":"98", "des":"Users can upload and download objects in common mode or using server-side encryption.OBS supports server-side encryption.Users can implement this function based on the ke", "doc_type":"api", "kw":"Server-Side Encryption Overview,Server-Side Encryption,API Reference", @@ -952,8 +982,8 @@ { "uri":"obs_04_0106.html", "product_code":"obs", - "code":"96", - "des":"In the SSE-KMS mode, OBS uses the keys provided by KMS for server-side encryption. When an object encrypted using SSE-KMS is added to a bucket in a region for the first t", + "code":"99", + "des":"With SSE-KMS, OBS uses the keys provided by Key Management Service (KMS) for server-side encryption. You can create custom keys on KMS to encrypt your objects. If you do ", "doc_type":"api", "kw":"Server-Side Encryption (SSE-KMS),Server-Side Encryption,API Reference", "title":"Server-Side Encryption (SSE-KMS)", @@ -962,8 +992,8 @@ { "uri":"obs_04_0107.html", "product_code":"obs", - "code":"97", - "des":"In the SSE-C mode, OBS uses the keys and MD5 values provided by customers for server-side encryption.OBS does not store your encryption keys. If you lost your encryption ", + "code":"100", + "des":"With SSE-C used, OBS uses the keys and MD5 values provided by customers for server-side encryption.OBS does not store your encryption keys. If you lost them, you lost the", "doc_type":"api", "kw":"Server-Side Encryption (SSE-C),Server-Side Encryption,API Reference", "title":"Server-Side Encryption (SSE-C)", @@ -972,7 +1002,7 @@ { "uri":"obs_04_0108.html", "product_code":"obs", - "code":"98", + "code":"101", "des":"This section lists the operations related to server-side encryption and describes HTTP protocols applicable to the operations.The following table describes the requiremen", "doc_type":"api", "kw":"API Operations Related to Server-Side Encryption,Server-Side Encryption,API Reference", @@ -982,7 +1012,7 @@ { "uri":"obs_04_0115.html", "product_code":"obs", - "code":"99", + "code":"102", "des":"If an API call fails, no result data is returned. You can locate the cause of the error according to the error code of each API. If an API call fails, HTTP status code 3x", "doc_type":"api", "kw":"Error Codes,API Reference", @@ -992,7 +1022,7 @@ { "uri":"obs_04_0113.html", "product_code":"obs", - "code":"100", + "code":"103", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Appendixes", @@ -1002,7 +1032,7 @@ { "uri":"obs_04_0114.html", "product_code":"obs", - "code":"101", + "code":"104", "des":"Table 1 lists the status codes and prompt message returned by the server to the user.Send API requests using the HTTP/HTTPS format that complies with https://www.ietf.org", "doc_type":"api", "kw":"Status Codes,Appendixes,API Reference", @@ -1012,7 +1042,7 @@ { "uri":"obs_04_0116.html", "product_code":"obs", - "code":"102", + "code":"105", "des":"When you call APIs, you need to use the AK and SK for authentication. To obtain the AK and SK, perform the following steps:Keep AKs and SKs properly to prevent informatio", "doc_type":"api", "kw":"Obtaining Access Keys (AK/SK),Appendixes,API Reference", @@ -1022,7 +1052,7 @@ { "uri":"obs_04_0117.html", "product_code":"obs", - "code":"103", + "code":"106", "des":"During API calls, the domain ID (DomainID) and user ID (UserID) need to be specified in some requests. Therefore, you need to obtain them from the console. The procedure ", "doc_type":"api", "kw":"Obtaining the Domain ID and User ID,Appendixes,API Reference", @@ -1032,7 +1062,7 @@ { "uri":"obs_04_0118.html", "product_code":"obs", - "code":"104", + "code":"107", "des":"After a success message is returned in response to a client's write or deletion request, the client can obtain the latest data. If a client that initiates a write request", "doc_type":"api", "kw":"Consistency of Concurrent Operations,Appendixes,API Reference", @@ -1042,7 +1072,7 @@ { "uri":"obs_04_0000.html", "product_code":"obs", - "code":"105", + "code":"108", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", diff --git a/docs/obs/api-ref/CLASS.TXT.json b/docs/obs/api-ref/CLASS.TXT.json index 005b5fb7..d1579b8d 100644 --- a/docs/obs/api-ref/CLASS.TXT.json +++ b/docs/obs/api-ref/CLASS.TXT.json @@ -468,9 +468,9 @@ "code":"52" }, { - "desc":"This operation queries the number of bucket objects and the space occupied by the objects. The size of the object space is a positive integer, measured by bytes.The OBS b", + "desc":"This operation queries the number of bucket objects and the space occupied by the objects. The size of the object space is a positive integer, measured by bytes.Because O", "product_code":"obs", - "title":"Querying Information About Used Space in a Bucket", + "title":"Obtaining Storage Information of a Bucket", "uri":"obs_04_0054.html", "doc_type":"api", "p_code":"28", @@ -548,6 +548,24 @@ "p_code":"28", "code":"61" }, + { + "desc":"This operation enables WORM for a bucket and allows you to configure the default WORM policy and a retention period.With the bucket's default WORM policy, if you do not s", + "product_code":"obs", + "title":"Configuring a Default WORM Policy for a Bucket", + "uri":"obs_04_0167.html", + "doc_type":"api", + "p_code":"28", + "code":"62" + }, + { + "desc":"This operation returns the default WORM policy of a bucket.To perform this operation, you must have the GetBucketObjectLockConfiguration permission. The bucket owner can ", + "product_code":"obs", + "title":"Obtaining the Default WORM Policy of a Bucket", + "uri":"obs_04_0168.html", + "doc_type":"api", + "p_code":"28", + "code":"63" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"obs", @@ -555,7 +573,7 @@ "uri":"obs_04_0070.html", "doc_type":"api", "p_code":"19", - "code":"62" + "code":"64" }, { "desc":"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 web", @@ -563,8 +581,8 @@ "title":"Configuring Static Website Hosting for a Bucket", "uri":"obs_04_0071.html", "doc_type":"api", - "p_code":"62", - "code":"63" + "p_code":"64", + "code":"65" }, { "desc":"You can perform this operation to get the static website hosting configuration of a bucket.To perform this operation, you must have the GetBucketWebsite permission. By de", @@ -572,8 +590,8 @@ "title":"Obtaining the Static Website Hosting Configuration of a Bucket", "uri":"obs_04_0072.html", "doc_type":"api", - "p_code":"62", - "code":"64" + "p_code":"64", + "code":"66" }, { "desc":"You can perform this operation to delete the website configuration of a bucket.To perform this operation, you must have the DeleteBucketWebsite permission. By default, on", @@ -581,8 +599,8 @@ "title":"Deleting the Static Website Hosting Configuration of a Bucket", "uri":"obs_04_0073.html", "doc_type":"api", - "p_code":"62", - "code":"65" + "p_code":"64", + "code":"67" }, { "desc":"Cross-origin resource sharing (CORS) is a standard mechanism proposed by World Wide Web Consortium (W3C) and allows cross-origin requests from clients. For standard web p", @@ -590,8 +608,8 @@ "title":"Configuring Bucket CORS", "uri":"obs_04_0074.html", "doc_type":"api", - "p_code":"62", - "code":"66" + "p_code":"64", + "code":"68" }, { "desc":"You can perform this operation to obtain CORS configuration information about a specified bucket.To perform this operation, you must have the GetBucketCORS permission. By", @@ -599,8 +617,8 @@ "title":"Obtaining the CORS Configuration of a Bucket", "uri":"obs_04_0075.html", "doc_type":"api", - "p_code":"62", - "code":"67" + "p_code":"64", + "code":"69" }, { "desc":"This operation is used to delete the CORS configuration of a bucket. After the CORS configuration is deleted, the bucket and objects in it cannot be accessed by requests ", @@ -608,8 +626,8 @@ "title":"Deleting the CORS Configuration of a Bucket", "uri":"obs_04_0076.html", "doc_type":"api", - "p_code":"62", - "code":"68" + "p_code":"64", + "code":"70" }, { "desc":"OPTIONS refers to pre-requests that are sent to servers by clients. Generally, the requests are used to check whether clients have permissions to perform operations on se", @@ -617,8 +635,8 @@ "title":"OPTIONS Bucket", "uri":"obs_04_0077.html", "doc_type":"api", - "p_code":"62", - "code":"69" + "p_code":"64", + "code":"71" }, { "desc":"For details, see OPTIONS Bucket.With the OPTIONS Object, you need to specify an object name in the URL, but an object name is not required with the OPTIONS Bucket, which ", @@ -626,8 +644,8 @@ "title":"OPTIONS Object", "uri":"obs_04_0078.html", "doc_type":"api", - "p_code":"62", - "code":"70" + "p_code":"64", + "code":"72" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -636,16 +654,16 @@ "uri":"obs_04_0079.html", "doc_type":"api", "p_code":"19", - "code":"71" + "code":"73" }, { - "desc":"After bucket creation in OBS, you can use this operation to upload an object to the bucket. This operation uploads an object to a bucket. To use this operation, you must ", + "desc":"After creating a bucket in OBS, you can use this operation to upload an object to the bucket. This operation uploads an object to a bucket. To use this operation, you mus", "product_code":"obs", "title":"Uploading Objects - PUT", "uri":"obs_04_0080.html", "doc_type":"api", - "p_code":"71", - "code":"72" + "p_code":"73", + "code":"74" }, { "desc":"This operation uploads an object to a bucket. To use this operation, you must have the write permission on the bucket.The name of each object in a bucket must be unique.W", @@ -653,8 +671,8 @@ "title":"Uploading Objects - POST", "uri":"obs_04_0081.html", "doc_type":"api", - "p_code":"71", - "code":"73" + "p_code":"73", + "code":"75" }, { "desc":"You can perform this operation to create a copy of an existing object in OBS.Users can determine whether to copy the metadata of the source object to the target object (b", @@ -662,8 +680,8 @@ "title":"Copying Objects", "uri":"obs_04_0082.html", "doc_type":"api", - "p_code":"71", - "code":"74" + "p_code":"73", + "code":"76" }, { "desc":"This operation downloads objects from OBS. Before using this GET operation, check that you have the read permission for the target object. If the object owner has granted", @@ -671,8 +689,8 @@ "title":"Downloading Objects", "uri":"obs_04_0083.html", "doc_type":"api", - "p_code":"71", - "code":"75" + "p_code":"73", + "code":"77" }, { "desc":"Users with the read permission on objects can perform the HeadObject operation to obtain metadata of objects. The object metadata is included in the response.This operati", @@ -680,8 +698,8 @@ "title":"Querying Object Metadata", "uri":"obs_04_0084.html", "doc_type":"api", - "p_code":"71", - "code":"76" + "p_code":"73", + "code":"78" }, { "desc":"You can perform this operation to delete an object. If you try to delete an object that does not exist, OBS will return a success message.When versioning is enabled for a", @@ -689,8 +707,8 @@ "title":"Deleting an Object", "uri":"obs_04_0085.html", "doc_type":"api", - "p_code":"71", - "code":"77" + "p_code":"73", + "code":"79" }, { "desc":"This operation can be used to batch delete some objects in a bucket. The deletion cannot be undone. After the operation is implemented, the returned information contains ", @@ -698,8 +716,8 @@ "title":"Deleting Objects", "uri":"obs_04_0086.html", "doc_type":"api", - "p_code":"71", - "code":"78" + "p_code":"73", + "code":"80" }, { "desc":"To obtain the content of an object in the Cold storage class, you need to restore the object first and then you can download it. After an object is restored, a copy of th", @@ -707,8 +725,8 @@ "title":"Restoring Cold Objects", "uri":"obs_04_0087.html", "doc_type":"api", - "p_code":"71", - "code":"79" + "p_code":"73", + "code":"81" }, { "desc":"OBS supports the control of access permission for objects. By default, only the object creator has the read and write permissions for the object. However, the creator can", @@ -716,8 +734,8 @@ "title":"Configuring an Object ACL", "uri":"obs_04_0089.html", "doc_type":"api", - "p_code":"71", - "code":"80" + "p_code":"73", + "code":"82" }, { "desc":"The implementation of this operation returns the ACL configuration of an object. You can perform this operation to view the ACL of an object, as long as you have the read", @@ -725,8 +743,8 @@ "title":"Obtaining Object ACL Configuration", "uri":"obs_04_0090.html", "doc_type":"api", - "p_code":"71", - "code":"81" + "p_code":"73", + "code":"83" }, { "desc":"This operation modifies, deletes, or adds metadata to uploaded objects in a bucket.OBS supports the six HTTP request headers: Cache-Control, Expires, Content-Encoding, Co", @@ -734,8 +752,8 @@ "title":"Modifying Object Metadata", "uri":"obs_04_0091.html", "doc_type":"api", - "p_code":"71", - "code":"82" + "p_code":"73", + "code":"84" }, { "desc":"This operation can modify an object from a specified position.This API is supported only by parallel file systems. For details about how to create a parallel file system,", @@ -743,8 +761,8 @@ "title":"Modifying an Object", "uri":"obs_04_0092.html", "doc_type":"api", - "p_code":"71", - "code":"83" + "p_code":"73", + "code":"85" }, { "desc":"This operation can truncate an object to a specified size.This API is supported only by parallel file systems. For details about how to create a parallel file system, see", @@ -752,17 +770,26 @@ "title":"Truncating an Object", "uri":"obs_04_0093.html", "doc_type":"api", - "p_code":"71", - "code":"84" + "p_code":"73", + "code":"86" }, { - "desc":"This operation can rename an object.This API is supported only by parallel file systems. For details about how to create a parallel file system, see Sample Request 4. Ren", + "desc":"This operation can rename an object.This API is supported only by parallel file systems. For details about how to create a parallel file system, see Sample Request: Creat", "product_code":"obs", "title":"Renaming an Object", "uri":"obs_04_0094.html", "doc_type":"api", - "p_code":"71", - "code":"85" + "p_code":"73", + "code":"87" + }, + { + "desc":"This operation configures or updates the retention period for objects uploaded to a bucket with WORM enabled.When you upload an object, if you do not configure a protecti", + "product_code":"obs", + "title":"Configuring WORM Retention for an Object", + "uri":"obs_04_0166.html", + "doc_type":"api", + "p_code":"73", + "code":"88" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -771,7 +798,7 @@ "uri":"obs_04_0096.html", "doc_type":"api", "p_code":"19", - "code":"86" + "code":"89" }, { "desc":"This operation queries all the multipart upload tasks that are initialized but have not been merged or canceled in a bucket.This request uses parameters to specify the qu", @@ -779,8 +806,8 @@ "title":"Listing Initiated Multipart Uploads in a Bucket", "uri":"obs_04_0097.html", "doc_type":"api", - "p_code":"86", - "code":"87" + "p_code":"89", + "code":"90" }, { "desc":"Before using this operation, make an API operation call to create a multipart upload task. The system will return a globally unique upload ID as the multipart upload iden", @@ -788,26 +815,26 @@ "title":"Initiating a Multipart Upload", "uri":"obs_04_0098.html", "doc_type":"api", - "p_code":"86", - "code":"88" + "p_code":"89", + "code":"91" }, { "desc":"After initiating a multipart upload, you can use this operation to upload parts for the multipart upload using its task ID. When parts are uploaded in a multipart upload ", "product_code":"obs", - "title":"Multipart Upload", + "title":"Uploading Parts", "uri":"obs_04_0099.html", "doc_type":"api", - "p_code":"86", - "code":"89" + "p_code":"89", + "code":"92" }, { "desc":"After creating a multipart upload job, you can specify its upload ID and upload a part to the job in OBS. Alternatively, you can make an API call to add a part (part of a", "product_code":"obs", - "title":"Uploading a Part of an Object - Copy", + "title":"Copying Parts", "uri":"obs_04_0100.html", "doc_type":"api", - "p_code":"86", - "code":"90" + "p_code":"89", + "code":"93" }, { "desc":"You can perform this operation to query all parts associated to a multipart upload. The size of each part listed by this API is the same as the size of the part uploaded.", @@ -815,8 +842,8 @@ "title":"Listing Uploaded Parts of an Object", "uri":"obs_04_0101.html", "doc_type":"api", - "p_code":"86", - "code":"91" + "p_code":"89", + "code":"94" }, { "desc":"After uploading all parts for a multipart upload, you can use this operation to complete the multipart upload. Before performing this operation, you cannot download the u", @@ -824,8 +851,8 @@ "title":"Completing a Multipart Upload", "uri":"obs_04_0102.html", "doc_type":"api", - "p_code":"86", - "code":"92" + "p_code":"89", + "code":"95" }, { "desc":"You can perform this operation to abort a multipart upload. You cannot upload or list parts after operations to merge parts or abort a multipart upload are performed.This", @@ -833,8 +860,8 @@ "title":"Canceling a Multipart Upload Task", "uri":"obs_04_0103.html", "doc_type":"api", - "p_code":"86", - "code":"93" + "p_code":"89", + "code":"96" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -843,7 +870,7 @@ "uri":"obs_04_0104.html", "doc_type":"api", "p_code":"19", - "code":"94" + "code":"97" }, { "desc":"Users can upload and download objects in common mode or using server-side encryption.OBS supports server-side encryption.Users can implement this function based on the ke", @@ -851,26 +878,26 @@ "title":"Server-Side Encryption Overview", "uri":"obs_04_0105.html", "doc_type":"api", - "p_code":"94", - "code":"95" + "p_code":"97", + "code":"98" }, { - "desc":"In the SSE-KMS mode, OBS uses the keys provided by KMS for server-side encryption. When an object encrypted using SSE-KMS is added to a bucket in a region for the first t", + "desc":"With SSE-KMS, OBS uses the keys provided by Key Management Service (KMS) for server-side encryption. You can create custom keys on KMS to encrypt your objects. If you do ", "product_code":"obs", "title":"Server-Side Encryption (SSE-KMS)", "uri":"obs_04_0106.html", "doc_type":"api", - "p_code":"94", - "code":"96" + "p_code":"97", + "code":"99" }, { - "desc":"In the SSE-C mode, OBS uses the keys and MD5 values provided by customers for server-side encryption.OBS does not store your encryption keys. If you lost your encryption ", + "desc":"With SSE-C used, OBS uses the keys and MD5 values provided by customers for server-side encryption.OBS does not store your encryption keys. If you lost them, you lost the", "product_code":"obs", "title":"Server-Side Encryption (SSE-C)", "uri":"obs_04_0107.html", "doc_type":"api", - "p_code":"94", - "code":"97" + "p_code":"97", + "code":"100" }, { "desc":"This section lists the operations related to server-side encryption and describes HTTP protocols applicable to the operations.The following table describes the requiremen", @@ -878,8 +905,8 @@ "title":"API Operations Related to Server-Side Encryption", "uri":"obs_04_0108.html", "doc_type":"api", - "p_code":"94", - "code":"98" + "p_code":"97", + "code":"101" }, { "desc":"If an API call fails, no result data is returned. You can locate the cause of the error according to the error code of each API. If an API call fails, HTTP status code 3x", @@ -888,7 +915,7 @@ "uri":"obs_04_0115.html", "doc_type":"api", "p_code":"", - "code":"99" + "code":"102" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -897,7 +924,7 @@ "uri":"obs_04_0113.html", "doc_type":"api", "p_code":"", - "code":"100" + "code":"103" }, { "desc":"Table 1 lists the status codes and prompt message returned by the server to the user.Send API requests using the HTTP/HTTPS format that complies with https://www.ietf.org", @@ -905,8 +932,8 @@ "title":"Status Codes", "uri":"obs_04_0114.html", "doc_type":"api", - "p_code":"100", - "code":"101" + "p_code":"103", + "code":"104" }, { "desc":"When you call APIs, you need to use the AK and SK for authentication. To obtain the AK and SK, perform the following steps:Keep AKs and SKs properly to prevent informatio", @@ -914,8 +941,8 @@ "title":"Obtaining Access Keys (AK/SK)", "uri":"obs_04_0116.html", "doc_type":"api", - "p_code":"100", - "code":"102" + "p_code":"103", + "code":"105" }, { "desc":"During API calls, the domain ID (DomainID) and user ID (UserID) need to be specified in some requests. Therefore, you need to obtain them from the console. The procedure ", @@ -923,8 +950,8 @@ "title":"Obtaining the Domain ID and User ID", "uri":"obs_04_0117.html", "doc_type":"api", - "p_code":"100", - "code":"103" + "p_code":"103", + "code":"106" }, { "desc":"After a success message is returned in response to a client's write or deletion request, the client can obtain the latest data. If a client that initiates a write request", @@ -932,8 +959,8 @@ "title":"Consistency of Concurrent Operations", "uri":"obs_04_0118.html", "doc_type":"api", - "p_code":"100", - "code":"104" + "p_code":"103", + "code":"107" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -942,6 +969,6 @@ "uri":"obs_04_0000.html", "doc_type":"api", "p_code":"", - "code":"105" + "code":"108" } ] \ No newline at end of file diff --git a/docs/obs/api-ref/obs_04_0000.html b/docs/obs/api-ref/obs_04_0000.html index 50d834cc..02485d39 100644 --- a/docs/obs/api-ref/obs_04_0000.html +++ b/docs/obs/api-ref/obs_04_0000.html @@ -8,7 +8,14 @@ -
2023-06-20
+2023-08-15
+This is the eighth official release.
+This issue incorporates the following change:
+2023-06-20
This is the seventh official release.
This issue incorporates the following changes:
diff --git a/docs/obs/api-ref/obs_04_0005.html b/docs/obs/api-ref/obs_04_0005.html index 07d8a5d1..54450583 100644 --- a/docs/obs/api-ref/obs_04_0005.html +++ b/docs/obs/api-ref/obs_04_0005.html @@ -169,7 +169,7 @@Obtains the bucket space quota.
Obtains the number of objects in a bucket and the space occupied by the objects.
Initiates a multipart upload task, and obtains the globally unique multipart upload task ID for subsequent operations, such as uploading, merging, and listing parts.
Uploads parts for a specific multipart task.
Copies an object or a part of the object as a part of a multipart task.
Indicates the OBS resource specified by an HTTP request. This parameter is constructed as follows:
<Bucket name + Object name> + [Subresource 1] + [Subresource 2] + ...
-OBS supports a variety of sub-resources, including acl, attname, cors, customdomain, delete, deletebucket, encryption, length, lifecycle, location, logging, metadata, modify, name, notification, partNumber, policy, position, quota, rename, replication, requestPayment, response-cache-control, response-content-disposition, response-content-encoding, response-content-language, response-content-type, response-expires, restore, storageClass, storagePolicy, storageinfo, tagging, torrent, truncate, uploadId, uploads, versionId, versioning, versions, website, and x-obs-security-token.
+OBS supports a variety of sub-resources, including acl, attname, cors, customdomain, delete, deletebucket, encryption, length, lifecycle, location, logging, metadata, modify, name, notification, partNumber, policy, position, quota, rename, replication, requestPayment, response-cache-control, response-content-disposition, response-content-encoding, response-content-language, response-content-type, response-expires, restore, storageClass, storagePolicy, storageinfo, tagging, torrent, truncate, uploadId, uploads, versionId, versioning, versions, website, object-lock, retention, and x-obs-security-token.
Indicates the OBS resource specified by an HTTP request. This parameter is constructed as follows:
<Bucket name + Object name> + [Subresource 1] + [Subresource 2] + ...
-OBS supports a variety of sub-resources, including acl, attname, cors, customdomain, delete, deletebucket, encryption, length, lifecycle, location, logging, metadata, modify, name, notification, partNumber, policy, position, quota, rename, replication, requestPayment, response-cache-control, response-content-disposition, response-content-encoding, response-content-language, response-content-type, response-expires, restore, storageClass, storagePolicy, storageinfo, tagging, torrent, truncate, uploadId, uploads, versionId, versioning, versions, website, and x-obs-security-token.
+OBS supports a variety of sub-resources, including acl, attname, cors, customdomain, delete, deletebucket, encryption, length, lifecycle, location, logging, metadata, modify, name, notification, partNumber, policy, position, quota, rename, replication, requestPayment, response-cache-control, response-content-disposition, response-content-encoding, response-content-language, response-content-type, response-expires, restore, storageClass, storagePolicy, storageinfo, tagging, torrent, truncate, uploadId, uploads, versionId, versioning, versions, website, object-lock, retention, and x-obs-security-token.
This operation is used to create a bucket with a specified name.
-A bucket name must be unique in OBS. If a user creates a bucket with the same name as that of an existing bucket under the same account and in the same region, a 200 code (indicating success) is returned. In scenarios other than the preceding one, the request for creating a bucket with the same name as that of an existing one will receive the 409 code (indicating that a namesake bucket already exists). To set an access control policy for the bucket to be created, you can add the x-obs-acl parameter to request headers.
You can create buckets with different storage classes. The x-obs-storage-class header in a bucket creation request specifies the storage class for a bucket. If you do not specify a storage class when you upload an object to the bucket, the object inherits the storage class of the bucket. There are three storage classes: STANDARD (Standard storage class), WARM (Warm storage class), and COLD (Cold storage class) If this header is not in the request, the storage class of the created bucket is Standard.
+You can create buckets with different storage classes. The x-obs-storage-class header in a bucket creation request specifies the storage class for a bucket. If you do not specify a storage class when you upload an object to the bucket, the object inherits the storage class of the bucket. There are three storage classes: STANDARD (Standard storage class), WARM (Warm storage class), and COLD (Cold storage class) If this header is not in the request, the storage class of the created bucket is Standard.
If the storage class of an object is not specified when it is uploaded to a bucket (see Uploading Objects - PUT), the object will be stored in the default storage class of the bucket.
No
x-obs-bucket-object-lock-enabled
+When creating a bucket, you can use this header to enable WORM for the bucket.
+Type: string
+Example: x-obs-bucket-object-lock-enabled:true
+No
+No special error responses are returned. For details about error responses, see Table 2.
Create a bucket.
-1 + |