diff --git a/docs/obs/api-ref/ALL_META.TXT.json b/docs/obs/api-ref/ALL_META.TXT.json
new file mode 100644
index 00000000..087cb83d
--- /dev/null
+++ b/docs/obs/api-ref/ALL_META.TXT.json
@@ -0,0 +1,952 @@
+[
+ {
+ "uri":"obs_04_0001.html",
+ "product_code":"obs",
+ "code":"1",
+ "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":"Before You Start",
+ "title":"Before You Start",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0031051947.html",
+ "product_code":"obs",
+ "code":"2",
+ "des":"Welcome to the Object Storage Service API Reference. Object Storage Service (OBS) provides massive, secure, reliable, and cost-effective data storage capabilities for use",
+ "doc_type":"api",
+ "kw":"Overview,Before You Start,API Reference (OBS)",
+ "title":"Overview",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0002.html",
+ "product_code":"obs",
+ "code":"3",
+ "des":"OBS provides Representational State Transfer (REST) APIs, allowing you to use HTTP or HTTPS requests to call them. For details, see Calling APIs.",
+ "doc_type":"api",
+ "kw":"API Calling,Before You Start,API Reference (OBS)",
+ "title":"API Calling",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0003.html",
+ "product_code":"obs",
+ "code":"4",
+ "des":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of services, see Regions and Endpoints.OBS prov",
+ "doc_type":"api",
+ "kw":"Endpoints,Before You Start,API Reference (OBS)",
+ "title":"Endpoints",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0004.html",
+ "product_code":"obs",
+ "code":"5",
+ "des":"DomainYou can register a domain with the cloud service. The domain has full access permissions for all the resources and cloud services that are subscribed under it. The ",
+ "doc_type":"api",
+ "kw":"Basic Concepts,Before You Start,API Reference (OBS)",
+ "title":"Basic Concepts",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0005.html",
+ "product_code":"obs",
+ "code":"6",
+ "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":"API Overview,API Reference (OBS)",
+ "title":"API Overview",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0006.html",
+ "product_code":"obs",
+ "code":"7",
+ "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":"Calling APIs",
+ "title":"Calling APIs",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0007.html",
+ "product_code":"obs",
+ "code":"8",
+ "des":"This section describes the structure of a REST API request.OBS uses URI to locate specific buckets, objects, and their parameters. Use URIs when you want to operate resou",
+ "doc_type":"api",
+ "kw":"Constructing a Request,Calling APIs,API Reference (OBS)",
+ "title":"Constructing a Request",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0008.html",
+ "product_code":"obs",
+ "code":"9",
+ "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":"Authentication",
+ "title":"Authentication",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0009.html",
+ "product_code":"obs",
+ "code":"10",
+ "des":"OBS signs a request using AK/SK. When a client is sending a request to OBS, the message header must contain the SK, request time, request type, and other information of t",
+ "doc_type":"api",
+ "kw":"User Signature Authentication,Authentication,API Reference (OBS)",
+ "title":"User Signature Authentication",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0010.html",
+ "product_code":"obs",
+ "code":"11",
+ "des":"For all API operations, the most common identity authentication is to carry signatures in headers.In the header, the signature is carried in the authorization header fiel",
+ "doc_type":"api",
+ "kw":"Authentication of Signature in a Header,Authentication,API Reference (OBS)",
+ "title":"Authentication of Signature in a Header",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0011.html",
+ "product_code":"obs",
+ "code":"12",
+ "des":"OBS allows users to construct a URL for a specific operation. The URL contains information such as the user's AK, signature, validity period, and resources. Any user who ",
+ "doc_type":"api",
+ "kw":"Authentication of Signature in a URL,Authentication,API Reference (OBS)",
+ "title":"Authentication of Signature in a URL",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0012.html",
+ "product_code":"obs",
+ "code":"13",
+ "des":"OBS supports browser-based object upload using the POST method. Signatures of such requests are uploaded in tables. First, create a security policy and specify the requir",
+ "doc_type":"api",
+ "kw":"Authentication of Signature Carried in the Table Uploaded Through a Browser,Authentication,API Refer",
+ "title":"Authentication of Signature Carried in the Table Uploaded Through a Browser",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0013.html",
+ "product_code":"obs",
+ "code":"14",
+ "des":"After sending a request, you will receive a response, including the status code, response header, and response body.A status code is a group of digits ranging from 2xx (i",
+ "doc_type":"api",
+ "kw":"Returned Values,Calling APIs,API Reference (OBS)",
+ "title":"Returned Values",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0014.html",
+ "product_code":"obs",
+ "code":"15",
+ "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":"Getting Started",
+ "title":"Getting Started",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0015.html",
+ "product_code":"obs",
+ "code":"16",
+ "des":"A bucket is a container that stores objects in OBS. You need to create a bucket before storing data in OBS.The following describes how to call the API for creating a buck",
+ "doc_type":"api",
+ "kw":"Creating a Bucket,Getting Started,API Reference (OBS)",
+ "title":"Creating a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0016.html",
+ "product_code":"obs",
+ "code":"17",
+ "des":"If you want to view information about all buckets created by yourself, you can call the API for listing buckets.The following describes how to call the API for listing bu",
+ "doc_type":"api",
+ "kw":"Listing Buckets,Getting Started,API Reference (OBS)",
+ "title":"Listing Buckets",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0017.html",
+ "product_code":"obs",
+ "code":"18",
+ "des":"You can upload files of any type to OBS buckets for storage.The following describes how to call the API for uploading objects using the PUT method to a specified bucket. ",
+ "doc_type":"api",
+ "kw":"Uploading an Object,Getting Started,API Reference (OBS)",
+ "title":"Uploading an Object",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0018.html",
+ "product_code":"obs",
+ "code":"19",
+ "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":"APIs",
+ "title":"APIs",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0019.html",
+ "product_code":"obs",
+ "code":"20",
+ "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 Buckets",
+ "title":"Operations on Buckets",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0020.html",
+ "product_code":"obs",
+ "code":"21",
+ "des":"You can perform this operation to list all buckets that you have created.This request contains no parameter.This request header uses common message fields. For details, s",
+ "doc_type":"api",
+ "kw":"Listing Buckets,Operations on Buckets,API Reference (OBS)",
+ "title":"Listing Buckets",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0021.html",
+ "product_code":"obs",
+ "code":"22",
+ "des":"This operation is used to create a bucket with a specified name.By default, a user can have a maximum of 100 buckets.The name of a deleted bucket can be reused for a buck",
+ "doc_type":"api",
+ "kw":"Creating a Bucket,Operations on Buckets,API Reference (OBS)",
+ "title":"Creating a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0022.html",
+ "product_code":"obs",
+ "code":"23",
+ "des":"This operation lists objects in a bucket. To use this operation, you must have the permission to read the bucket.If you specify only the bucket name in the request URI, f",
+ "doc_type":"api",
+ "kw":"Listing Objects in a Bucket,Operations on Buckets,API Reference (OBS)",
+ "title":"Listing Objects in a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0023.html",
+ "product_code":"obs",
+ "code":"24",
+ "des":"This operation queries the metadata of a bucket. To use this operation, you must have the permission to read the bucket.This request contains no parameter.This request us",
+ "doc_type":"api",
+ "kw":"Obtaining Bucket Metadata,Operations on Buckets,API Reference (OBS)",
+ "title":"Obtaining Bucket Metadata",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0024.html",
+ "product_code":"obs",
+ "code":"25",
+ "des":"This operation obtains the location of a bucket. To use this operation, you must have the permission to read the bucket.This request contains no parameters.This request u",
+ "doc_type":"api",
+ "kw":"Obtaining Bucket Location,Operations on Buckets,API Reference (OBS)",
+ "title":"Obtaining Bucket Location",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0025.html",
+ "product_code":"obs",
+ "code":"26",
+ "des":"This operation deletes specified buckets. This operation can be performed only by the bucket owner and users who have been authorized (via a policy) with the permission t",
+ "doc_type":"api",
+ "kw":"Deleting Buckets,Operations on Buckets,API Reference (OBS)",
+ "title":"Deleting Buckets",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0026.html",
+ "product_code":"obs",
+ "code":"27",
+ "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":"Advanced Bucket Settings",
+ "title":"Advanced Bucket Settings",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0027.html",
+ "product_code":"obs",
+ "code":"28",
+ "des":"This operation creates or modifies policies for buckets. If the specified bucket already has a policy, the policy in the request will overwrite the existing one. There is",
+ "doc_type":"api",
+ "kw":"Configuring a Bucket Policy,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Configuring a Bucket Policy",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0028.html",
+ "product_code":"obs",
+ "code":"29",
+ "des":"This operation uses the sub-resources of policy to return the policy information of a specified bucket.To perform this operation, the user must be the bucket owner or the",
+ "doc_type":"api",
+ "kw":"Obtaining Bucket Policy Information,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Obtaining Bucket Policy Information",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0029.html",
+ "product_code":"obs",
+ "code":"30",
+ "des":"This operation uses the policy sub-resources to delete the policy of a specified bucket.To perform this operation, the user must be the bucket owner or the bucket owner's",
+ "doc_type":"api",
+ "kw":"Deleting a Bucket Policy,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Deleting a Bucket Policy",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0030.html",
+ "product_code":"obs",
+ "code":"31",
+ "des":"This operation controls access permissions for buckets. By default, only the creator of a bucket has the permission to read and write the bucket. You can also set other a",
+ "doc_type":"api",
+ "kw":"Configuring a Bucket ACL,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Configuring a Bucket ACL",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0031.html",
+ "product_code":"obs",
+ "code":"32",
+ "des":"This operation returns the ACL information of a bucket. To obtain the ACL of a bucket, you need to have the READ_ACP or FULL_CONTROL permission for the bucket.This reques",
+ "doc_type":"api",
+ "kw":"Obtaining Bucket ACL Information,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Obtaining Bucket ACL Information",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0032.html",
+ "product_code":"obs",
+ "code":"33",
+ "des":"When a bucket is created, the logging function is not enabled by default. To generate logs recording operations on buckets, you need to enable the logging function for th",
+ "doc_type":"api",
+ "kw":"Configuring Logging for a Bucket,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Configuring Logging for a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0033.html",
+ "product_code":"obs",
+ "code":"34",
+ "des":"This operation queries the logging status of a bucket. It uses the logging sub-resource to return the logging status of a bucket.Only the bucket owner or users granted th",
+ "doc_type":"api",
+ "kw":"Obtaining a Bucket Logging Configuration,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Obtaining a Bucket Logging Configuration",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0034.html",
+ "product_code":"obs",
+ "code":"35",
+ "des":"This operation configures lifecycle rules that can delete or migrate objects from a bucket at a specified time. Typical application scenarios:Delete periodically uploaded",
+ "doc_type":"api",
+ "kw":"Configuring Bucket Lifecycle Rules,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Configuring Bucket Lifecycle Rules",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0035.html",
+ "product_code":"obs",
+ "code":"36",
+ "des":"This operation obtains the bucket lifecycle configuration.To perform this operation, you must have the GetLifecycleConfiguration permission. By default, only the bucket o",
+ "doc_type":"api",
+ "kw":"Obtaining Bucket Lifecycle Configuration,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Obtaining Bucket Lifecycle Configuration",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0036.html",
+ "product_code":"obs",
+ "code":"37",
+ "des":"This operation deletes the lifecycle configuration of a bucket. After the lifecycle configuration of a bucket is deleted, OBS will not automatically delete objects in tha",
+ "doc_type":"api",
+ "kw":"Deleting Lifecycle Rules,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Deleting Lifecycle Rules",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0037.html",
+ "product_code":"obs",
+ "code":"38",
+ "des":"This operation restores an object that is mistakenly overwritten or deleted. You can use versioning to save, query, and restore objects of different versions. Versioning ",
+ "doc_type":"api",
+ "kw":"Configuring Versioning for a Bucket,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Configuring Versioning for a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0038.html",
+ "product_code":"obs",
+ "code":"39",
+ "des":"This operation allows a bucket owner to get the versioning status of the bucket.If versioning is not configured for a bucket, no versioning status information will be ret",
+ "doc_type":"api",
+ "kw":"Obtaining Bucket Versioning Status,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Obtaining Bucket Versioning Status",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0039.html",
+ "product_code":"obs",
+ "code":"40",
+ "des":"This operation notifies users of their operations on buckets, allowing users know events happened on buckets in a timely manner.By default, the notification function of a",
+ "doc_type":"api",
+ "kw":"Configuring Event Notification for a Bucket,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Configuring Event Notification for a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0040.html",
+ "product_code":"obs",
+ "code":"41",
+ "des":"This operation obtains the notification configuration of a bucket.To perform this operation, you must have the GetBucketNotification permission. By default, the permissio",
+ "doc_type":"api",
+ "kw":"Obtaining the Event Notification Configuration of a Bucket,Advanced Bucket Settings,API Reference (O",
+ "title":"Obtaining the Event Notification Configuration of a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0044.html",
+ "product_code":"obs",
+ "code":"42",
+ "des":"This operation sets or updates the default storage class of a bucket.To perform this operation, you must have the PutBucketStoragePolicy permission. By default, only the ",
+ "doc_type":"api",
+ "kw":"Configuring Storage Class for a Bucket,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Configuring Storage Class for a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0045.html",
+ "product_code":"obs",
+ "code":"43",
+ "des":"This operation obtains the default storage class of a bucket.To perform this operation, you must have the GetBucketStoragePolicy permission. By default, only the bucket o",
+ "doc_type":"api",
+ "kw":"Obtaining Bucket Storage Class Information,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Obtaining Bucket Storage Class Information",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0049.html",
+ "product_code":"obs",
+ "code":"44",
+ "des":"This operation adds tags to a bucket.After tags are added to a bucket, all charging data records (CDRs) generated by the requests for this bucket will take the same tags.",
+ "doc_type":"api",
+ "kw":"Configuring Tags for a Bucket,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Configuring Tags for a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0050.html",
+ "product_code":"obs",
+ "code":"45",
+ "des":"This operation obtains information about tags of a bucket.To perform this operation, you must have the GetBucketTagging permission. By default, only the bucket owner can ",
+ "doc_type":"api",
+ "kw":"Obtaining Bucket Tags,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Obtaining Bucket Tags",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0051.html",
+ "product_code":"obs",
+ "code":"46",
+ "des":"This operation deletes the tags of a bucket.To perform this operation, you must have the PutBucketTagging permission. By default, only the bucket owner can delete the tag",
+ "doc_type":"api",
+ "kw":"Deleting Tags,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Deleting Tags",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0052.html",
+ "product_code":"obs",
+ "code":"47",
+ "des":"The bucket storage quota must be a positive integer in the unit of byte. The maximum storage quota is 263 – 1 bytes. The default bucket storage quota is 0, indicating tha",
+ "doc_type":"api",
+ "kw":"Configuring Bucket Storage Quota,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Configuring Bucket Storage Quota",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0053.html",
+ "product_code":"obs",
+ "code":"48",
+ "des":"Only the bucket owner can query information about the bucket storage quota. However, an inactive owner is not allowed to get the bucket quota. The bucket storage quota is",
+ "doc_type":"api",
+ "kw":"Querying Bucket Storage Quota,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Querying Bucket Storage Quota",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0054.html",
+ "product_code":"obs",
+ "code":"49",
+ "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",
+ "doc_type":"api",
+ "kw":"Querying Information About Used Space in a Bucket,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Querying Information About Used Space in a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0059.html",
+ "product_code":"obs",
+ "code":"50",
+ "des":"OBS uses the PUT method to configure a custom domain name for a bucket. After the configuration is successful, you can access the bucket through the domain name.Ensure th",
+ "doc_type":"api",
+ "kw":"Configuring a Custom Domain Name for a Bucket,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Configuring a Custom Domain Name for a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0060.html",
+ "product_code":"obs",
+ "code":"51",
+ "des":"OBS uses the GET method to obtain the custom domain name of a bucket.This request message does not contain the request parameters.This request uses common headers. For de",
+ "doc_type":"api",
+ "kw":"Obtaining the Custom Domain Name of a Bucket,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Obtaining the Custom Domain Name of a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0061.html",
+ "product_code":"obs",
+ "code":"52",
+ "des":"OBS uses the DELETE method to delete the custom domain name of a bucket.This request uses common headers. For details, see Table 3.This request involves no elements.The r",
+ "doc_type":"api",
+ "kw":"Deleting the Custom Domain Name of a Bucket,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Deleting the Custom Domain Name of a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0062.html",
+ "product_code":"obs",
+ "code":"53",
+ "des":"OBS uses the PUT method to create or update the default server-side encryption for a bucket.After encryption is enabled for a bucket, objects uploaded to the bucket are e",
+ "doc_type":"api",
+ "kw":"Configuring Bucket Encryption,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Configuring Bucket Encryption",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0063.html",
+ "product_code":"obs",
+ "code":"54",
+ "des":"OBS uses the GET method to obtain the encryption configuration of a specified bucket.To perform this operation, you must have the GetEncryptionConfiguration permission. B",
+ "doc_type":"api",
+ "kw":"Obtaining Bucket Encryption Configuration,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Obtaining Bucket Encryption Configuration",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0064.html",
+ "product_code":"obs",
+ "code":"55",
+ "des":"OBS uses the DELETE method to delete the encryption configuration of a specified bucket.To perform this operation, you must have the PutEncryptionConfiguration permission",
+ "doc_type":"api",
+ "kw":"Deleting the Encryption Configuration of a Bucket,Advanced Bucket Settings,API Reference (OBS)",
+ "title":"Deleting the Encryption Configuration of a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0070.html",
+ "product_code":"obs",
+ "code":"56",
+ "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",
+ "title":"Static Website Hosting",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0071.html",
+ "product_code":"obs",
+ "code":"57",
+ "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 (OBS)",
+ "title":"Configuring Static Website Hosting for a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0072.html",
+ "product_code":"obs",
+ "code":"58",
+ "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 ",
+ "title":"Obtaining the Static Website Hosting Configuration of a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0073.html",
+ "product_code":"obs",
+ "code":"59",
+ "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 (",
+ "title":"Deleting the Static Website Hosting Configuration of a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0074.html",
+ "product_code":"obs",
+ "code":"60",
+ "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 (OBS)",
+ "title":"Configuring Bucket CORS",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0075.html",
+ "product_code":"obs",
+ "code":"61",
+ "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 (OBS)",
+ "title":"Obtaining the CORS Configuration of a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0076.html",
+ "product_code":"obs",
+ "code":"62",
+ "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 (OBS)",
+ "title":"Deleting the CORS Configuration of a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0077.html",
+ "product_code":"obs",
+ "code":"63",
+ "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 (OBS)",
+ "title":"OPTIONS Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0078.html",
+ "product_code":"obs",
+ "code":"64",
+ "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 (OBS)",
+ "title":"OPTIONS Object",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0079.html",
+ "product_code":"obs",
+ "code":"65",
+ "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",
+ "title":"Operations on Objects",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0080.html",
+ "product_code":"obs",
+ "code":"66",
+ "des":"After bucket creation in OBS, you can use this operation to upload an object to the bucket. Uploading an object adds it to a bucket. This requires users to have the write",
+ "doc_type":"api",
+ "kw":"Uploading Objects - PUT,Operations on Objects,API Reference (OBS)",
+ "title":"Uploading Objects - PUT",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0081.html",
+ "product_code":"obs",
+ "code":"67",
+ "des":"Uploading an object adds it to a bucket. This requires users to have the write operation.The name of each object in a bucket must be unique.With versioning not enabled, i",
+ "doc_type":"api",
+ "kw":"Uploading Objects - POST,Operations on Objects,API Reference (OBS)",
+ "title":"Uploading Objects - POST",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0082.html",
+ "product_code":"obs",
+ "code":"68",
+ "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 (OBS)",
+ "title":"Copying Objects",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0083.html",
+ "product_code":"obs",
+ "code":"69",
+ "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 (OBS)",
+ "title":"Downloading Objects",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0084.html",
+ "product_code":"obs",
+ "code":"70",
+ "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 (OBS)",
+ "title":"Querying Object Metadata",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0085.html",
+ "product_code":"obs",
+ "code":"71",
+ "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 (OBS)",
+ "title":"Deleting an Object",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0086.html",
+ "product_code":"obs",
+ "code":"72",
+ "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 (OBS)",
+ "title":"Deleting Objects",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0087.html",
+ "product_code":"obs",
+ "code":"73",
+ "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 (OBS)",
+ "title":"Restoring Cold Objects",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0089.html",
+ "product_code":"obs",
+ "code":"74",
+ "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 (OBS)",
+ "title":"Configuring an Object ACL",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0090.html",
+ "product_code":"obs",
+ "code":"75",
+ "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 (OBS)",
+ "title":"Obtaining Object ACL Configuration",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0096.html",
+ "product_code":"obs",
+ "code":"76",
+ "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",
+ "title":"Operations on Multipart Upload",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0097.html",
+ "product_code":"obs",
+ "code":"77",
+ "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 Initialized Multipart Tasks in a Bucket,Operations on Multipart Upload,API Reference (OBS)",
+ "title":"Listing Initialized Multipart Tasks in a Bucket",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0098.html",
+ "product_code":"obs",
+ "code":"78",
+ "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":"Initializing a Multipart Task,Operations on Multipart Upload,API Reference (OBS)",
+ "title":"Initializing a Multipart Task",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0099.html",
+ "product_code":"obs",
+ "code":"79",
+ "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 (OBS)",
+ "title":"Multipart Upload",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0100.html",
+ "product_code":"obs",
+ "code":"80",
+ "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 (OBS)",
+ "title":"Uploading a Part of an Object - Copy",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0101.html",
+ "product_code":"obs",
+ "code":"81",
+ "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 (OBS)",
+ "title":"Listing Uploaded Parts of an Object",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0102.html",
+ "product_code":"obs",
+ "code":"82",
+ "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":"Merging Parts into a Complete Object,Operations on Multipart Upload,API Reference (OBS)",
+ "title":"Merging Parts into a Complete Object",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0103.html",
+ "product_code":"obs",
+ "code":"83",
+ "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 (OBS)",
+ "title":"Canceling a Multipart Upload Task",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0104.html",
+ "product_code":"obs",
+ "code":"84",
+ "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",
+ "title":"Server-Side Encryption",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0105.html",
+ "product_code":"obs",
+ "code":"85",
+ "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 (OBS)",
+ "title":"Server-Side Encryption Overview",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0106.html",
+ "product_code":"obs",
+ "code":"86",
+ "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",
+ "doc_type":"api",
+ "kw":"Server-Side Encryption (SSE-KMS),Server-Side Encryption,API Reference (OBS)",
+ "title":"Server-Side Encryption (SSE-KMS)",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0107.html",
+ "product_code":"obs",
+ "code":"87",
+ "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 ",
+ "doc_type":"api",
+ "kw":"Server-Side Encryption (SSE-C),Server-Side Encryption,API Reference (OBS)",
+ "title":"Server-Side Encryption (SSE-C)",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0108.html",
+ "product_code":"obs",
+ "code":"88",
+ "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 (OBS)",
+ "title":"API Operations Related to Server-Side Encryption",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0113.html",
+ "product_code":"obs",
+ "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":"Appendixes",
+ "title":"Appendixes",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0114.html",
+ "product_code":"obs",
+ "code":"90",
+ "des":"Table 1 lists the status codes and prompt message returned by the server to the user.",
+ "doc_type":"api",
+ "kw":"Status Codes,Appendixes,API Reference (OBS)",
+ "title":"Status Codes",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0115.html",
+ "product_code":"obs",
+ "code":"91",
+ "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,Appendixes,API Reference (OBS)",
+ "title":"Error Codes",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0116.html",
+ "product_code":"obs",
+ "code":"92",
+ "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 (OBS)",
+ "title":"Obtaining Access Keys (AK/SK)",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0117.html",
+ "product_code":"obs",
+ "code":"93",
+ "des":"When an API is called, 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 proce",
+ "doc_type":"api",
+ "kw":"Obtaining the Domain ID and User ID,Appendixes,API Reference (OBS)",
+ "title":"Obtaining the Domain ID and User ID",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0118.html",
+ "product_code":"obs",
+ "code":"94",
+ "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 (OBS)",
+ "title":"Consistency of Concurrent Operations",
+ "githuburl":""
+ },
+ {
+ "uri":"obs_04_0000.html",
+ "product_code":"obs",
+ "code":"95",
+ "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 (OBS)",
+ "title":"Change History",
+ "githuburl":""
+ }
+]
\ No newline at end of file
diff --git a/docs/obs/api-ref/CLASS.TXT.json b/docs/obs/api-ref/CLASS.TXT.json
new file mode 100644
index 00000000..81972687
--- /dev/null
+++ b/docs/obs/api-ref/CLASS.TXT.json
@@ -0,0 +1,857 @@
+[
+ {
+ "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",
+ "title":"Before You Start",
+ "uri":"obs_04_0001.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"1"
+ },
+ {
+ "desc":"Welcome to the Object Storage Service API Reference. Object Storage Service (OBS) provides massive, secure, reliable, and cost-effective data storage capabilities for use",
+ "product_code":"obs",
+ "title":"Overview",
+ "uri":"en-us_topic_0031051947.html",
+ "doc_type":"api",
+ "p_code":"1",
+ "code":"2"
+ },
+ {
+ "desc":"OBS provides Representational State Transfer (REST) APIs, allowing you to use HTTP or HTTPS requests to call them. For details, see Calling APIs.",
+ "product_code":"obs",
+ "title":"API Calling",
+ "uri":"obs_04_0002.html",
+ "doc_type":"api",
+ "p_code":"1",
+ "code":"3"
+ },
+ {
+ "desc":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of services, see Regions and Endpoints.OBS prov",
+ "product_code":"obs",
+ "title":"Endpoints",
+ "uri":"obs_04_0003.html",
+ "doc_type":"api",
+ "p_code":"1",
+ "code":"4"
+ },
+ {
+ "desc":"DomainYou can register a domain with the cloud service. The domain has full access permissions for all the resources and cloud services that are subscribed under it. The ",
+ "product_code":"obs",
+ "title":"Basic Concepts",
+ "uri":"obs_04_0004.html",
+ "doc_type":"api",
+ "p_code":"1",
+ "code":"5"
+ },
+ {
+ "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",
+ "title":"API Overview",
+ "uri":"obs_04_0005.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"6"
+ },
+ {
+ "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",
+ "title":"Calling APIs",
+ "uri":"obs_04_0006.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"7"
+ },
+ {
+ "desc":"This section describes the structure of a REST API request.OBS uses URI to locate specific buckets, objects, and their parameters. Use URIs when you want to operate resou",
+ "product_code":"obs",
+ "title":"Constructing a Request",
+ "uri":"obs_04_0007.html",
+ "doc_type":"api",
+ "p_code":"7",
+ "code":"8"
+ },
+ {
+ "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",
+ "title":"Authentication",
+ "uri":"obs_04_0008.html",
+ "doc_type":"api",
+ "p_code":"7",
+ "code":"9"
+ },
+ {
+ "desc":"OBS signs a request using AK/SK. When a client is sending a request to OBS, the message header must contain the SK, request time, request type, and other information of t",
+ "product_code":"obs",
+ "title":"User Signature Authentication",
+ "uri":"obs_04_0009.html",
+ "doc_type":"api",
+ "p_code":"9",
+ "code":"10"
+ },
+ {
+ "desc":"For all API operations, the most common identity authentication is to carry signatures in headers.In the header, the signature is carried in the authorization header fiel",
+ "product_code":"obs",
+ "title":"Authentication of Signature in a Header",
+ "uri":"obs_04_0010.html",
+ "doc_type":"api",
+ "p_code":"9",
+ "code":"11"
+ },
+ {
+ "desc":"OBS allows users to construct a URL for a specific operation. The URL contains information such as the user's AK, signature, validity period, and resources. Any user who ",
+ "product_code":"obs",
+ "title":"Authentication of Signature in a URL",
+ "uri":"obs_04_0011.html",
+ "doc_type":"api",
+ "p_code":"9",
+ "code":"12"
+ },
+ {
+ "desc":"OBS supports browser-based object upload using the POST method. Signatures of such requests are uploaded in tables. First, create a security policy and specify the requir",
+ "product_code":"obs",
+ "title":"Authentication of Signature Carried in the Table Uploaded Through a Browser",
+ "uri":"obs_04_0012.html",
+ "doc_type":"api",
+ "p_code":"9",
+ "code":"13"
+ },
+ {
+ "desc":"After sending a request, you will receive a response, including the status code, response header, and response body.A status code is a group of digits ranging from 2xx (i",
+ "product_code":"obs",
+ "title":"Returned Values",
+ "uri":"obs_04_0013.html",
+ "doc_type":"api",
+ "p_code":"7",
+ "code":"14"
+ },
+ {
+ "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",
+ "title":"Getting Started",
+ "uri":"obs_04_0014.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"15"
+ },
+ {
+ "desc":"A bucket is a container that stores objects in OBS. You need to create a bucket before storing data in OBS.The following describes how to call the API for creating a buck",
+ "product_code":"obs",
+ "title":"Creating a Bucket",
+ "uri":"obs_04_0015.html",
+ "doc_type":"api",
+ "p_code":"15",
+ "code":"16"
+ },
+ {
+ "desc":"If you want to view information about all buckets created by yourself, you can call the API for listing buckets.The following describes how to call the API for listing bu",
+ "product_code":"obs",
+ "title":"Listing Buckets",
+ "uri":"obs_04_0016.html",
+ "doc_type":"api",
+ "p_code":"15",
+ "code":"17"
+ },
+ {
+ "desc":"You can upload files of any type to OBS buckets for storage.The following describes how to call the API for uploading objects using the PUT method to a specified bucket. ",
+ "product_code":"obs",
+ "title":"Uploading an Object",
+ "uri":"obs_04_0017.html",
+ "doc_type":"api",
+ "p_code":"15",
+ "code":"18"
+ },
+ {
+ "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",
+ "title":"APIs",
+ "uri":"obs_04_0018.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"19"
+ },
+ {
+ "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",
+ "title":"Operations on Buckets",
+ "uri":"obs_04_0019.html",
+ "doc_type":"api",
+ "p_code":"19",
+ "code":"20"
+ },
+ {
+ "desc":"You can perform this operation to list all buckets that you have created.This request contains no parameter.This request header uses common message fields. For details, s",
+ "product_code":"obs",
+ "title":"Listing Buckets",
+ "uri":"obs_04_0020.html",
+ "doc_type":"api",
+ "p_code":"20",
+ "code":"21"
+ },
+ {
+ "desc":"This operation is used to create a bucket with a specified name.By default, a user can have a maximum of 100 buckets.The name of a deleted bucket can be reused for a buck",
+ "product_code":"obs",
+ "title":"Creating a Bucket",
+ "uri":"obs_04_0021.html",
+ "doc_type":"api",
+ "p_code":"20",
+ "code":"22"
+ },
+ {
+ "desc":"This operation lists objects in a bucket. To use this operation, you must have the permission to read the bucket.If you specify only the bucket name in the request URI, f",
+ "product_code":"obs",
+ "title":"Listing Objects in a Bucket",
+ "uri":"obs_04_0022.html",
+ "doc_type":"api",
+ "p_code":"20",
+ "code":"23"
+ },
+ {
+ "desc":"This operation queries the metadata of a bucket. To use this operation, you must have the permission to read the bucket.This request contains no parameter.This request us",
+ "product_code":"obs",
+ "title":"Obtaining Bucket Metadata",
+ "uri":"obs_04_0023.html",
+ "doc_type":"api",
+ "p_code":"20",
+ "code":"24"
+ },
+ {
+ "desc":"This operation obtains the location of a bucket. To use this operation, you must have the permission to read the bucket.This request contains no parameters.This request u",
+ "product_code":"obs",
+ "title":"Obtaining Bucket Location",
+ "uri":"obs_04_0024.html",
+ "doc_type":"api",
+ "p_code":"20",
+ "code":"25"
+ },
+ {
+ "desc":"This operation deletes specified buckets. This operation can be performed only by the bucket owner and users who have been authorized (via a policy) with the permission t",
+ "product_code":"obs",
+ "title":"Deleting Buckets",
+ "uri":"obs_04_0025.html",
+ "doc_type":"api",
+ "p_code":"20",
+ "code":"26"
+ },
+ {
+ "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",
+ "title":"Advanced Bucket Settings",
+ "uri":"obs_04_0026.html",
+ "doc_type":"api",
+ "p_code":"19",
+ "code":"27"
+ },
+ {
+ "desc":"This operation creates or modifies policies for buckets. If the specified bucket already has a policy, the policy in the request will overwrite the existing one. There is",
+ "product_code":"obs",
+ "title":"Configuring a Bucket Policy",
+ "uri":"obs_04_0027.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"28"
+ },
+ {
+ "desc":"This operation uses the sub-resources of policy to return the policy information of a specified bucket.To perform this operation, the user must be the bucket owner or the",
+ "product_code":"obs",
+ "title":"Obtaining Bucket Policy Information",
+ "uri":"obs_04_0028.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"29"
+ },
+ {
+ "desc":"This operation uses the policy sub-resources to delete the policy of a specified bucket.To perform this operation, the user must be the bucket owner or the bucket owner's",
+ "product_code":"obs",
+ "title":"Deleting a Bucket Policy",
+ "uri":"obs_04_0029.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"30"
+ },
+ {
+ "desc":"This operation controls access permissions for buckets. By default, only the creator of a bucket has the permission to read and write the bucket. You can also set other a",
+ "product_code":"obs",
+ "title":"Configuring a Bucket ACL",
+ "uri":"obs_04_0030.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"31"
+ },
+ {
+ "desc":"This operation returns the ACL information of a bucket. To obtain the ACL of a bucket, you need to have the READ_ACP or FULL_CONTROL permission for the bucket.This reques",
+ "product_code":"obs",
+ "title":"Obtaining Bucket ACL Information",
+ "uri":"obs_04_0031.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"32"
+ },
+ {
+ "desc":"When a bucket is created, the logging function is not enabled by default. To generate logs recording operations on buckets, you need to enable the logging function for th",
+ "product_code":"obs",
+ "title":"Configuring Logging for a Bucket",
+ "uri":"obs_04_0032.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"33"
+ },
+ {
+ "desc":"This operation queries the logging status of a bucket. It uses the logging sub-resource to return the logging status of a bucket.Only the bucket owner or users granted th",
+ "product_code":"obs",
+ "title":"Obtaining a Bucket Logging Configuration",
+ "uri":"obs_04_0033.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"34"
+ },
+ {
+ "desc":"This operation configures lifecycle rules that can delete or migrate objects from a bucket at a specified time. Typical application scenarios:Delete periodically uploaded",
+ "product_code":"obs",
+ "title":"Configuring Bucket Lifecycle Rules",
+ "uri":"obs_04_0034.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"35"
+ },
+ {
+ "desc":"This operation obtains the bucket lifecycle configuration.To perform this operation, you must have the GetLifecycleConfiguration permission. By default, only the bucket o",
+ "product_code":"obs",
+ "title":"Obtaining Bucket Lifecycle Configuration",
+ "uri":"obs_04_0035.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"36"
+ },
+ {
+ "desc":"This operation deletes the lifecycle configuration of a bucket. After the lifecycle configuration of a bucket is deleted, OBS will not automatically delete objects in tha",
+ "product_code":"obs",
+ "title":"Deleting Lifecycle Rules",
+ "uri":"obs_04_0036.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"37"
+ },
+ {
+ "desc":"This operation restores an object that is mistakenly overwritten or deleted. You can use versioning to save, query, and restore objects of different versions. Versioning ",
+ "product_code":"obs",
+ "title":"Configuring Versioning for a Bucket",
+ "uri":"obs_04_0037.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"38"
+ },
+ {
+ "desc":"This operation allows a bucket owner to get the versioning status of the bucket.If versioning is not configured for a bucket, no versioning status information will be ret",
+ "product_code":"obs",
+ "title":"Obtaining Bucket Versioning Status",
+ "uri":"obs_04_0038.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"39"
+ },
+ {
+ "desc":"This operation notifies users of their operations on buckets, allowing users know events happened on buckets in a timely manner.By default, the notification function of a",
+ "product_code":"obs",
+ "title":"Configuring Event Notification for a Bucket",
+ "uri":"obs_04_0039.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"40"
+ },
+ {
+ "desc":"This operation obtains the notification configuration of a bucket.To perform this operation, you must have the GetBucketNotification permission. By default, the permissio",
+ "product_code":"obs",
+ "title":"Obtaining the Event Notification Configuration of a Bucket",
+ "uri":"obs_04_0040.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"41"
+ },
+ {
+ "desc":"This operation sets or updates the default storage class of a bucket.To perform this operation, you must have the PutBucketStoragePolicy permission. By default, only the ",
+ "product_code":"obs",
+ "title":"Configuring Storage Class for a Bucket",
+ "uri":"obs_04_0044.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"42"
+ },
+ {
+ "desc":"This operation obtains the default storage class of a bucket.To perform this operation, you must have the GetBucketStoragePolicy permission. By default, only the bucket o",
+ "product_code":"obs",
+ "title":"Obtaining Bucket Storage Class Information",
+ "uri":"obs_04_0045.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"43"
+ },
+ {
+ "desc":"This operation adds tags to a bucket.After tags are added to a bucket, all charging data records (CDRs) generated by the requests for this bucket will take the same tags.",
+ "product_code":"obs",
+ "title":"Configuring Tags for a Bucket",
+ "uri":"obs_04_0049.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"44"
+ },
+ {
+ "desc":"This operation obtains information about tags of a bucket.To perform this operation, you must have the GetBucketTagging permission. By default, only the bucket owner can ",
+ "product_code":"obs",
+ "title":"Obtaining Bucket Tags",
+ "uri":"obs_04_0050.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"45"
+ },
+ {
+ "desc":"This operation deletes the tags of a bucket.To perform this operation, you must have the PutBucketTagging permission. By default, only the bucket owner can delete the tag",
+ "product_code":"obs",
+ "title":"Deleting Tags",
+ "uri":"obs_04_0051.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"46"
+ },
+ {
+ "desc":"The bucket storage quota must be a positive integer in the unit of byte. The maximum storage quota is 263 – 1 bytes. The default bucket storage quota is 0, indicating tha",
+ "product_code":"obs",
+ "title":"Configuring Bucket Storage Quota",
+ "uri":"obs_04_0052.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"47"
+ },
+ {
+ "desc":"Only the bucket owner can query information about the bucket storage quota. However, an inactive owner is not allowed to get the bucket quota. The bucket storage quota is",
+ "product_code":"obs",
+ "title":"Querying Bucket Storage Quota",
+ "uri":"obs_04_0053.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"48"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Querying Information About Used Space in a Bucket",
+ "uri":"obs_04_0054.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"49"
+ },
+ {
+ "desc":"OBS uses the PUT method to configure a custom domain name for a bucket. After the configuration is successful, you can access the bucket through the domain name.Ensure th",
+ "product_code":"obs",
+ "title":"Configuring a Custom Domain Name for a Bucket",
+ "uri":"obs_04_0059.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"50"
+ },
+ {
+ "desc":"OBS uses the GET method to obtain the custom domain name of a bucket.This request message does not contain the request parameters.This request uses common headers. For de",
+ "product_code":"obs",
+ "title":"Obtaining the Custom Domain Name of a Bucket",
+ "uri":"obs_04_0060.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"51"
+ },
+ {
+ "desc":"OBS uses the DELETE method to delete the custom domain name of a bucket.This request uses common headers. For details, see Table 3.This request involves no elements.The r",
+ "product_code":"obs",
+ "title":"Deleting the Custom Domain Name of a Bucket",
+ "uri":"obs_04_0061.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"52"
+ },
+ {
+ "desc":"OBS uses the PUT method to create or update the default server-side encryption for a bucket.After encryption is enabled for a bucket, objects uploaded to the bucket are e",
+ "product_code":"obs",
+ "title":"Configuring Bucket Encryption",
+ "uri":"obs_04_0062.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"53"
+ },
+ {
+ "desc":"OBS uses the GET method to obtain the encryption configuration of a specified bucket.To perform this operation, you must have the GetEncryptionConfiguration permission. B",
+ "product_code":"obs",
+ "title":"Obtaining Bucket Encryption Configuration",
+ "uri":"obs_04_0063.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"54"
+ },
+ {
+ "desc":"OBS uses the DELETE method to delete the encryption configuration of a specified bucket.To perform this operation, you must have the PutEncryptionConfiguration permission",
+ "product_code":"obs",
+ "title":"Deleting the Encryption Configuration of a Bucket",
+ "uri":"obs_04_0064.html",
+ "doc_type":"api",
+ "p_code":"27",
+ "code":"55"
+ },
+ {
+ "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",
+ "title":"Static Website Hosting",
+ "uri":"obs_04_0070.html",
+ "doc_type":"api",
+ "p_code":"19",
+ "code":"56"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Configuring Static Website Hosting for a Bucket",
+ "uri":"obs_04_0071.html",
+ "doc_type":"api",
+ "p_code":"56",
+ "code":"57"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Obtaining the Static Website Hosting Configuration of a Bucket",
+ "uri":"obs_04_0072.html",
+ "doc_type":"api",
+ "p_code":"56",
+ "code":"58"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Deleting the Static Website Hosting Configuration of a Bucket",
+ "uri":"obs_04_0073.html",
+ "doc_type":"api",
+ "p_code":"56",
+ "code":"59"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Configuring Bucket CORS",
+ "uri":"obs_04_0074.html",
+ "doc_type":"api",
+ "p_code":"56",
+ "code":"60"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Obtaining the CORS Configuration of a Bucket",
+ "uri":"obs_04_0075.html",
+ "doc_type":"api",
+ "p_code":"56",
+ "code":"61"
+ },
+ {
+ "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 ",
+ "product_code":"obs",
+ "title":"Deleting the CORS Configuration of a Bucket",
+ "uri":"obs_04_0076.html",
+ "doc_type":"api",
+ "p_code":"56",
+ "code":"62"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"OPTIONS Bucket",
+ "uri":"obs_04_0077.html",
+ "doc_type":"api",
+ "p_code":"56",
+ "code":"63"
+ },
+ {
+ "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 ",
+ "product_code":"obs",
+ "title":"OPTIONS Object",
+ "uri":"obs_04_0078.html",
+ "doc_type":"api",
+ "p_code":"56",
+ "code":"64"
+ },
+ {
+ "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",
+ "title":"Operations on Objects",
+ "uri":"obs_04_0079.html",
+ "doc_type":"api",
+ "p_code":"19",
+ "code":"65"
+ },
+ {
+ "desc":"After bucket creation in OBS, you can use this operation to upload an object to the bucket. Uploading an object adds it to a bucket. This requires users to have the write",
+ "product_code":"obs",
+ "title":"Uploading Objects - PUT",
+ "uri":"obs_04_0080.html",
+ "doc_type":"api",
+ "p_code":"65",
+ "code":"66"
+ },
+ {
+ "desc":"Uploading an object adds it to a bucket. This requires users to have the write operation.The name of each object in a bucket must be unique.With versioning not enabled, i",
+ "product_code":"obs",
+ "title":"Uploading Objects - POST",
+ "uri":"obs_04_0081.html",
+ "doc_type":"api",
+ "p_code":"65",
+ "code":"67"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Copying Objects",
+ "uri":"obs_04_0082.html",
+ "doc_type":"api",
+ "p_code":"65",
+ "code":"68"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Downloading Objects",
+ "uri":"obs_04_0083.html",
+ "doc_type":"api",
+ "p_code":"65",
+ "code":"69"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Querying Object Metadata",
+ "uri":"obs_04_0084.html",
+ "doc_type":"api",
+ "p_code":"65",
+ "code":"70"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Deleting an Object",
+ "uri":"obs_04_0085.html",
+ "doc_type":"api",
+ "p_code":"65",
+ "code":"71"
+ },
+ {
+ "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 ",
+ "product_code":"obs",
+ "title":"Deleting Objects",
+ "uri":"obs_04_0086.html",
+ "doc_type":"api",
+ "p_code":"65",
+ "code":"72"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Restoring Cold Objects",
+ "uri":"obs_04_0087.html",
+ "doc_type":"api",
+ "p_code":"65",
+ "code":"73"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Configuring an Object ACL",
+ "uri":"obs_04_0089.html",
+ "doc_type":"api",
+ "p_code":"65",
+ "code":"74"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Obtaining Object ACL Configuration",
+ "uri":"obs_04_0090.html",
+ "doc_type":"api",
+ "p_code":"65",
+ "code":"75"
+ },
+ {
+ "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",
+ "title":"Operations on Multipart Upload",
+ "uri":"obs_04_0096.html",
+ "doc_type":"api",
+ "p_code":"19",
+ "code":"76"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Listing Initialized Multipart Tasks in a Bucket",
+ "uri":"obs_04_0097.html",
+ "doc_type":"api",
+ "p_code":"76",
+ "code":"77"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Initializing a Multipart Task",
+ "uri":"obs_04_0098.html",
+ "doc_type":"api",
+ "p_code":"76",
+ "code":"78"
+ },
+ {
+ "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",
+ "uri":"obs_04_0099.html",
+ "doc_type":"api",
+ "p_code":"76",
+ "code":"79"
+ },
+ {
+ "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",
+ "uri":"obs_04_0100.html",
+ "doc_type":"api",
+ "p_code":"76",
+ "code":"80"
+ },
+ {
+ "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.",
+ "product_code":"obs",
+ "title":"Listing Uploaded Parts of an Object",
+ "uri":"obs_04_0101.html",
+ "doc_type":"api",
+ "p_code":"76",
+ "code":"81"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Merging Parts into a Complete Object",
+ "uri":"obs_04_0102.html",
+ "doc_type":"api",
+ "p_code":"76",
+ "code":"82"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Canceling a Multipart Upload Task",
+ "uri":"obs_04_0103.html",
+ "doc_type":"api",
+ "p_code":"76",
+ "code":"83"
+ },
+ {
+ "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",
+ "title":"Server-Side Encryption",
+ "uri":"obs_04_0104.html",
+ "doc_type":"api",
+ "p_code":"19",
+ "code":"84"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Server-Side Encryption Overview",
+ "uri":"obs_04_0105.html",
+ "doc_type":"api",
+ "p_code":"84",
+ "code":"85"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Server-Side Encryption (SSE-KMS)",
+ "uri":"obs_04_0106.html",
+ "doc_type":"api",
+ "p_code":"84",
+ "code":"86"
+ },
+ {
+ "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 ",
+ "product_code":"obs",
+ "title":"Server-Side Encryption (SSE-C)",
+ "uri":"obs_04_0107.html",
+ "doc_type":"api",
+ "p_code":"84",
+ "code":"87"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"API Operations Related to Server-Side Encryption",
+ "uri":"obs_04_0108.html",
+ "doc_type":"api",
+ "p_code":"84",
+ "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.",
+ "product_code":"obs",
+ "title":"Appendixes",
+ "uri":"obs_04_0113.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"89"
+ },
+ {
+ "desc":"Table 1 lists the status codes and prompt message returned by the server to the user.",
+ "product_code":"obs",
+ "title":"Status Codes",
+ "uri":"obs_04_0114.html",
+ "doc_type":"api",
+ "p_code":"89",
+ "code":"90"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Error Codes",
+ "uri":"obs_04_0115.html",
+ "doc_type":"api",
+ "p_code":"89",
+ "code":"91"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Obtaining Access Keys (AK/SK)",
+ "uri":"obs_04_0116.html",
+ "doc_type":"api",
+ "p_code":"89",
+ "code":"92"
+ },
+ {
+ "desc":"When an API is called, 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 proce",
+ "product_code":"obs",
+ "title":"Obtaining the Domain ID and User ID",
+ "uri":"obs_04_0117.html",
+ "doc_type":"api",
+ "p_code":"89",
+ "code":"93"
+ },
+ {
+ "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",
+ "product_code":"obs",
+ "title":"Consistency of Concurrent Operations",
+ "uri":"obs_04_0118.html",
+ "doc_type":"api",
+ "p_code":"89",
+ "code":"94"
+ },
+ {
+ "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",
+ "title":"Change History",
+ "uri":"obs_04_0000.html",
+ "doc_type":"api",
+ "p_code":"",
+ "code":"95"
+ }
+]
\ No newline at end of file
diff --git a/docs/obs/api-ref/PARAMETERS.txt b/docs/obs/api-ref/PARAMETERS.txt
new file mode 100644
index 00000000..6da8d5f0
--- /dev/null
+++ b/docs/obs/api-ref/PARAMETERS.txt
@@ -0,0 +1,3 @@
+version=""
+language="en-us"
+type=""
\ No newline at end of file
diff --git a/docs/obs/api-ref/en-us_image_0100846816.png b/docs/obs/api-ref/en-us_image_0100846816.png
new file mode 100644
index 00000000..0974456b
Binary files /dev/null and b/docs/obs/api-ref/en-us_image_0100846816.png differ
diff --git a/docs/obs/api-ref/en-us_image_0100846818.png b/docs/obs/api-ref/en-us_image_0100846818.png
new file mode 100644
index 00000000..bcea6106
Binary files /dev/null and b/docs/obs/api-ref/en-us_image_0100846818.png differ
diff --git a/docs/obs/api-ref/en-us_image_0100846820.png b/docs/obs/api-ref/en-us_image_0100846820.png
new file mode 100644
index 00000000..84346bf0
Binary files /dev/null and b/docs/obs/api-ref/en-us_image_0100846820.png differ
diff --git a/docs/obs/api-ref/en-us_image_0100846822.png b/docs/obs/api-ref/en-us_image_0100846822.png
new file mode 100644
index 00000000..2746581c
Binary files /dev/null and b/docs/obs/api-ref/en-us_image_0100846822.png differ
diff --git a/docs/obs/api-ref/en-us_image_0100846824.png b/docs/obs/api-ref/en-us_image_0100846824.png
new file mode 100644
index 00000000..c58f0a5f
Binary files /dev/null and b/docs/obs/api-ref/en-us_image_0100846824.png differ
diff --git a/docs/obs/api-ref/en-us_image_0100846826.png b/docs/obs/api-ref/en-us_image_0100846826.png
new file mode 100644
index 00000000..42b4f526
Binary files /dev/null and b/docs/obs/api-ref/en-us_image_0100846826.png differ
diff --git a/docs/obs/api-ref/en-us_topic_0031051947.html b/docs/obs/api-ref/en-us_topic_0031051947.html
new file mode 100644
index 00000000..0af83174
--- /dev/null
+++ b/docs/obs/api-ref/en-us_topic_0031051947.html
@@ -0,0 +1,13 @@
+
+
+
Overview
+
Welcome to the Object Storage Service API Reference. Object Storage Service (OBS) provides massive, secure, reliable, and cost-effective data storage capabilities for users to store data of any type and size. It is suitable for scenarios such as enterprise backup/archiving, video on demand (VoD), and video surveillance.
+
This document describes how to use application programming interfaces (APIs) to perform operations on OBS, such as creating, modifying, and deleting bucket, as well as uploading, downloading, and deleting objects. For details about all supported operations, see API Overview.
+
Before calling OBS APIs, ensure that you have fully understood relevant concepts. For details, see Basic Concepts.
An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of services, see Regions and Endpoints.
+
OBS provides a second-level domain name for each region. You can use the domain name provided by OBS or a custom domain name to access OBS.
You can register a domain with the cloud service. The domain has full access permissions for all the resources and cloud services that are subscribed under it. The domain can also reset user passwords and grant permissions to users. A domain is a payment entity. To keep the domain secure, it is recommended that you create users under the domain to perform routine management operations.
+
User
You can create users under a domain on Identity and Access Management (IAM), and authorize the users with permissions required for accessing cloud services. Each IAM user has its own identity credentials (password and access keys).
+
+
On the My Credentials page on the console, you can view the domain ID and user ID, you can also manage the access keys of the domain and IAM users.
+
Access keys of the domain and its IAM users are required for authentication when calling APIs.
+
Bucket
A bucket is a container where objects are stored. It is the top namespace in OBS. Each object must reside in a bucket. For example, if the object named picture.jpg is stored in the photo bucket, you can use the following URL to access the object: http://photo.obs.region.example.com/picture.jpg.
+
Objects
An object is a basic data unit on OBS. A bucket can store multiple objects, and OBS does not distinguish between object types. Objects are serialized in OBS. An object may be a text, a video, or any other types of files. In OBS, the size of a file can range from 0 bytes to 48.8 TB. However, when an object is uploaded through the PutObject operation, it cannot exceed the maximum size of 5 GB. Use the multipart upload method, if the object size is larger than 5 GB.
+
Region
A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.
+
Each bucket in OBS must reside in a region. You can specify the region when creating the bucket. Once a bucket is created, its region cannot be changed. Select the most appropriate region for a bucket based on the location, cost, and regulatory compliance requirements. For details about regions, see Endpoints.
Lists objects in a bucket. You can add different request headers to obtain objects that match the specified prefix, identifier, and other requirements.
Checks whether the bucket metadata exists. You can query the information about the bucket region, storage class, OBS version number, enterprise project ID, and CORS configuration.
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.
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.
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.
Adds a tag to an existing bucket. After tags are added to a bucket, all charging data records (CDRs) generated by the requests for this bucket will have the same tags. Thus, CDR reports can be categorized for detailed cost analysis.
Configures a custom domain name for a bucket. Once a user-defined domain name is successfully configured, the bucket can be accessed through the user-defined domain name.
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.
Creates or updates the website hosting configuration of a bucket. 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.
Configures the cross-origin resource sharing (CORS) configuration of a bucket. OBS allows static web page resources to be stored in buckets. The buckets can be used as website resources. A website hosted by OBS can respond to cross-domain requests from another website only after the CORS rule is configured.
Initiates a multipart upload task, and obtains the globally unique multipart upload task ID for subsequent operations, such as uploading, merging, and listing parts.
Protocol used for sending requests, which can be either HTTP or HTTPS. HTTPS is a protocol that ensures secure access to resources. OBS supports both HTTP and HTTPS.
+
+
Yes
+
+
+
bucket
+
+
Resource path of a bucket, identifying only one bucket in OBS
+
+
No
+
+
+
domain
+
+
Domain name or IP address of the server for saving resources
+
+
Yes
+
+
+
port
+
+
Port enabled for protocols used for sending requests. The value varies with software server deployment. If no port number is specified, the protocol uses the default value. Each transmission protocol has its default port number. For example, HTTP uses port number 80 and HTTPS uses port number 443 by default.
+
In OBS, HTTP port number is 80 and that of HTTPS is 443.
+
+
No
+
+
+
object
+
+
An object path used in the request
+
+
No
+
+
+
param
+
+
A specific resource contained by a bucket or object. Default value of this parameter indicates that the bucket or object itself is obtained.
+
+
No
+
+
+
+
+
+
All API requests except those for the bucket list must contain the bucket name. Based on the DNS resolution performance and reliability, OBS requires that the bucket name must be placed in front of the domain when a request carrying a bucket name is constructed to form a third-level domain name, also mentioned as virtual hosting access domain name.
+
For example, you have a bucket named test-bucket in the a1 region, and you want to access the ACL of an object named test-object in the bucket. The correct URL is https://test-bucket.obs.a1.example.com/test-object?acl.
+
+
+
Request Method
HTTP methods, which are also called operations or actions, specify the type of operations that you are requesting.
+
+
Table 2 HTTP request methods supported by the OBS
Method
+
+
Description
+
+
+
+
GET
+
+
Requests the server to return a specific resource, for example, a bucket list or object.
+
+
+
PUT
+
+
Requests the server to update a specific resource, for example, creating a bucket or uploading an object.
+
+
+
POST
+
+
Requests the server to add a resource or perform a special operation, for example, part uploading or merging.
+
+
+
DELETE
+
+
Requests the server to delete specified resources, for example, an object.
+
+
+
HEAD
+
+
Requests the server to return the digest of a specific resource, for example, object metadata.
+
+
+
OPTIONS
+
+
The request server checks whether the user has the operation permission for a resource. The CORS needs to be configured for the bucket.
+
+
+
+
+
+
+
Request Headers
Refers to optional and additional request fields, for example a field required by a specific URI or HTTP method. For details about the fields of common request headers, see Table 3.
+
+
Table 3 Common request headers
Header
+
+
Description
+
+
Mandatory
+
+
+
+
Authorization
+
+
Signature information contained in a request message
+
Type: string
+
No default value.
+
Conditional: optional for anonymous requests and required for other requests.
+
+
Conditionally required
+
+
+
Content-Length
+
+
The message length (excluding headers) defined in RFC 2616
+
Type: string
+
No default value.
+
Conditional: required for PUT requests and those requests that load XML content.
+
+
Conditionally required
+
+
+
Content-Type
+
+
The content type of the requested resource, for example, text/plain
+
Type: string
+
No default value.
+
+
No
+
+
+
Date
+
+
Time when a request is initiated, for example, Wed, 27 Jun 2018 13:39:15 +0000.
+
Type: string
+
No default value.
+
Conditional: optional for anonymous requests or those requests containing header x-obs-date, required for other requests.
+
+
Conditionally required
+
+
+
Host
+
+
The host address. For example, bucketname.obs.region.example.com.
+
Type: string
+
No default value.
+
+
Yes
+
+
+
+
+
+
+
(Optional) Request Body
A request body is generally sent in a structured format (for example, JSON or XML). It corresponds to Content-Type in the request header and is used to transfer content other than the request header. If the request body contains Chinese characters, these characters must be coded in UTF-8.
+
The request body varies according to the APIs. Certain APIs do not require the request body, such as the GET and DELETE APIs.
+
+
Sending a Request
There are two methods to initiate requests based on the constructed request messages:
+
cURL
cURL is a command-line tool used to perform URL operations and transmit information. cURL acts as an HTTP client that can send HTTP requests to the server and receive response messages. cURL is applicable to API debugging. For more information about cURL, visit https://curl.haxx.se/. cURL cannot calculate signatures. When cURL is used, only anonymous public OBS resources can be accessed.
+
Coding
You can use code to make API calls, and to assemble, send, and process request messages. It can be implemented by using the SDK or coding.
OBS signs a request using AK/SK. When a client is sending a request to OBS, the message header must contain the SK, request time, request type, and other information of the signature.
+
AK: access key ID, which is a unique identifier associated with a secret access key (SK). The AK and SK are used together to obtain an encrypted signature for a request. Format example: HCY8BGCN1YM5ZWYOK1MH
SK: secret access key, which is used together with the AK to sign requests, identify a request sender, and prevent the request from being modified. Format example: 9zYwf1uabSQY0JTnFqbUqG7vcfqYBaTdXde2GUcq
The SDK provided by OBS integrates signature calculation. It is recommended that you use the SDK for development.
+
Table 1 shows the user signature verification process in which a signature is carried in a header. For details about the parameters and code examples of authentication of signature in a header, see Authentication of Signature in a Header.
+
+
Table 1 Signature calculation and verification procedure
Procedure
+
+
Example
+
+
+
+
Signature calculation
+
+
1. Construct an HTTP message.
+
+
PUT /object HTTP/1.1
+
Host: bucket.obs.region.example.com
+
Date: Tue, 04 Jun 2019 06:54:59 GMT
+
Content-Type: text/plain
+
Content-Length: 5913
+
+
+
2. Calculate StringToSign based on the signature rule.
Table 1 Parameters required for constructing a StringToSign
Parameter
+
+
Description
+
+
+
+
HTTP-Verb
+
+
Indicates an HTTP request method supported by the OBS REST API. The value can be an HTTP verb such as PUT, GET, or DELETE.
+
+
+
Content-MD5
+
+
Base64-encoded 128-bit MD5 digest of the message according to RFC 1864. This parameter can be empty. For details, see Table 6 and the algorithm examples below the table.
+
+
+
Content-Type
+
+
Specifies the message type, for example, text/plain.
+
If a request does not contain this header field, this parameter is deemed as an empty string. For details, see Table 2.
+
+
+
Date
+
+
Time when a request is initiated. This parameter uses the RFC 1123 time format. If the deviation between the time specified by this parameter and the server time is over 15 minutes, the server returns error 403.
+
This parameter is an empty string when the x-obs-date is specified. For details, see Table 6.
+
If an operation (for example, obtaining an object content) is temporarily authorized, this parameter is not required.
+
+
+
+
CanonicalizedHeaders
+
+
OBS request header field in an HTTP request header, referring to header fields started with x-obs-, for example, x-obs-date, x-obs-acl, and x-obs-meta-*.
+
All characters of keywords in a request header field must be converted to lowercase letters (content values must be case sensitive, for example, x-obs-storage-class:STANDARD). If a request contains multiple header fields, these fields should be organized by keyword in the alphabetical order from a to z.
If multiple header fields in a request have the same prefix, combine the header fields into one. For example, x-obs-meta-name:name1 and x-obs-meta-name:name2 should be reorganized into x-obs-meta-name:name1,name2. Use comma to separate the values.
Keywords in the request header field cannot contain non-ASCII or unrecognizable characters, which are also not advisable for values in the request header field. If the two types of characters are necessary, they should be encoded and decoded on the client side. Either URL encoding or Base64 encoding is acceptable, but the server does not perform decoding.
Delete meaningless spaces and tabs in a header field. For example, x-obs-meta-name: name (with a meaningless space in the front of name) must be changed to x-obs-meta-name:name.
Each header field occupies a separate line. See Table 4.
+
+
+
CanonicalizedResource
+
+
Indicates the OBS resource specified by an HTTP request. This parameter is constructed as follows:
Bucket name and object name, for example, /bucket/object. If no object name is specified, for example, /bucket/, the entire bucket is listed. If no bucket name is specified either, the value of this field is /.
If a subresource (such as ?acl and ?logging) exists, the subresource must be added.
If there are multiple subresources, sort them in the alphabetical order from a to z, and use & to combine the subresources.
+
NOTE:
A subresource is unique. Do not add subresources with the same keyword (for example, key=value1&key=value2) in the same request URL. In this case, signature is computed only based on the first subresource, and only the value of the first subresource takes effect on the actual service.
Using the GetObject API as an example, assume there is a bucket named bucket-test and an object named object-test in the bucket, and the object version is xxx. When obtaining the object, you need to rewrite Content-Type to text/plain. Then, the CanonicalizedResource calculated by the signature is /bucket-test/object-test?response-content-type=text/plain&versionId=xxx.
+
+
+
+
+
+
+
+
The following tables provide some examples of generating StringToSign.
+
+
Table 2 Obtaining an object
Request Header
+
+
StringToSign
+
+
+
+
GET /object.txt HTTP/1.1
+
Host: bucket.obs.region.example.com
+
Date: Sat, 12 Oct 2015 08:12:38 GMT
+
+
GET \n
+
\n
+
\n
+
Sat, 12 Oct 2015 08:12:38 GMT\n
+
/bucket/object.txt
+
+
+
+
+
+
+
Table 3 Using temporary AK/SK and security token to upload objects
The signature is generated as follows based on the StringToSign and SK. The hash-based message authentication code algorithm (HMAC algorithm) is used to generate the signature.
OBS allows users to construct a URL for a specific operation. The URL contains information such as the user's AK, signature, validity period, and resources. Any user who obtains the URL can perform the operation. After receiving the request, the OBS deems that the operation is performed by the user who issues the URL. For example, if the URL of an object download request carries signature information is constructed, the user who obtains the URL can download the object, but the URL is valid only within the expiration time specified by the parameter of Expires. The URL that carries the signature is used to allow others to use the pre-issued URL for identity authentication when the SK is not provided, and perform the predefined operation.
+
The format of the message containing the signature request in the URL is as follows:
+
GET /ObjectKey?AccessKeyId=AccessKeyID&Expires=ExpiresValue&Signature=signature HTTP/1.1
+Host: bucketname.obs.region.example.com
+
The format of the message containing the temporary AK/SK and security token in the URL for downloading objects is as follows:
+
GET /ObjectKey?AccessKeyId=AccessKeyID&Expires=ExpiresValue&Signature=signature&x-obs-security-token=securitytoken HTTP/1.1
+Host: bucketname.obs.region.example.com
AK information of the issuer. OBS determines the identity of the issuer based on the AK and considers that the URL is accessed by the issuer.
+
Type: string
+
+
Yes
+
+
+
Expires
+
+
Indicates when the temporarily authorized URL expires, in seconds. The time must be in Coordinated Universal Time (UTC) format and later than 00:00:00 on January 1, 1970.
+
Type: string
+
+
Yes
+
+
+
Signature
+
+
The signature generated using the SK and the expiration time.
+
Type: string
+
+
Yes
+
+
+
x-obs-security-token
+
+
During temporary authentication, the temporary AK/SK and security token must be used at the same time and the x-obs-security-token field must be added to the request header.
Table 2 Parameters required for constructing a StringToSign
Parameter
+
+
Description
+
+
+
+
HTTP-Verb
+
+
Indicates an HTTP request method supported by the OBS REST API. The value can be an HTTP verb such as PUT, GET, or DELETE.
+
+
+
Content-MD5
+
+
Base64-encoded 128-bit MD5 digest of the message according to RFC 1864. This parameter can be empty.
+
+
+
Content-Type
+
+
Specifies the message type, for example, text/plain.
+
If a request does not contain this header field, this parameter is deemed as an empty string.
+
+
+
Expires
+
+
Expiration time of the temporary authorization, that is, the value of parameter Expires in the request message: ExpiresValue.
+
+
+
CanonicalizedHeaders
+
+
OBS request header field in an HTTP request header, referring to header fields started with x-obs-, for example, x-obs-date, x-obs-acl, and x-obs-meta-*.
+
All characters of keywords in the header field must be converted to lower-case letters. If a request contains multiple header fields, these fields should be organized by keywords in the alphabetical order from a to z.
If multiple header fields in a request have the same prefix, combine the header fields into one. For example, x-obs-meta-name:name1 and x-obs-meta-name:name2 should be reorganized into x-obs-meta-name:name1,name2. Use comma to separate the values.
Keywords in the request header field cannot contain non-ASCII or unrecognizable characters, which are also not advisable for values in the request header field. If the two types of characters are necessary, they should be encoded and decoded on the client side. Either URL encoding or Base64 encoding is acceptable, but the server does not perform decoding.
Delete meaningless spaces and tabs in a header field. For example, x-obs-meta-name: name (with a meaningless space in the front of name) must be changed to x-obs-meta-name:name.
Each header field occupies a separate line.
+
+
+
CanonicalizedResource
+
+
Indicates the OBS resource specified by an HTTP request. This parameter is constructed as follows:
Bucket name and object name, for example, /bucket/object. If no object name is specified, for example, /bucket/, the entire bucket is listed. If no bucket name is specified either, the value of this field is /.
If a subresource (such as ?acl and ?logging) exists, the subresource must be added.
If there are multiple subresources, sort them in the alphabetical order from a to z, and use & to combine the subresources.
+
NOTE:
A subresource is unique. Do not add subresources with the same keyword (for example, key=value1&key=value2) in the same request URL. In this case, signature is computed only based on the first subresource, and only the value of the first subresource takes effect on the actual service.
Using the GetObject API as an example, assume there is a bucket named bucket-test and an object named object-test in the bucket, and the object version is xxx. When obtaining the object, you need to rewrite Content-Type to text/plain. Then, the CanonicalizedResource calculated by the signature is /bucket-test/object-test?response-content-type=text/plain&versionId=xxx.
+
+
+
+
+
+
+
The signature is generated as follows based on the StringToSign and SK. The hash-based message authentication code algorithm (HMAC algorithm) is used to generate the signature.
The method for calculating the signature carried in the URL is different from that for calculating the authorization signature carried in a header.
+
The signature in the URL must be encoded using the URL after Base64 encoding.
Expires in StringToSign corresponds to Date in authorization information.
+
+
Generate a predefined URL instance for the browser by carrying the signature in the URL.
+
+
Table 3 Request that has the signature carried in the URL and the StringToSign
Request Headers
+
+
StringToSign
+
+
+
+
GET /objectkey?AccessKeyId=MFyfvK41ba2giqM7Uio6PznpdUKGpownRZlmVmHc&Expires=1532779451&Signature=0Akylf43Bm3mD1bh2rM3dmVp1Bo%3D HTTP/1.1
+
Host: examplebucket.obs.region.example.com
+
+
GET \n
+
\n
+
\n
+
1532779451\n
+
/examplebucket/objectkey
+
+
+
+
+
+
+
Table 4 Object download request that has the temporary AK/SK and security token carried in the URL and the StringToSign
Request Header
+
+
StringToSign
+
+
+
+
GET /objectkey?AccessKeyId=MFyfvK41ba2giqM7Uio6PznpdUKGpownRZlmVmHc&Expires=1532779451&Signature=0Akylf43Bm3mD1bh2rM3dmVp1Bo%3D&x-obs-security-token=YwkaRTbdY8g7q.... HTTP/1.1
If you enter the address in the browser, then the object objectkey in the examplebucket bucket can be downloaded. The validity period of this link is 1532779451 (indicating Sat Jul 28 20:04:11 CST 2018).
+
In the Linux operating system, when running the curl command, you need to add a forward slash (\) to escape the character (&). The following command can download the objectkey object to the output file:
+
curl http(s)://examplebucket.obs.region.example.com/objectkey?AccessKeyId=AccessKeyID\&Expires=1532779451\&Signature=0Akylf43Bm3mD1bh2rM3dmVp1Bo%3D -X GET -o output
+
If you want to use the pre-defined URL generated by the signature carried in the URL in the browser, do not use Content-MD5, Content-Type, or CanonicalizedHeaders that can only be carried in the header to calculate the signature. Otherwise, the browser cannot carry these parameters. After the request is sent to the server, a message is displayed indicating that the signature is incorrect.
Authentication of Signature Carried in the Table Uploaded Through a Browser
+
OBS supports browser-based object upload using the POST method. Signatures of such requests are uploaded in tables. First, create a security policy and specify the requirements in the request, for example, Bucket name and object name prefix. Then, create a signature based on this policy. The request form to be signed must contain valid signature and policy. Finally, create a table to upload the object to the bucket.
+
The signature calculation process is as follows:
+
The policy content is encoded in UTF-8 format.
Perform Base64 encoding on the result obtained from the preceding step.
Use the SK to perform the HMAC-SHA1 signature calculation on the result obtained from step 2.
Perform Base64 encoding on the result of step 3 to obtain the signature.
The policy contains the validity period (see Expiration) and conditions (see Conditions).
+
Expiration
The expiration field describes when the signature will expire, which is expressed in the format according to ISO 8601 UTC. For example, expiration: 2017-12-31T12:00:00.000Z in the example means that the request becomes invalid after 12:00:00 on December 31, 2017. This field must be specified in a policy. It can only be in the yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.
+
+
Conditions
A mechanism used to verify the validity of a request. Conditions are used to define the content that must be contained in a request. In the example, the requested bucket name is book, the object name is prefixed with user/, and the ACL of the object is public read. All items in the form, excluding AccessKeyId, signature, file, policy, token, field names, and the prefix x-ignore-, must be included in the policy. The following table lists the items that should be contained in Conditions.
+
+
Table 1 Conditions contained in a policy
Element
+
+
Description
+
+
+
+
x-obs-acl
+
+
ACL in the request.
+
Supports exact match and conditional match such as starts-with.
+
+
+
content-length-range
+
+
Maximum and minimum length of an object to be uploaded. The value can be a range.
Supports exact match and conditional match such as starts-with.
+
+
+
success_action_status
+
+
If success_action_redirect is not specified, the status code is returned to the client when the upload is successful. For details, see Uploading Objects - POST.
+
Supports exact match.
+
+
+
x-obs-meta-*
+
+
User-defined metadata.
+
Keywords in an element cannot contain non-ASCII or unrecognizable characters. If non-ASCII or unrecognizable characters are necessary, they should be encoded and decoded on the client side. Either URL encoding or Base64 encoding is acceptable, but the server does not perform decoding.
+
Supports exact match and conditional match such as starts-with.
+
+
+
x-obs-*
+
+
Other header fields with prefix x-obs-.
+
Supports exact match and conditional match such as starts-with.
+
+
+
x-obs-security-token
+
+
Field name in the request header.
+
Mandatory field for the temporary AK/SK and security token authentication.
+
+
+
+
+
+
The policy conditions can be matched in the following ways:
+
+
Table 2 Policy condition matching methods
Matching Method
+
+
Description
+
+
+
+
Exact Matches
+
+
Exact match by default. The value in the POST table must be the same as that in the policy. For example, if object ACL is set to public-read when the object is uploaded, the value of the x-obs-acl element in the table is public-read. Therefore, the conditions in the policy can be set to
+
{"x-obs-acl": "public-read"} or ["eq", "$x-obs-acl", "public-read"], which are equivalent.
+
+
+
Starts With
+
+
If this condition is used, the value set in the POST table must start with a fixed character string. For example, if the name of uploaded objects must be prefixed with user/, the value of the key element in the table can be user/test1, user/test2, and so on. Therefore, conditions in the policy can be set to:
+
["starts-with", "$key", "user/"]
+
+
+
Matching Any Content
+
+
The corresponding element in the POST table can be any value. For example, if the redirection address upon request success can be any address, the value of the success_action_redirect element in the table can be any value. Therefore, conditions in the policy can be set to:
+
["starts-with", "$success_action_redirect", ""]
+
+
+
Specifying Ranges
+
+
The content length of the file element in the POST table can be a specified range and is used only to limit the object size. For example, if the size of the uploaded object is between 1 MB to 10 MB, the content length of the file element in the table can be from 1048576 to 10485760. Therefore, conditions in the policy can be set to (the value does not contain quotation marks)
+
["content-length-range", 1048576, 10485760]
+
+
+
+
+
+
A policy is in the JSON format. Conditions can be put in curly brackets {} and square brackets []. The key and value elements of the table are written in the curly brackets {}, which are separated by colons (:). The square brackets [] contain the condition type, key, and value. These three items are separated by commas (,). The dollar sign ($) in front of the key indicates that the key is a variable.
+
+
The following characters must be escaped in a policy:
+
+
Table 3 Characters that must be escaped in a policy
Character After Escape
+
+
Real Character
+
+
+
+
\\
+
+
Backslash (\)
+
+
+
\$
+
+
Dollar symbol ($)
+
+
+
\b
+
+
Backspace
+
+
+
\f
+
+
Page up and down
+
+
+
\n
+
+
Line breaks
+
+
+
\r
+
+
Enter
+
+
+
\t
+
+
Horizontal table
+
+
+
\v
+
+
Vertical table
+
+
+
\uxxxx
+
+
All Unicode characters
+
+
+
+
+
+
+
Request and Policy Examples
The following tables provide examples of requests and policies.
+
Example 1: Upload the testfile.txt object to bucket examplebucket and set the object ACL to public-read.
After sending a request, you will receive a response, including the status code, response header, and response body.
+
Status Codes
A status code is a group of digits ranging from 2xx (indicating successes) to 4xx or 5xx (indicating errors). It indicates the status of a response. For more information, see Status Codes.
+
+
Response Headers
A response header corresponds to a request header, for example, Content-Type.
+
For details about common response headers, see Table 1.
+
Table 1 Common response headers
Header
+
+
Description
+
+
+
+
Content-Length
+
+
The length (in bytes) of the response body.
+
Type: string
+
Default value: none
+
+
+
Connection
+
+
Indicates whether the connection to the server is a long connection or a short connection.
+
Type: string
+
Valid values: keep-alive | close
+
Default value: none
+
+
+
Date
+
+
The date and time at which OBS responds to the request.
+
Type: string
+
Default value: none
+
+
+
ETag
+
+
128-bit MD5 digest of the Base64 code of an object. ETag is the unique identifier of the object content. It can be used to identify whether the object content is changed. For example, if ETag value is A when an object is uploaded and the ETag value has changed to B when the object is downloaded, it indicates that the object content is changed. The actual ETag is the hash value of the object, which only reflects the changed content rather than the metadata. An uploaded object or copied object has a unique ETag after being encrypted using MD5. If an object is uploaded in the multipart mode, the MD5 splits ETag regardless of the encryption method. In this case, the ETag is not an MD5 digest.
+
Type: string
+
+
+
x-obs-id-2
+
+
A special symbol that helps troubleshoot faults.
+
Type: string
+
Default value: none
+
+
+
x-obs-request-id
+
+
The value created by OBS to uniquely identify the request. OBS uses this value to troubleshoot faults.
+
Type: string
+
Default value: none
+
+
+
+
+
+
+
+
(Optional) Response Body
A response body is generally returned in a structured format (for example, JSON or XML), corresponding to Content-Type in the response header, and is used to transfer content other than the response header.
You have planned the region where you want to create a bucket and obtained the endpoint required for API calls. For details, see Regions and Endpoints.
+
Once a region is determined, it cannot be modified after the bucket is created.
+
+
Creating a Bucket Named bucket001 in the a1 Region
packagecom.obsclient;
+
+importjava.io.*;
+
+importorg.apache.http.Header;
+importorg.apache.http.client.methods.CloseableHttpResponse;
+importorg.apache.http.client.methods.HttpPut;
+importorg.apache.http.entity.StringEntity;
+importorg.apache.http.impl.client.CloseableHttpClient;
+importorg.apache.http.impl.client.HttpClients;
+
+publicclassTestMain{
+
+ publicstaticStringaccessKey="UDSIAMSTUBTEST000012";//The value of this parameter is the AK obtained.
+ publicstaticStringsecurityKey="Udsiamstubtest000000UDSIAMSTUBTEST000012";//The value of this parameter is the SK obtained.
+ publicstaticStringregion="a1";// The value is the region where the planned bucket resides.
+ publicstaticStringcreateBucketTemplate=
+ "<CreateBucketConfiguration "+
+ "xmlns=\"http://obs.a1.example.com/doc/2015-06-30/\">\n"+
+ "<Location>"+region+"</Location>\n"+
+ "</CreateBucketConfiguration>";
+
+ publicstaticvoidmain(String[]str){
+
+ createBucket();
+
+ }
+
+ privatestaticvoidcreateBucket(){
+ CloseableHttpClienthttpClient=HttpClients.createDefault();
+ Stringrequesttime=DateUtils.formatDate(System.currentTimeMillis());
+ StringcontentType="application/xml";
+
+
+ HttpPuthttpPut=newHttpPut("http://bucket001.obs.a1.example.com");
+ httpPut.addHeader("Date",requesttime);
+ httpPut.addHeader("Content-Type",contentType);
+
+ /**Calculate the signature based on the request.**/
+ StringcontentMD5="";
+ StringcanonicalizedHeaders="";
+ StringcanonicalizedResource="/bucket001/";
+ // Content-MD5 and Content-Type fields do not contain line breaks. The data format is RFC 1123, which is the same as the time in the request.
+ StringcanonicalString="PUT"+"\n"+contentMD5+"\n"+contentType+"\n"+requesttime+"\n"+canonicalizedHeaders+canonicalizedResource;
+ System.out.println("StringToSign:["+canonicalString+"]");
+ Stringsignature=null;
+ CloseableHttpResponsehttpResponse=null;
+ try{
+ signature=Signature.signWithHmacSha1(securityKey,canonicalString);
+
+ // Added the Authorization: OBS AccessKeyID:signature field to the header.
+ httpPut.addHeader("Authorization","OBS "+accessKey+":"+signature);
+
+ // Add a body.
+ httpPut.setEntity(newStringEntity(createBucketTemplate));
+
+ httpResponse=httpClient.execute(httpPut);
+
+ // Prints the sending request information and the received response message.
+ System.out.println("Request Message:");
+ System.out.println(httpPut.getRequestLine());
+ for(Headerheader:httpPut.getAllHeaders()){
+ System.out.println(header.getName()+":"+header.getValue());
+ }
+
+ System.out.println("Response Message:");
+ System.out.println(httpResponse.getStatusLine());
+ for(Headerheader:httpResponse.getAllHeaders()){
+ System.out.println(header.getName()+":"+header.getValue());
+ }
+ BufferedReaderreader=newBufferedReader(newInputStreamReader(
+ httpResponse.getEntity().getContent()));
+
+ StringinputLine;
+ StringBufferresponse=newStringBuffer();
+
+ while((inputLine=reader.readLine())!=null){
+ response.append(inputLine);
+ }
+ reader.close();
+
+ // print result
+ System.out.println(response.toString());
+ }catch(UnsupportedEncodingExceptione){
+ e.printStackTrace();
+ }catch(IOExceptione){
+ e.printStackTrace();
+ }finally{
+ try{
+ httpClient.close();
+ }catch(IOExceptione){
+ e.printStackTrace();
+ }
+ }
+
+ }
+
+}
+
+
+
+
+
The format of the Date header field DateUtils is as follows:
The file to be uploaded has been prepared and you know the complete local path of the file.
You have obtained the region of the bucket which you want to upload files to and determined the endpoint required for API calls. For details, see Regions and Endpoints.
+
+
Uploading the Object objecttest1 to Bucket bucket001 in the a1 Region
This operation is used to create a bucket with a specified name.
+
By default, a user can have a maximum of 100 buckets.
The name of a deleted bucket can be reused for a bucket at least 30 minutes after the deletion.
+
+
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.
+
+
Storage Class
You can create buckets with different storage classes. The x-obs-storage-class header in a bucket creation request specifies the default storage class for a bucket. The storage class of the objects in a bucket is the same as that 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.
+
OBS Standard features low access latency and high throughput. It is most suitable for storing frequently accessed (multiple times per month) hot files. Potential application scenarios include big data, mobile applications, trending videos, and social media images.
OBS Warm storage class is suitable for storing data that is infrequently accessed (less than 12 times a year) yet has quick response requirements. Potential application scenarios include file synchronization or sharing and enterprise backup. It provides the same durability, access latency, and throughput as the Standard storage class but at a lower price. However, the Warm storage class has lower availability than the Standard one.
OBS Cold storage class is applicable to archiving rarely-accessed (averagely once a year) data. The application scenarios include data archiving and long-term data retention for backup. The Cold storage class is secure, durable, and inexpensive, which can replace tape libraries. However, it may take hours to restore data from the Cold storage class.
+
+
Request Syntax
1
+2
+3
+4
+5
+6
+7
+8
PUT / HTTP/1.1
+Host: bucketname.obs.region.example.com
+Content-Length: length
+Date: date
+Authorization: authorization
+<CreateBucketConfigurationxmlns="http://obs.region.example.com/doc/2015-06-30/">
+ <Location>location</Location>
+</CreateBucketConfiguration>
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
The operation message header is the same as that of a common request. For details, see Table 3. However, this request can contain additional headers. The following table describes the additional headers for this request.
+
+
Table 1 Additional request headers
Header
+
+
Description
+
+
Mandatory
+
+
+
+
x-obs-acl
+
+
When creating a bucket, you can add this header to set the permission control policy for the bucket. The predefined common policies are as follows: private, public-read, public-read-write, public-read-delivered, and public-read-write-delivered.
+
Type: string
+
+
No
+
+
+
x-obs-storage-class
+
+
When creating a bucket, you can add this header to set the default storage class of the bucket. The default storage classes are as follows: 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 bucket created is Standard.
+
Type: string
+
+
No
+
+
+
x-obs-grant-read
+
+
This header grants the read permission to all users under an account. It allows you to list objects in a bucket, list multipart tasks in a bucket, list multi-version objects in a bucket, and obtain bucket metadata.
+
Type: string
+
Example: x-obs-grant-read:id=Tenant ID.
+
+
No
+
+
+
x-obs-grant-write
+
+
This header grants the write permission to all users under an account. Therefore, the users can create, delete, and overwrite all objects in a bucket, and can initialize parts, upload parts, copy parts, merge parts, and cancel multipart upload tasks.
+
Type: string
+
Example: x-obs-grant-write:id=Tenant ID.
+
+
No
+
+
+
x-obs-grant-read-acp
+
+
This header grants the ACL read permission to all users under an account. Therefore, the users can read the bucket ACL information.
+
Type: string
+
Example: x-obs-grant-read-acp:id=Account ID.
+
+
No
+
+
+
x-obs-grant-write-acp
+
+
This header grants the ACL write permission to all users under an account. Therefore, the users can modify the ACL of the bucket.
+
Type: string
+
Example: x-obs-grant-write-acp:id=Account ID.
+
+
No
+
+
+
x-obs-grant-full-control
+
+
This header grants the full control permission to all users under an account.
+
Type: string
+
Example: x-obs-grant-full-control:id=Account ID.
+
+
No
+
+
+
x-obs-grant-read-delivered
+
+
This header grants the read permission to all users under an account. By default, the read permission is applied to all objects in the bucket.
This header grants the full control permission to all users under an account. By default, the FULL_CONTROL permission is applied to all objects in the bucket.
Enterprise project ID, which can be obtained from the enterprise project service. The value is a universally unique identifier (UUID). The value of a default enterprise project is 0 or does not contain this header. Users who have not enabled the enterprise project service do not need to carry this header either.
This operation lists objects in a bucket. To use this operation, you must have the permission to read the bucket.
+
If you specify only the bucket name in the request URI, for example GET /BucketName, OBS returns descriptions for some or all objects (a maximum of 1000 objects) in the bucket. If you also specify one or more parameters among prefix, marker, max-keys, and delimiter in the request, OBS returns a list of objects as specified.
+
You can also add the versions parameter to the request to list multiple versions of an object in a bucket.
+
+
Request Syntax
1
+2
+3
+4
GET / HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Syntax (for multi-version objects)
1
+2
+3
+4
GET /?versions HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request uses parameters to list some objects in a bucket. Table 1 describes the parameters.
+
+
Table 1 Request parameters
Parameter
+
+
Description
+
+
Mandatory
+
+
+
+
prefix
+
+
Lists objects that begin with the specified prefix.
+
Type: string
+
+
No
+
+
+
marker
+
+
Specifies a marker when listing objects in a bucket. With a marker configured, objects after this marker will be returned in alphabetical order.
+
Type: string
+
+
No
+
+
+
max-keys
+
+
Sets the maximum number of objects (in alphabetical order) returned in the response body. The value ranges from 1 to 1000. If the value has exceeded the upper limit, 1,000 objects are returned by default.
+
Type: integer
+
+
No
+
+
+
delimiter
+
+
Separator used to group object names. If a prefix is specified, objects with the same string from the prefix to the first delimiter are grouped into one CommonPrefixes. If no prefix is specified, objects with the same string from the first character to the first delimiter are grouped into one CommonPrefixes.
+
For example, there are three objects (abcd, abcde, and bbcde) in a bucket. If delimiter is set to d and prefix is set to a, objects abcd and abcde are grouped into a CommonPrefixes with abcd as the prefix. If only delimiter is set to d, objects abcd and abcde are grouped into a CommonPrefixes with abcd as the prefix, and bbcde is grouped separately into another CommonPrefixes with bbcd as the prefix.
+
Type: string
+
+
No
+
+
+
key-marker
+
+
Position to start with when objects are listed
+
Type: string
+
Valid value: value of NextKeyMarker in the response body of the last request
+
+
No
+
+
+
version-id-marker
+
+
This parameter applies only to versioning objects.
+
Specifies the version ID to start with when objects in a bucket are listed. Objects are listed in alphabetical order (a maximum of 1,000 objects are displayed at a time). This parameter is used together with the key-marker in the request. If the value of version-id-marker is not a version ID specified by key-marker, version-id-marker is invalid.
+
Type: string
+
Valid value: object version ID, that is, the value of NextVersionIdMarker in the response body of the last request
+
+
No
+
+
+
+
+
+
+
Request Headers
This request uses common request headers. Table 3 lists the common request headers.
+
+
Request Elements
This request contains no elements.
+
+
Response Syntax
1
+2
+3
+4
+5
+6
HTTP/1.1 status_code
+Date: date
+x-obs-bucket-location: region
+Content-Type: application/xml
+Content-Length: length
+<ResponseBody>
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response contains the XML list of buckets owned by the user. Table 2 describes the elements.
+
+
Table 2 Response elements
Element
+
+
Description
+
+
+
+
ListBucketResult
+
+
A list of objects in a bucket
+
Type: XML
+
+
+
Contents
+
+
Object metadata
+
Type: XML
+
Ancestor: ListBucketResult
+
+
+
CommonPrefixes
+
+
Group information. If you specify a delimiter in the request, the response contains group information in CommonPrefixes.
+
Type: XML
+
Ancestor: ListBucketResult
+
+
+
Delimiter
+
+
The delimiter parameter specified in a request
+
Type: string
+
Ancestor: ListBucketResult
+
+
+
ETag
+
+
128-bit MD5 digest of the Base64 code of an object. ETag is the unique identifier of the object content. It can be used to identify whether the object content is changed. For example, if ETag value is A when an object is uploaded and the ETag value has changed to B when the object is downloaded, it indicates that the object content is changed. The actual ETag is the hash value of the object, which only reflects the changed content rather than the metadata. An uploaded object or copied object has a unique ETag after being encrypted using MD5. (If the object is encrypted on the server side, the ETag value is not the MD5 digest of the object, but the unique identifier calculated through server-side encryption.)
+
Type: string
+
Ancestor: ListBucketResult.Contents
+
+
+
Type
+
+
Object type. This parameter is returned when the object type is not Normal.
+
Type: string
+
Ancestor: ListBucketResult.Contents
+
+
+
ID
+
+
Tenant ID of the object owner
+
Type: string
+
Ancestor: ListBucketResult.Contents.Owner
+
+
+
IsTruncated
+
+
Determines whether the returned list of objects is truncated. The value true indicates that the list was truncated and false indicates that the list was not truncated.
+
Type: boolean
+
Ancestor: ListBucketResult
+
+
+
Key
+
+
Object name
+
Type: string
+
Ancestor: ListBucketResult.Contents
+
+
+
LastModified
+
+
Time (UTC) when an object was last modified
+
Type: date
+
Ancestor: ListBucketResult.Contents
+
+
+
Marker
+
+
Marker for the position from which objects in a bucket will be listed
+
Type: string
+
Ancestor: ListBucketResult
+
+
+
NextMarker
+
+
A marker for the last returned object in the list. NextMarker is returned when not all the objects are listed. You can set the Marker value to list the remaining objects in follow-up requests.
+
Type: string
+
Ancestor: ListBucketResult
+
+
+
MaxKeys
+
+
Maximum number of objects returned
+
Type: string
+
Ancestor: ListBucketResult
+
+
+
Name
+
+
Name of the requested bucket
+
Type: string
+
Ancestor: ListBucketResult
+
+
+
Owner
+
+
User information, including the domain ID and username
+
Type: XML
+
Ancestor: ListBucketResult.Contents
+
+
+
Prefix
+
+
Prefix of an object name. Only objects whose names have this prefix are listed.
+
Type: string
+
Ancestor: ListBucketResult
+
+
+
Size
+
+
Object size in bytes
+
Type: string
+
Ancestor: ListBucketResult.Contents
+
+
+
StorageClass
+
+
Storage class of an object
+
Type: enumeration
+
Valid value: STANDARD | WARM | COLD
+
Ancestor: ListBucketResult.Contents
+
+
+
+
+
+
+
Table 3 Elements in the response message for listing multi-version objects.
Element
+
+
Description
+
+
+
+
ListVersionsResult
+
+
Container for the list of objects (including objects with multiple version IDs)
+
Type: container
+
+
+
Name
+
+
Bucket name
+
Type: string
+
Ancestor: ListVersionsResult
+
+
+
Prefix
+
+
Prefix of an object name. Only objects whose names have this prefix are listed. Type: string
+
Ancestor: ListVersionsResult
+
+
+
KeyMarker
+
+
Marker for the object key from which objects will be listed
+
Type: string
+
Ancestor: ListVersionsResult
+
+
+
VersionIdMarker
+
+
Object version ID to start with when objects are listed
+
Type: string
+
Ancestor: ListVersionsResult
+
+
+
NextKeyMarker
+
+
Key marker for the last returned object in the list. NextKeyMarker is returned when not all the objects are listed. You can set the KeyMarker value to list the remaining objects in follow-up requests.
+
Type: string
+
Ancestor: ListVersionsResult
+
+
+
NextVersionIdMarker
+
+
Version ID marker for the last returned object in the list. NextVersionIdMarker is returned when not all the objects are listed. You can set the VersionIdMarker value to list the remaining objects in follow-up requests.
+
Type: string
+
Ancestor: ListVersionsResult
+
+
+
MaxKeys
+
+
Maximum number of objects returned
+
Type: string
+
Ancestor: ListVersionsResult
+
+
+
IsTruncated
+
+
Indicates whether the returned list of objects is truncated. The value true indicates that the list was truncated and false indicates that the list was not truncated.
128-bit MD5 digest of the Base64 code of an object. ETag is the unique identifier of the object content. It can be used to identify whether the object content is changed. The actual ETag is the hash value of the object. For example, if ETag value is A when an object is uploaded and the ETag value has changed to B when the object is downloaded, it indicates that the object content is changed. The ETag only reflects the changed content rather than the metadata. An uploaded object or copied object has a unique ETag after being encrypted using MD5.
+
Type: string
+
Ancestor: ListVersionsResult.Version
+
+
+
Type
+
+
Object type. This parameter is returned when the object type is not Normal.
+
Type: string
+
Ancestor: ListVersionsResult.Version
+
+
+
Size
+
+
Object size in bytes
+
Type: string
+
Ancestor: ListVersionsResult.Version
+
+
+
Owner
+
+
User information, including the domain ID and username
Assuming that you have a bucket examplebucket that contains objects newfile, obj001, obj002, and obs001. If you want to list only object obj002, the request message is as follows:
This operation queries the metadata of a bucket. To use this operation, you must have the permission to read the bucket.
+
+
Request Syntax
1
+2
+3
+4
HEAD / HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
Table 1 lists the header fields required when obtaining CORS configuration information.
+
+
Table 1 Request headers for obtaining CORS configuration
Header
+
+
Description
+
+
Mandatory
+
+
+
+
Origin
+
+
Origin of the cross-domain request specified by the pre-request. Generally, it is a domain name.
+
Type: string
+
+
Yes
+
+
+
Access-Control-Request-Headers
+
+
HTTP headers of a request. The request can use multiple HTTP headers.
+
Type: string
+
+
No
+
+
+
+
+
+
+
Request Elements
This request contains no elements.
+
+
Response Syntax
1
+2
+3
HTTP/1.1 status_code
+x-obs-bucket-location: region
+Date: date
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
Table 2 lists additional response header parameters that are used except for the common response header parameters.
+
+
Table 2 Additional response header parameters
Header
+
+
Description
+
+
+
+
x-obs-bucket-location
+
+
The region where the bucket resides.
+
Type: string
+
+
+
x-obs-storage-class
+
+
Default storage class of the bucket. The options are as follows: STANDARD (Standard storage class), WARM (Warm storage class), and COLD (Cold storage class).
+
Type: string
+
+
+
x-obs-version
+
+
OBS version of the bucket.
+
Type: string
+
+
+
x-obs-epid
+
+
Enterprise project ID of the current bucket.
+
Type: string
+
+
+
Access-Control-Allow-Origin
+
+
Indicates that the origin is included in the response if the origin in the request meets the CORS configuration requirements when CORS is configured for buckets.
+
Type: string
+
+
+
Access-Control-Allow-Headers
+
+
Indicates that the headers are included in the response if headers in the request meet the CORS configuration requirements when CORS is configured for buckets.
+
Type: string
+
+
+
Access-Control-Max-Age
+
+
Value of MaxAgeSeconds in the CORS configuration of the server when CORS is configured for buckets.
+
Type: integer
+
+
+
Access-Control-Allow-Methods
+
+
Indicates that methods in the rule are included in the response if Access-Control-Request-Method in the request meets the CORS configuration requirements when CORS is configured for buckets.
+
Type: string
+
Valid values: GET, PUT, HEAD, POST, and DELETE.
+
+
+
Access-Control-Expose-Headers
+
+
Value of ExposeHeader in the CORS configuration of a server when CORS is configured for buckets.
+
Type: string
+
+
+
+
+
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
No special error responses are involved. For details about error responses, see Table 2.
+
+
Sample Request 1
No header field for obtaining CORS configuration is carried.
This operation deletes specified buckets. This operation can be performed only by the bucket owner and users who have been authorized (via a policy) with the permission to delete the bucket. The bucket to be deleted must be an empty bucket. If a bucket has an object or a multipart task, the bucket is not empty. You can list objects and multipart upload tasks in a bucket to check whether the bucket is empty.
+
Note:
+
If the server returns a 5XX error or times out when a bucket is being deleted, the system needs to synchronize the bucket information. During this period, the bucket information may be inaccurate. Therefore, wait a while and then check whether the bucket is successfully deleted. If the bucket can still be queried, send the deletion request again.
+
+
Request Syntax
1
+2
+3
+4
DELETE / HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common request headers. For details, see Table 3.
+
+
Request Elements
This request involves no elements.
+
+
Response Syntax
1
+2
HTTP/1.1 status_code
+Date: date
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
No special error responses are involved. For details about error responses, see Table 2.
This operation creates or modifies policies for buckets. If the specified bucket already has a policy, the policy in the request will overwrite the existing one. There is no limit on the number of bucket policies (statements) for a bucket. However, the total size of JSON descriptions of all bucket policies in a bucket cannot exceed 20 KB.
+
To perform this operation, the user must be the bucket owner or the bucket owner's IAM user that has permissions required for configuring bucket policies.
+
+
Request Syntax
1
+2
+3
+4
+5
PUT /?policy HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: signatureValue
+Policy written in JSON
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
+
Request Elements
The request body is a JSON string containing bucket policy information.
+
+
Response Syntax
1
+2
+3
HTTP/1.1 status_code
+Date: date
+Content-Length: length
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
No special error responses are returned. For details, see Table 2.
+
+
Sample Request 1
Grant permissions to an OBS tenant.
+
Grant permissions to the tenant whose ID is 783fc6652cf246c096ea836694f71855.
This operation uses the sub-resources of policy to return the policy information of a specified bucket.
+
To perform this operation, the user must be the bucket owner or the bucket owner's IAM user that has permissions required for obtaining bucket policies.
+
This operation cannot be performed in the following scenarios, and the 404 error code "NoSuchBucketPolicy" is returned:
+
The specified bucket policy does not exist.
The standard bucket policy is set to Private and no custom bucket policy is configured.
+
+
Request Syntax
1
+2
+3
+4
GET /?policy HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request involves no elements.
+
+
Response Syntax
1
+2
+3
+4
HTTP/1.1 status_code
+Content-Type: application/xml
+Date: date
+Policy Content
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
The response body is a JSON string containing bucket policy information.
+
+
Error Responses
No special error responses are returned. For details, see Table 2.
This operation uses the policy sub-resources to delete the policy of a specified bucket.
+
To perform this operation, the user must be the bucket owner or the bucket owner's IAM user that has permissions required for deleting bucket policies.
+
The 204 error code "No Content" is returned regardless of whether a requested bucket policy exists or not.
+
+
Request Syntax
1
+2
+3
+4
DELETE /?policy HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request involves no elements.
+
+
Response Syntax
1
+2
+3
+4
HTTP/1.1 status_code
+Date: date
+Content-Type: text/xml
+Content-Length: length
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
No special error responses are returned. For details, see Table 2.
This operation controls access permissions for buckets. By default, only the creator of a bucket has the permission to read and write the bucket. You can also set other access permissions. For example, you can set a public read policy to grant the read permission to all users.
+
You can configure an ACL when creating a bucket, and modify or obtain the ACLs of existing buckets using the API operations. A bucket ACL supports a maximum of 100 grants.
You can change the ACL of a bucket by using the header settings. Each ACL configured with the header setting has a set of predefined grantees and authorized permissions. If you want to authorize access permissions by adding the header to a request, you must add the following header and specify the value.
+
+
Table 1 Optional header for specifying canned ACLs
This operation returns the ACL information of a bucket. To obtain the ACL of a bucket, you need to have the READ_ACP or FULL_CONTROL permission for the bucket.
+
+
Request Syntax
1
+2
+3
+4
GET /?acl HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
When a bucket is created, the logging function is not enabled by default. To generate logs recording operations on buckets, you need to enable the logging function for the bucket. After the logging function is enabled, a log is generated for each operation on a bucket and multiple logs are packed into a log file. When enabling the logging function, you need to specify a location where log files are stored. They can be stored in the bucket for which the logging is enabled, or in other buckets that you have the required permissions. However, the bucket where log files are stored and the bucket for which the logging is enabled must be in the same region.
+
Log files are generated by OBS and uploaded to the bucket where logs are stored. Therefore, OBS needs to be authorized to upload generated log files. Before configuring the logging function, you need to create an agency for OBS in IAM, the agency name is configured as a parameter of the bucket, and the logging function must be configured under the LoggingEnabled tag in the XML file. You only need to authorize the agency with the upload permissions for the target bucket.
To disable the bucket logging function, upload a logging file with an empty BucketLoggingStatus tag.
+
By default, a bucket whose storage class is Warm or Cold cannot be used for storing log files. Stored log files occupy storage space in a bucket. Therefore, users are charged for the logging service based on the pricing for data storage.
This request uses common headers. For details, see Table 3.
+
+
Request Elements
+
Table 1 Request elements
Element
+
+
Description
+
+
Mandatory
+
+
+
+
BucketLoggingStatus
+
+
Container for logging status information
+
Type: container
+
+
Yes
+
+
+
Agency
+
+
Name of the IAM agency created by the owner of the target bucket on IAM.
+
Type: string
+
+
You must set this parameter when enabling the logging function. Do not set this parameter when disabling the logging function.
+
+
+
LoggingEnabled
+
+
Container for logging information. Present this element when enabling the logging function. Otherwise, absent it. You can add specific logging information in this element.
+
Type: container
+
+
You must set this parameter when enabling the logging function. Do not set this parameter when disabling the logging function.
+
+
+
Grant
+
+
Container for the grantee and the grantee's logging permissions. It describes who has the permission to access the generated log files.
+
Type: container
+
+
No
+
+
+
Grantee
+
+
Container for the user that is granted with the logging permission.
+
Type: container
+
+
No
+
+
+
ID
+
+
Account ID of the authorized user, which is globally unique.
+
Type: string
+
+
No
+
+
+
Permission
+
+
Permissions of the grantee to the generated logs.
+
Type: string
+
Value options: FULL_CONTROL | READ | WRITE
+
+
No
+
+
+
TargetBucket
+
+
When enabling the logging function, the owner of the bucket being logged can specify a target bucket to store the generated log files. Ensure that the bucket owner who configures the logging function has the FULL_CONTROL permission for the bucket that stores log files. Log files generated for multiple buckets can be stored in the same target bucket. If you do so, you need to specify different TargetPrefixes to classify logs for different buckets.
+
Type: string
+
+
You must set this parameter when enabling the logging function. Do not set this parameter when disabling the logging function.
+
+
+
TargetPrefix
+
+
You can specify a prefix using this element so that log files are named with this prefix.
+
Type: string
+
+
You must set this parameter when enabling the logging function. Do not set this parameter when disabling the logging function.
Each access log contains the following information:
+
+
Table 2 Format of bucket access logs
Parameter
+
+
Example
+
+
Description
+
+
+
+
BucketOwner
+
+
787f2f92b20943998a4fe2ab75eb09b8
+
+
ID of the bucket owner
+
+
+
Bucket
+
+
bucket
+
+
Bucket name
+
+
+
Time
+
+
[13/Aug/2015:01:43:42 +0000]
+
+
Request timestamp
+
+
+
Remote IP
+
+
xx.xx.xx.xx
+
+
Request IP address
+
+
+
Requester
+
+
787f2f92b20943998a4fe2ab75eb09b8
+
+
ID of the requester
+
+
+
RequestID
+
+
281599BACAD9376ECE141B842B94535B
+
+
Request ID
+
+
+
Operation
+
+
REST.GET.BUCKET.LOCATION
+
+
Operation
+
+
+
Key
+
+
-
+
+
Object name
+
+
+
Request-URI
+
+
GET /bucket?location HTTP/1.1
+
+
Request URI
+
+
+
HTTPStatus
+
+
200
+
+
Response code
+
+
+
ErrorCode
+
+
-
+
+
Error code
+
+
+
BytesSent
+
+
211
+
+
Size of the HTTP response, expressed in bytes
+
+
+
ObjectSize
+
+
-
+
+
Object size
+
+
+
TotalTime
+
+
6
+
+
Processing time on the server
+
Unit: ms
+
+
+
Turn-AroundTime
+
+
6
+
+
Total request processing time
+
Unit: ms
+
+
+
Referer
+
+
-
+
+
Referer header of the request
+
+
+
User-Agent
+
+
HttpClient
+
+
User-Agent header of the request
+
+
+
VersionID
+
+
-
+
+
Version ID contained in a request
+
+
+
STSLogUrn
+
+
-
+
+
Federated authentication and agency information
+
+
+
StorageClass
+
+
STANDARD_IA
+
+
Current object storage class
+
+
+
TargetStorageClass
+
+
GLACIER
+
+
Storage class that the object will be transitioned to
+
+
+
DentryName
+
+
12456/file.txt
+
+
For a parallel file system, this field indicates an internal identifier of a file or directory. Its value consists of a parent directory inode number and a file or directory name.
For a bucket, the value of this field is -.
+
+
+
+
+
+
+
Response Syntax
1
+2
+3
HTTP/1.1 status_code
+Date: date
+Content-Length: length
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
No special error responses are involved. For details about error responses, see Table 2.
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response contains elements to specify the bucket logging status. Table 1 describes the elements.
+
+
Table 1 Response elements
Element
+
+
Description
+
+
+
+
BucketLoggingStatus
+
+
Container for logging status information
+
Type: container
+
+
+
Agency
+
+
Name of the agency created by the owner of the logging bucket for uploading log files by OBS
+
Type: string
+
+
+
LoggingEnabled
+
+
Container for logging information. This element enables or disables the logging function. Present this element when enabling the logging. Otherwise, absent it.
+
Type: container
+
+
+
Grant
+
+
Container for the grantee and the granted permissions
+
Type: container
+
+
+
Grantee
+
+
Container for the user that is granted with the logging permission
+
Type: container
+
+
+
ID
+
+
Grantee domain ID, a globally unique ID
+
Type: string
+
+
+
Permission
+
+
Logging permission granted to the grantee for a bucket. The bucket owner is automatically granted the FULL_CONTROL permission when creating the bucket. Logging permissions control access to different logs.
+
Type: string
+
Value options: FULL_CONTROL | READ | WRITE
+
+
+
TargetBucket
+
+
When enabling the logging function, the owner of the bucket being logged can specify a target bucket to store the generated log files. Log files generated for multiple buckets can be stored in the same target bucket. If you do so, you need to specify different TargetPrefixes to classify logs for different buckets.
+
Type: string
+
+
+
TargetPrefix
+
+
You can specify a prefix using this element so that log files are named with this prefix.
+
Type: string
+
+
+
TargetGrants
+
+
Container for granting information
+
Type: container
+
+
+
+
+
+
+
Error Responses
No special error responses are involved. For details about error responses, see Table 2.
This operation configures lifecycle rules that can delete or migrate objects from a bucket at a specified time. Typical application scenarios:
+
Delete periodically uploaded files. Some files uploaded periodically need only to be retained for only one week or one month.
Delete files that are frequently accessed within a certain period of time but are seldom accessed afterward. You can archive these files and then schedule the time for deletion.
The minimum time for the transition of the bucket storage to Warm or to Cold can be configured. The value ranges from 24 to 8640.
+
You can perform this operation to create or update the lifecycle configuration of a bucket.
+
Objects are permanently deleted upon the expiration of their lifecycle time, and the deleted objects cannot be restored.
+
+
To perform this operation, you must have the PutLifecycleConfiguration permission. By default, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.
+
The lifecycle configuration enables OBS to delete objects and transition object storage classes at a scheduled time. To prevent a user from doing so, the following permissions granted to the user must be revoked:
+
DeleteObject
DeleteObjectVersion
PutLifecycleConfiguration
+
If you want to forbid a user to set the bucket lifecycle configuration, revoke the PutLifecycleConfiguration permission from the user.
Base64-encoded 128-bit MD5 digest of the message according to RFC 1864.
+
Type: string
+
Example: n58IG6hfM7vqI4K0vnWpog==
+
+
Yes
+
+
+
+
+
+
+
Request Elements
In this request, you need to specify the lifecycle configuration in the request body. The lifecycle configuration can be uploaded in the form of an XML file with elements described in Table 2.
+
If the versioning of a bucket is enabled or suspended, you can set NoncurrentVersionTransition or NoncurrentVersionExpiration to control the lifecycle of historical object versions. The lifecycle of a historical version depends on the time when it becomes a historical one (time when the version is replaced by a new version) and the value of NoncurrentDays. For object deletion, if NoncurrentDays is set to 1, an object version will be deleted only after it becomes a historical one for one day. If the version V1 of object A is created on the first date of a month and new version V2 is uploaded on the fifth date of the month, V1 becomes a historical version. At 00:00 on the seventh date of the month, V1 will expire. If an object version does not meet the deletion conditions, but NoncurrentDays is set to 1 and StorageClass is set to WARM, the version transitions to the Warm storage class one day after it has become a historical version. For example, the V1 version of object A is created on the first day of a month, and its new version V2 is uploaded on the fifth day of the month. Then V1 becomes a historical version. One day later, that is, at 0 o'clock of the seventh day, V1 transitions to the Warm storage class. The deletion or transition of the object after the expiration time may be delayed. The delay is within 48 hours.
Objects are processed according to the following procedures, if their latest versions meet the expiration rule and versioning is enabled or suspended for the bucket.
Versioning enabled:
If the latest version of the object does not have the DeleteMarker, the object generates a new DeleteMarker.
+
If the object of the latest version has the DeleteMarker and the object has this version only, this version will be deleted.
+
If the object of the latest version has the DeleteMarker and the object has other versions, all versions of the object remain unchanged.
+
Versioning suspended:
If the latest version of the object does not have the DeleteMarker and is not the null version, the object generates a new DeleteMarker for the null version.
+
If the latest version of the object does not have the DeleteMarker but is the null version, this null version is overwritten by a new DeleteMarker generated for the null version.
+
If the object of the latest version has the DeleteMarker and the object has this version only, this version will be deleted.
+
If the object of the latest version has the DeleteMarker and the object has other versions, all versions of the object remain unchanged.
+
+
The following lists the processing when the versioning is enabled or suspended for a bucket and objects of the latest versions meet the transition rules:
If the latest version of the object has the DeleteMarker, the storage class of this version will not be transitioned.
If the latest version of the object does not have the DeleteMarker and meets the transition rule, the storage class of this version will be transitioned.
+
+
Table 2 Response elements for lifecycle configuration
Name
+
+
Description
+
+
Mandatory
+
+
+
+
Date
+
+
Specifies that OBS executes lifecycle rules for objects before the specified date. The date must be compliant with the ISO8601 format, and the time must be compliant with the UTC format of 00:00:00. For example: 2018-01-01T00:00:00.000Z, which indicates that objects whose last modification time is earlier than 2018-01-01T00:00:00.000Z are deleted or transitioned to other storage classes. Objects whose last modification time is equal to or later than the specified time are not deleted or dumped.
+
Type: string
+
Ancestor node: Expiration, Transition
+
+
Required if the Days element is absent.
+
+
+
Days
+
+
Specifies the number of days (since the latest update to the latest object version) after which the lifecycle rule takes effect.
+
Type: positive integer
+
Ancestor node: Expiration, Transition
+
+
Required if the Date element is absent.
+
+
+
StorageClass
+
+
The storage class to which the object is transitioned.
Required if the NoncurrentVersionExpiration or NoncurrentVersionTransition element is present.
+
+
+
NoncurrentVersionTransition
+
+
Transition time of historical object versions and the object storage class after transition.
+
Type: XML
+
Children node: NoncurrentDays, StorageClass
+
Ancestor node: Rule
+
+
Required if the Transition, Expiration, AbortIncompleteMultipartUpload, or NoncurrentVersionExpiration element is absent.
+
+
+
NoncurrentVersionExpiration
+
+
Container for the expiration time of objects' historical versions. If versioning is enabled or suspended for a bucket, you can set NoncurrentVersionExpiration to delete historical versions of objects that match the lifecycle rule (only applicable to the historical versions of objects).
+
Type: XML
+
Children node: NoncurrentDays
+
Ancestor node: Rule
+
+
No
+
+
+
AbortIncompleteMultipartUpload
+
+
Container for specifying when the not merged parts (fragments) in an incomplete upload will be deleted.
+
Type: XML
+
Children node: DaysAfterInitiation
+
Ancestor node: Rule
+
+
Required if the Transition, Expiration, NoncurrentVersionExpiration, or NoncurrentVersionTransition element is absent.
+
+
+
DaysAfterInitiation
+
+
Specifies the number of days since the initiation of an incomplete multipart upload that OBS will wait before deleting the not merged parts (fragments) of the upload.
+
Type: positive integer
+
Ancestor node: AbortIncompleteMultipartUpload
+
+
Required if the AbortIncompleteMultipartUpload element is absent.
+
+
+
Prefix
+
+
Object name prefix identifying one or more objects to which the rule applies.
+
Type: string
+
Ancestor node: Rule
+
Constraints:
+
When you configure a lifecycle rule by specifying a prefix, if the specified prefix and the prefix of an existing lifecycle rule overlap, OBS regards these two rules as one and forbids you to configure this rule. For example, if there is a rule with the object prefix abc configured in the system, another rule with the object prefix starting with abc cannot be configured.
If there is already a lifecycle rule that is based on an object prefix, you are not allowed to configure another rule that is applied to the entire bucket.
+
+
Yes
+
+
+
Rule
+
+
Container for a specific lifecycle rule.
+
Type: container
+
Ancestor node: LifecycleConfiguration
+
+
Yes
+
+
+
Status
+
+
Indicates whether the rule is enabled.
+
Type: string
+
Ancestor node: Rule
+
Value options: Enabled, Disabled
+
+
Yes
+
+
+
+
+
+
+
Response Syntax
1
+2
+3
HTTP/1.1 status_code
+Date: date
+Content-Length: length
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response contains no elements.
+
+
Error Responses
No special error responses are returned. For details about error responses, see Table 2.
This operation obtains the bucket lifecycle configuration.
+
To perform this operation, you must have the GetLifecycleConfiguration permission. By default, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.
+
+
Request Syntax
1
+2
+3
+4
GET /?lifecycle HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response contains elements to detail the configuration. Table 1 describes the elements.
+
+
Table 1 Response elements for lifecycle configuration
Element
+
+
Description
+
+
+
+
Date
+
+
Specifies that OBS executes lifecycle rules for objects before the specified date. The date must be compliant with the ISO8601 format, and the time must be compliant with the UTC format of 00:00:00. For example: 2018-01-01T00:00:00.000Z, which indicates that objects whose last modification time is earlier than 2018-01-01T00:00:00.000Z are deleted or transitioned to other storage classes. Objects whose last modification time is equal to or later than the specified time are not deleted or dumped.
+
Type: string
+
Ancestor node: Expiration, Transition
+
+
+
Days
+
+
Specifies the number of days (since the latest update to the latest object version) after which the lifecycle rule is executed.
+
Type: positive integer
+
Ancestor node: Expiration, Transition
+
+
+
StorageClass
+
+
The storage class to which the object is transitioned.
Transition time of historical object versions and the object storage class after transition.
+
Type: XML
+
Children node: NoncurrentDays, StorageClass
+
Ancestor node: Rule
+
+
+
NoncurrentVersionExpiration
+
+
Container for the expiration time of objects' historical versions. If versioning is enabled or suspended for a bucket, you can set NoncurrentVersionExpiration to delete objects whose life cycles have expired.
+
Type: XML
+
Children node: NoncurrentDays
+
Ancestor node: Rule
+
+
+
AbortIncompleteMultipartUpload
+
+
Container for specifying when the not merged parts (fragments) in an incomplete upload will be deleted.
+
Type: XML
+
Children node: DaysAfterInitiation
+
Ancestor node: Rule
+
+
+
DaysAfterInitiation
+
+
Specifies the number of days since the initiation of an incomplete multipart upload that OBS will wait before deleting the not merged parts (fragments) of the upload.
+
Type: positive integer
+
Ancestor node: AbortIncompleteMultipartUpload
+
+
+
Prefix
+
+
Object name prefix identifying one or more objects to which the rule applies.
+
Type: string
+
Ancestor node: Rule
+
+
+
Rule
+
+
Container for a specific lifecycle rule.
+
Type: container
+
Ancestor node: LifecycleConfiguration
+
+
+
Status
+
+
Indicates whether the rule is enabled.
+
Type: string
+
Ancestor node: Rule
+
Value options: Enabled, Disabled
+
+
+
+
+
+
+
Error Responses
Table 2 describes possible special errors in the request.
+
+
Table 2 Special error
Error Code
+
+
Description
+
+
HTTP Status Code
+
+
+
+
NoSuchLifecycleConfiguration
+
+
The bucket lifecycle configuration does not exist.
This operation deletes the lifecycle configuration of a bucket. After the lifecycle configuration of a bucket is deleted, OBS will not automatically delete objects in that bucket.
+
To perform this operation, you must have the PutLifecycleConfiguration permission. By default, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.
+
+
Request Syntax
1
+2
+3
+4
DELETE /?lifecycle HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: Authorization
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request involves no elements.
+
+
Response Syntax
1
+2
+3
+4
HTTP/1.1 status_code
+Date: date
+Content-Type: text/xml
+Date: date
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
No special error responses are involved. For details about error responses, see Table 2.
This operation restores an object that is mistakenly overwritten or deleted. You can use versioning to save, query, and restore objects of different versions. Versioning allows you to easily recover lost data due to misoperations or program faults. Versioning can also be used for retaining and archiving data.
+
By default, versioning is disabled for a bucket.
+
You can perform this operation to enable or suspend versioning for a bucket.
+
After versioning is enabled for a bucket:
+
OBS creates a unique version ID for each uploaded object. Namesake objects are not overwritten and are distinguished by their own version IDs.
You can download objects by specifying version IDs. By default, the latest object is downloaded if the version ID is not specified.
Objects can be deleted by version ID. If an object is deleted with no version ID specified, the object is only attached with a deletion marker and a unique version ID but is not physically deleted.
The latest objects in a bucket are returned by default after a GET Object request. You can also send a request to obtain a bucket's objects with all version IDs.
Except deletion markers and object metadata, storage space occupied by objects with all version IDs is charged.
+
After versioning is suspended for a bucket:
+
Existing objects with version IDs are not affected.
The system creates version ID null to an uploaded object and the object will be overwritten after a namesake one is uploaded.
You can download objects by specifying version IDs. By default, the latest object is downloaded if the version ID is not specified.
Objects can be deleted by version ID. If an object is deleted with no version ID specified, the object is attached with a deletion marker whose version ID is null. The object with version ID null is physically deleted.
Except deletion markers and object metadata, storage space occupied by objects with all version IDs is charged.
+
Only the bucket owner can set versioning for the bucket.
+
+
Request Syntax
1
+2
+3
+4
+5
+6
+7
+8
+9
PUT /?versioning HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+Content-Length: length
+
+<VersioningConfiguration>
+ <Status>status</Status>
+</VersioningConfiguration>
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request contains elements to configure the bucket versioning in XML format. Table 1 lists the request elements.
+
+
Table 1 Elements for configuring bucket versioning
Element
+
+
Description
+
+
Mandatory
+
+
+
+
VersioningConfiguration
+
+
Root node for configuring versioning
+
Ancestor node: none
+
+
Yes
+
+
+
Status
+
+
Versioning status of the bucket
+
Type: enumeration
+
Ancestor node: VersioningConfiguration
+
Value options: Enabled, Suspended
+
+
Yes
+
+
+
+
+
+
+
Response Syntax
1
+2
+3
+4
HTTP/1.1 status_code
+Date: date
+
+Content-Length: length
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
No special error responses are involved. For details about error responses, see Table 2.
This operation notifies users of their operations on buckets, allowing users know events happened on buckets in a timely manner.
+
By default, the notification function of a bucket is not enabled, and the NotificationConfiguration element is null. If you want to disable the function, set the NotificationConfiguration element to null.
After receiving a request for configuring event notification, OBS verifies whether the specified SMN topic exists and whether the topic is authorized to OBS. If the topic exists and is authorized to OBS, OBS sends a test notification to the topic subscriber.
+
To perform this operation, you must have the PutBucketNotification permission. By default, the permission is granted to the bucket owner only. However, it can be granted to other users by configuring the bucket policy.
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request contains elements to specify the notification configuration for the bucket in XML format. For details about the configuration elements, see Table 1.
+
+
Table 1 Request elements for notification function configuration
Element
+
+
Description
+
+
Mandatory
+
+
+
+
NotificationConfiguration
+
+
Root element for configuring the event notification function of a bucket. If the sub element is null, the function is disabled.
+
Type: element
+
Ancestor: none
+
Children: no or multiple TopicConfigurations
+
+
Yes
+
+
+
TopicConfiguration
+
+
Element for configuring the event notification topic.
+
Type: element
+
Ancestor: NotificationConfiguration
+
Children: Id, Filter, Topic, Event, or Events
+
+
No
+
+
+
Topic
+
+
URN of the event notification topic. When OBS detects a specific event in the bucket, it publishes a notification message to the topic. The topic value can be found in SMN topics.
Unique ID of each event notification. If the user does not specify an ID, the system assigns an ID automatically.
+
Type: string
+
Ancestor:
+
TopicConfiguration
+
+
No
+
+
+
Filter
+
+
Element used to store rules of filtering object names.
+
Type: element
+
Ancestor:
+
TopicConfiguration
+
Children: Object
+
+
No
+
+
+
Object
+
+
Element that defines the filtering rule. The rule filters objects based on the prefixes and suffixes of object names.
+
Type: element
+
Ancestor: Filter
+
Children: one or more FilterRules
+
+
No
+
+
+
FilterRule
+
+
Element that defines key-value pairs of the filtering rule
+
Type: element
+
Ancestor: Object
+
Children: Name, Value
+
+
No
+
+
+
Name
+
+
Prefix or suffix of object names for filtering
+
Type: string
+
Ancestor: FilterRule
+
Value options: prefix, suffix
+
+
No
+
+
+
Value
+
+
Key word of object names. Based on the prefix or suffix defined by Name, enter the key word for filtering objects. A longer string of characters delivers a more accurate filtering result. A maximum of 1024 characters are supported.
+
Type: string
+
Ancestor: FilterRule
+
+
No
+
+
+
Event
+
+
Type of events that need to be notified
+
NOTE:
Multiple event types can be added in one TopicConfiguration item.
+
+
Type: string
+
Value options:
+
The following values can be used to upload an object:
+
ObjectCreated:Put
ObjectCreated:Post
ObjectCreated:Copy
ObjectCreated:CompleteMultipartUpload
+
Or use wildcard characters to support all upload operations:
+
ObjectCreated:*
+
The following values can be used to delete an object:
+
ObjectRemoved:Delete
ObjectRemoved:DeleteMarkerCreated
+
Or use wildcard characters to support all delete operations:
+
ObjectRemoved:*
+
+
Ancestor:
+
TopicConfiguration
+
+
Required if TopicConfiguration is added
+
+
+
+
+
+
+
Response Syntax
1
+2
+3
+4
HTTP/1.1 status_code
+Date: date
+Content-Length: length
+Content-Type: type
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
When this operation is being called, the system checks whether the NotificationConfiguration element is valid and whether the configuration is valid. The following table lists the common errors and possible causes of this operation.
+
+
Table 2 Error codes and possible causes
Error Code
+
+
Description
+
+
HTTP Status Code
+
+
+
+
InvalidArgument
+
+
Possible causes of this error are:
+
The specified event is not supported.
The specified URN does not exist or is incorrect.
The specified region in the URN is different as the region where the bucket resides.
The specified filtering rules overlap.
+
+
400 Bad Request
+
+
+
AccessDenied
+
+
The operator is not the bucket owner and not granted with the PutBucketNotification permission.
Obtaining the Event Notification Configuration of a Bucket
+
Functions
This operation obtains the notification configuration of a bucket.
+
To perform this operation, you must have the GetBucketNotification permission. By default, the permission is granted to the bucket owner only. However, it can be granted to other users by configuring the bucket policy or user policy.
+
+
Request Syntax
1
+2
+3
+4
GET /?notification HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
This operation sets or updates the default storage class of a bucket.
+
To perform this operation, you must have the PutBucketStoragePolicy permission. By default, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.
+
After the default storage class has been set for a bucket, if the storage class of an object is not specified during uploading, copying, or initialization of multi-part upload, the object storage class is the same as the default storage class of the bucket.
+
The default storage class of a bucket is Standard.
+
+
Request Syntax
1
+2
+3
+4
+5
+6
+7
+8
+9
PUT /?storageClass HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Content-Type: type
+Content-Length: length
+Authorization: authorization
+
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<StorageClassxmlns="http://obs.example.com/doc/2015-06-30/">STANDARD</StorageClass>
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request needs an additional element to specify the default bucket storage class. For details, see Table 1.
+
+
Table 1 Additional request elements
Element
+
+
Description
+
+
Mandatory
+
+
+
+
StorageClass
+
+
Specifies the default storage class for a bucket.
+
Type: string
+
Value options: STANDARD | WARM | COLD
+
There are three storage classes: STANDARD (Standard storage class), WARM (Warm storage class), and COLD (Cold storage class) Therefore, the following values can be configured: STANDARD, WARM, and COLD.
+
+
Yes
+
+
+
+
+
+
+
Response Syntax
1
+2
HTTP/1.1 status_code
+Date: date
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
No special error responses are involved. For details about error responses, see Table 2.
This operation obtains the default storage class of a bucket.
+
To perform this operation, you must have the GetBucketStoragePolicy permission. By default, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.
+
+
Request Syntax
1
+2
+3
+4
GET /?storageClass HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request contains no elements.
+
+
Response Syntax
1
+2
+3
+4
+5
+6
+7
+8
HTTP/1.1 status_code
+Date: date
+Content-Type: type
+Content-Length: length
+
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+
+<StorageClassxmlns="http://obs.example.com/doc/2015-06-30/">STANDARD</StorageClass>
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response contains elements to provide details about the storage class information of a bucket. Table 1 describes the elements.
+
+
Table 1 Response elements
Element
+
+
Description
+
+
+
+
StorageClass
+
+
Default storage class of the bucket.
+
Type: string. For details about the enumeration type, see Table 1.
+
+
+
+
+
+
+
Error Responses
No special error responses are involved. For details about error responses, see Table 2.
After tags are added to a bucket, all charging data records (CDRs) generated by the requests for this bucket will take the same tags. Thus, CDR reports can be categorized for detailed cost analysis. For example, if a running application uploads data to a bucket, you can tag the bucket with the application name. In this manner, the costs on the application can be analyzed using tags on CDRs.
+
To perform this operation, you must have the PutBucketTagging permission. By default, only the bucket owner can delete the tags of a bucket. The bucket owner can allow other users to perform this operation by setting a bucket policy or granting them the permission.
+
A bucket can have a maximum of 10 tags.
A tag key and key value can contain a maximum of 36 and 43 characters, respectively.
Tag keys and key values cannot contain commas (,), asterisks (*), vertical bars (|), slashes (/), less-than signs (<), greater-than signs (>), equal signs (=), backslashes (\), or ASCII codes (0x00 to 0x1F).
Base64-encoded 128-bit MD5 digest of the message according to RFC 1864.
+
Type: string
+
Example: n58IG6hfM7vqI4K0vnWpog==
+
+
Yes
+
+
+
+
+
+
+
Request Elements
In this request, you must configure bucket tags in the request body. The tag configuration is uploaded in XML format. Table 2 describes the configuration elements.
+
+
Table 2 Bucket tag configuration elements
Header
+
+
Description
+
+
Mandatory
+
+
+
+
Tagging
+
+
Element of the tag set and tag
+
Type: element
+
Ancestor: none
+
+
Yes
+
+
+
TagSet
+
+
Element of the tag set
+
Type: element
+
Ancestor: Tagging
+
+
Yes
+
+
+
Tag
+
+
Element of the tag information
+
Type: element
+
Ancestor: TagSet
+
+
Yes
+
+
+
Key
+
+
Tag name
+
Type: string
+
Ancestor: Tag
+
+
Yes
+
+
+
Value
+
+
Tag value
+
Type: string
+
Ancestor: Tag
+
+
Yes
+
+
+
+
+
+
+
Response Syntax
1
+2
+3
+4
+5
HTTP/1.1 status_code
+x-obs-request-id: request id
+x-obs-id-2: id
+Content-Length: length
+Date: date
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
In addition common error codes, this API also returns other error codes. The following table lists common errors and possible causes. For details, see Table 3.
+
+
Table 3 Bucket tag configuration errors
Error Code
+
+
Description
+
+
HTTP Status Code
+
+
+
+
InvalidTagError
+
+
An invalid tag is provided when configuring bucket tags.
+
+
400 Bad Request
+
+
+
MalformedXMLError
+
+
An incorrect XML format is provided when configuring bucket tags.
This operation obtains information about tags of a bucket.
+
To perform this operation, you must have the GetBucketTagging permission. By default, only the bucket owner can obtain the tags of a bucket. The bucket owner can allow other users to perform this operation by setting a bucket policy or granting them the permission.
+
+
Request Syntax
1
+2
+3
+4
GET /?tagging HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization string
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response contains elements to detail bucket tag configuration. Table 1 describes the elements.
+
+
Table 1 Elements for configuring bucket tags
Element
+
+
Description
+
+
+
+
Tagging
+
+
Element of the tag set and tag.
+
Type: element
+
Ancestor: none
+
+
+
TagSet
+
+
Element of the tag set.
+
Type: element
+
Ancestor: Tagging
+
+
+
Tag
+
+
Element of the tag information.
+
Type: element
+
Ancestor: TagSet
+
+
+
Key
+
+
Tag name.
+
Type: string
+
Ancestor: Tag
+
+
+
Value
+
+
Tag value.
+
Type: string
+
Ancestor: Tag
+
+
+
+
+
+
+
Error Responses
In addition to common error codes, this API also returns other error codes. The following table lists common errors and possible causes. For details, see Table 2.
+
+
Table 2 Bucket tag configuration errors
Error Code
+
+
Description
+
+
HTTP Status Code
+
+
+
+
NoSuchTagSet
+
+
The specified bucket does not have any tags.
+
+
404 Not Found
+
+
+
+
+
+
+
Sample Request
1
+2
+3
+4
+5
+6
GET /?tagging HTTP/1.1
+User-Agent: curl/7.29.0
+Host: examplebucket.obs.region.example.com
+Accept: */*
+Date: Wed, 27 Jun 2018 13:25:44 GMT
+Authorization: OBS H4IPJX0TQTHTHEBQQCEC:H1INcyc5i0XlHqYTfuzkPxLZUPM=
+
To perform this operation, you must have the PutBucketTagging permission. By default, only the bucket owner can delete the tags of a bucket. The bucket owner can allow other users to perform this operation by setting a bucket policy or granting them the permission.
The bucket storage quota must be a positive integer in the unit of byte. The maximum storage quota is 263 – 1 bytes. The default bucket storage quota is 0, indicating that the bucket storage quota is not limited.
+
For a bucket that has a specified storage quota, you can change the quota to 0 to cancel the quota limitation.
The bucket storage quota verification depends on how much space is used in the bucket. However, the used storage space is measured at the background. Therefore, bucket storage quotas may not take effect immediately, and delay is expected. It may occur that the used storage space in a bucket has exceeded the bucket storage quota, or the used storage space remains unchanged after data is deleted from the bucket.
If the used storage space in a bucket reaches the upper limit of the bucket storage quota, object upload will fail and the HTTP status code 403 Forbidden will be returned, indicating InsufficientStorageSpace. In this case, you can increase the quota, cancel the quota limitation (by changing the quota to 0), or delete unwanted objects from the bucket.
Only the bucket owner can query information about the bucket storage quota. However, an inactive owner is not allowed to get the bucket quota. The bucket storage quota is measured by byte. 0 indicates that no upper limit is set.
+
+
Request Syntax
1
+2
+3
+4
GET /?quota HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
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 bucket storage statistics is measured in the background, and the storage data is not updated in real time. Therefore, you are not advised to perform real-time verification on the storage information.
+
+
+
Request Syntax
1
+2
+3
+4
GET /?storageinfo HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request contains no parameters.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request contains no elements.
+
+
Response Syntax
1
+2
+3
+4
+5
+6
+7
+8
+9
HTTP/1.1 status_code
+Date: date
+Content-Type: type
+Content-Length: length
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<GetBucketStorageInfoResultxmlns="http://obs.region.example.com/doc/2015-06-30/">
+<Size>size</Size>
+<ObjectNumber>number</ObjectNumber>
+</GetBucketStorageInfoResult>
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response contains elements of information about the used storage capacity of a bucket. Table 1 describes the elements.
+
+
Table 1 Response elements
Element
+
+
Description
+
+
+
+
GetBucketStorageInfoResult
+
+
Request result that saves bucket storage information, including the stored data size and the number of objects
+
Type: XML
+
+
+
Size
+
+
Size of stored data
+
Type: integer
+
+
+
ObjectNumber
+
+
Number of objects returned
+
Type: integer
+
+
+
+
+
+
+
Error Responses
No special error responses are returned. For details about error responses, see Table 2.
OBS uses the PUT method to configure a custom domain name for a bucket. After the configuration is successful, you can access the bucket through the domain name.
+
Ensure that the custom domain name can correctly resolve to the OBS service through DNS.
+
+
Request Syntax
1
+2
+3
+4
+5
+6
+7
PUT /?customdomain=domainname HTTP/1.1
+User-Agent: curl/7.29.0
+Host: bucketname.obs.region.example.com
+Accept: */*
+Date: date
+Authorization: authorization string
+Content-Length: 0
+
+
+
+
Request Parameters
+
Table 1 Request parameters
Parameter
+
+
Description
+
+
Mandatory
+
+
+
+
customdomain
+
+
Custom domain name of a bucket.
+
Type: string, which must meet the naming convention of domain names.
+
Specifications: The value contains a maximum of 256 characters.
+
No default value.
+
Constraints: A bucket can have a maximum of 30 domain names. A custom domain name can be used for only one bucket.
+
+
Yes
+
+
+
+
+
+
+
Request Header
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request involves no elements.
+
+
Response Syntax
1
+2
+3
+4
+5
+6
HTTP/1.1 200 OK
+Server: OBS
+x-obs-request-id: request id
+x-obs-id-2: id
+Date: date
+Content-Length: 0
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
No special error responses are returned. For details about error responses, see Table 2.
OBS uses the PUT method to create or update the default server-side encryption for a bucket.
+
After encryption is enabled for a bucket, objects uploaded to the bucket are encrypted with the encryption configuration the bucket. Currently, it only supports the server-side encryption using keys hosted by KMS (SSE-KMS). For details about SSE-KMS, see Server-Side Encryption (SSE-KMS).
+
To perform this operation, you must have the permission to configure encryption for the bucket. By default, the bucket owner has this permission and can assign this permission to other users.
This request uses common headers. For details, see Table 3.
+
+
Request Elements
In this request, you need to carry the bucket encryption configuration in the request body. The bucket encryption configuration information is uploaded in the XML format. Table 1 lists the configuration elements.
+
+
Table 1 Configuration elements of bucket encryption
Header
+
+
Description
+
+
Mandatory
+
+
+
+
ServerSideEncryptionConfiguration
+
+
Root element of the default encryption configuration of a bucket.
+
Type: element
+
Ancestor: none
+
Children: Rule
+
+
Yes
+
+
+
Rule
+
+
Sub-element of the default encryption configuration of a bucket.
+
Type: element
+
Root element: ServerSideEncryptionConfiguration
+
Sub-element: ApplyServerSideEncryptionByDefault
+
+
Yes
+
+
+
ApplyServerSideEncryptionByDefault
+
+
Sub-element of the default encryption configuration of a bucket.
+
Type: element
+
Ancestor: Rule
+
Children: SSEAlgorithm, KMSMasterKeyID
+
+
Yes
+
+
+
SSEAlgorithm
+
+
Server-side encryption algorithm used for the default encryption configuration of a bucket.
+
Type: string
+
Valid values: kms
+
Root element: ApplyServerSideEncryptionByDefault
+
+
Yes
+
+
+
KMSMasterKeyID
+
+
Customer master key (CMK) used in SSE-KMS encryption mode. If you do not specify this header, the default master key will be used.
+
Type: string
+
Valid value formats are as follows:
+
regionID:domainID (account ID):key/key_id
key_id
+
In the preceding formats:
+
regionID indicates the ID of the region where the key resides.
domainID indicates the ID of the account to which the key belongs. For details about how to obtain the domain ID, see Obtaining the Domain ID and User ID.
key_id indicates the ID of the key created inKMS.
+
Root element: ApplyServerSideEncryptionByDefault
+
+
No
+
+
+
ProjectID
+
+
ID of the project to which the KMS master key belongs in the SSE-KMS mode.
+
Type: string
+
Valid values:
+
Project ID that matches KMSMasterKeyID.
If KMSMasterKeyID is not specified, do not set the project ID.
+
Ancestor: ApplyServerSideEncryptionByDefault
+
+
No
+
+
+
+
+
+
+
Response Syntax
1
+2
+3
HTTP/1.1 status_code
+Date: date
+Content-Length: length
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response contains no element.
+
+
Error Responses
No special error responses are returned. For details about error responses, see Table 2.
OBS uses the GET method to obtain the encryption configuration of a specified bucket.
+
To perform this operation, you must have the GetEncryptionConfiguration permission. By default, only the bucket owner can delete the tags of a bucket. The bucket owner can allow other users to perform this operation by setting a bucket policy or granting them the permission.
+
+
Request Syntax
1
+2
+3
+4
+5
+6
GET /?encryption HTTP/1.1
+User-Agent: curl/7.29.0
+Host: bucketname.obs.region.example.com
+Accept: */*
+Date: date
+Authorization: authorization string
+
+
+
+
Request parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response contains the following elements to detail bucket encryption configuration:
+
+
Table 1 Configuration elements of bucket encryption
Header
+
+
Description
+
+
+
+
ServerSideEncryptionConfiguration
+
+
Root element of the default encryption configuration of a bucket.
+
Type: element
+
Ancestor: none
+
Children: Rule
+
+
+
Rule
+
+
Sub-element of the default encryption configuration of a bucket.
+
Type: element
+
Ancestor: ServerSideEncryptionConfiguration
+
Children: ApplyServerSideEncryptionByDefault
+
+
+
ApplyServerSideEncryptionByDefault
+
+
Sub-element of the default encryption configuration of a bucket.
+
Type: element
+
Ancestor: Rule
+
Children: SSEAlgorithm, KMSMasterKeyID
+
+
+
SSEAlgorithm
+
+
The server-side encryption algorithm used for encryption configuration of a bucket.
+
Type: string
+
Valid values: kms
+
Ancestor: ApplyServerSideEncryptionByDefault
+
+
+
KMSMasterKeyID
+
+
ID of the customer master key (CMK) used for SSE-KMS.
+
Type: string
+
Ancestor: ApplyServerSideEncryptionByDefault
+
+
+
ProjectID
+
+
ID of the project to which the KMS master key belongs in the SSE-KMS mode.
+
Type: string
+
Ancestor: ApplyServerSideEncryptionByDefault
+
+
+
+
+
+
+
Error Responses
In addition common error codes, this API also returns other error codes. The following table lists common errors and possible causes. For details, see Table 2.
+
+
Table 2 Error codes related to getting bucket encryption configuration
Error Code
+
+
Description
+
+
HTTP Status Code
+
+
+
+
NoSuchEncryptionConfiguration
+
+
The specified bucket does not have any encryption configurations
+
+
404 Not Found
+
+
+
+
+
+
+
Sample Request
1
+2
+3
+4
+5
+6
GET /?encryption HTTP/1.1
+User-Agent: curl/7.29.0
+Host: examplebucket.obs.region.example.com
+Accept: */*
+Date: Thu, 21 Feb 2019 03:05:34 GMT
+Authorization: OBS H4IPJX0TQTHTHEBQQCEC:DpSAlmLX/BTdjxU5HOEwflhM0WI=
+
OBS uses the DELETE method to delete the encryption configuration of a specified bucket.
+
To perform this operation, you must have the PutEncryptionConfiguration permission. By default, only the bucket owner can delete the tags of a bucket. The bucket owner can allow other users to perform this operation by setting a bucket policy or granting them the permission.
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. This operation is applicable to:
+
Redirecting all requests to a website endpoint.
Adding routing rules that redirect specific requests.
+
You can perform this operation to create or update the website configuration of a bucket.
+
To perform this operation, you must have the PutBucketWebsite permission. By default, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.
+
Avoid using periods (.) in the destination bucket name. Otherwise, failures in client authentication certificate may occur when users use HTTPS for access.
+
The maximum size of a network configuration request for a bucket is 10 KB.
+
+
+
Request Syntax
1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
PUT /?website HTTP/1.1
+Host: bucketname.obs.region.example.com
+Content-Length: length
+Date: date
+Authorization: authorization
+<WebsiteConfiguration>
+ <RedirectAllRequestsTo>
+ <HostName>hostName</HostName>
+ </RedirectAllRequestsTo>
+</WebsiteConfiguration>
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request contains elements to specify the website configuration in XML format.
+
To redirect all website requests sent to the bucket's website endpoint, add the elements as described in Table 1.
+
Table 1 Elements for redirecting all website requests
Element
+
+
Description
+
+
Mandatory
+
+
+
+
WebsiteConfiguration
+
+
Root node configured on the website
+
Type: element
+
Ancestor: none
+
+
Yes
+
+
+
RedirectAllRequestsTo
+
+
Describes the redirection behavior for every request to this bucket's website endpoint. If this element is present, no other siblings are allowed.
+
Type: element
+
Ancestor: WebsiteConfiguration
+
+
Yes
+
+
+
HostName
+
+
Name of the host where requests will be redirected
+
Type: string
+
Ancestor: RedirectAllRequestsTo
+
+
Yes
+
+
+
Protocol
+
+
The HTTP or HTTPS protocol used in redirecting requests. The default protocol is HTTP.
+
Type: string
+
Ancestor: RedirectAllRequestsTo
+
+
No
+
+
+
+
+
+
+
To configure redirection rules, add the elements as described in Table 2.
+
Table 2 Elements for adding rules that redirect requests
Element
+
+
Description
+
+
Mandatory
+
+
+
+
WebsiteConfiguration
+
+
Root element for the website configuration
+
Type: element
+
Ancestor: none
+
+
Yes
+
+
+
IndexDocument
+
+
Suff element
+
Type: element
+
Ancestor: WebsiteConfiguration
+
+
Yes
+
+
+
Suffix
+
+
Suffix that is appended to a request initiated for a directory on the website endpoint. For example, if the suffix is index.html and you request for samplebucket/images/, the data that is returned will be for the object with the key name images/index.html in the samplebucket bucket. Suffix cannot be empty or contain slashes (/).
+
Type: string
+
Ancestor: IndexDocument
+
+
Yes
+
+
+
ErrorDocument
+
+
Key element
+
Type: element
+
Ancestor: WebsiteConfiguration
+
+
No
+
+
+
Key
+
+
Object key that is used when a 4XX error occurs. This element identifies the page that is returned when a 4XX error occurs.
+
Type: string
+
Ancestor: ErrorDocument
+
Condition: Required when ErrorDocument is specified.
+
+
No
+
+
+
RoutingRules
+
+
Routing element
+
Type: element
+
Ancestor: WebsiteConfiguration
+
+
No
+
+
+
RoutingRule
+
+
Element of a redirection rule. A redirection rule contains a Condition and a Redirect. When the Condition is matched, Redirect takes effect.
+
Type: element
+
Ancestor: RoutingRules
+
At least the RoutingRule element is required.
+
+
Yes
+
+
+
Condition
+
+
Element for describing a condition that must be met for the specified redirection to apply.
+
Type: element
+
Ancestor: RoutingRule
+
+
No
+
+
+
KeyPrefixEquals
+
+
Object key name prefix when the redirection is applied.
+
Example:
+
To redirect the request for object ExamplePage.html, the KeyPrefixEquals is set to ExamplePage.html.
+
Type: string
+
Ancestor: Condition
+
Condition: Required when the ancestor element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If two conditions are specified, both conditions must be true for the Redirect to be applied.
+
+
No
+
+
+
HttpErrorCodeReturnedEquals
+
+
HTTP error code returned after the Redirect has taken effect. The specified Redirect is applied only when the error code returned equals this value.
+
Example:
+
If you want to redirect requests to NotFound.html when HTTP error code 404 is returned, set HttpErrorCodeReturnedEquals to 404 in Condition, and set ReplaceKeyWith to NotFound.html in Redirect.
+
Type: string
+
Ancestor: Condition
+
Condition: Required when ancestor element Condition is specified and sibling KeyPrefixEquals is not specified. If multiple conditions are specified, the Redirect takes effect only after all conditions are met.
+
+
No
+
+
+
Redirect
+
+
Element for redirection information. You can redirect requests to another host, to another web page, or with another protocol. You can specify an error code to be returned after an error.
+
Type: element
+
Ancestor: RoutingRule
+
+
Yes
+
+
+
Protocol
+
+
Protocol used in the redirection request
+
Type: string
+
Ancestor: Redirect
+
Value options: http, https
+
Condition: Not required if one of the siblings is present.
+
+
No
+
+
+
HostName
+
+
Host name used in the redirection request.
+
Type: string
+
Ancestor: Redirect
+
Condition: Not required if one of the siblings is present.
+
+
No
+
+
+
ReplaceKeyPrefixWith
+
+
Object key prefix used in the redirection request.
+
Example:
+
To redirect all requests for (objects under) docs to (objects under) documents, set KeyPrefixEquals to docs in Condition and ReplaceKeyPrefixWith to documents in Redirect.
+
Type: string
+
Ancestor: Redirect
+
Condition: Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.
+
+
No
+
+
+
ReplaceKeyWith
+
+
Object key used in the redirection request. For example, redirect requests to error.html.
+
Type: string
+
Ancestor: Redirect
+
Condition: Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.
+
+
No
+
+
+
HttpRedirectCode
+
+
HTTP status code returned after the redirection request
+
Type: string
+
Ancestor: Redirect
+
Condition: Not required if one of the siblings is present.
+
+
No
+
+
+
+
+
+
+
+
Response Syntax
1
+2
+3
HTTP/1.1 status_code
+Date: date
+Content-Length: length
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response contains no element.
+
+
Error Responses
No special error responses are returned. For details about error responses, see Table 2.
Obtaining the Static Website Hosting Configuration of a Bucket
+
Functions
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 default, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.
+
+
Request Syntax
1
+2
+3
+4
GET /?website HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
Deleting the Static Website Hosting Configuration of a Bucket
+
Functions
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, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.
+
+
Request Syntax
1
+2
+3
+4
DELETE /?website HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request involves no elements.
+
+
Response Syntax
1
+2
+3
+4
HTTP/1.1 status_code
+Date: date
+Content-Type: type
+Content-Length: length
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
No special error responses are returned. For details about error responses, see Table 2.
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 page requests, the scripts and contents at one website cannot interact with those at another website due to the existence of the Same Origin Policy (SOP).
+
OBS allows buckets to store static web resources. The buckets of OBS can serve as website resources if the buckets are properly used (for details, see Configuring Static Website Hosting for a Bucket). A website in OBS can respond to requests of another websites only after CORS is properly configured.
+
Typical application scenarios are as follows:
+
With the support of CORS, you can use JavaScript and HTML5 to construct web applications and directly access the resources in OBS without the need to use proxy servers for transfer.
You can enable the dragging function of HTML 5 to directly upload files to the OBS (with the upload progress displayed) or update the OBS contents using web applications.
Hosts external web pages, style sheets, and HTML 5 applications in different origins. Web fonts or pictures on OBS can be shared by multiple websites.
+
To perform this operation, you must have the PutBucketCORS permission. By default, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.
This request uses common headers and CORS request headers. For details, see Table 3 and Table 1.
+
+
Table 1 CORS request header
Header
+
+
Description
+
+
Mandatory
+
+
+
+
Content-MD5
+
+
Base64-encoded 128-bit MD5 digest of the message according to RFC 1864
+
Type: string
+
Example: n58IG6hfM7vqI4K0vnWpog==
+
+
Yes
+
+
+
+
+
+
+
Request Elements
In this request, you must configure the CORS of buckets in the request body. The lifecycle configuration is specified as XML with elements described in Table 2.
+
+
Table 2 CORS configuration elements
Element
+
+
Description
+
+
Mandatory
+
+
+
+
CORSConfiguration
+
+
Root node of CORSRule and its capacity cannot exceed 64 KB.
+
Type: Container
+
Ancestor: none
+
+
Yes
+
+
+
CORSRule
+
+
CORS rules. CORSConfiguration can contain a maximum of 100 rules.
+
Type: Container
+
Ancestor: CORSConfiguration
+
+
Yes
+
+
+
ID
+
+
Unique identifier of a rule. The value can contain a maximum of 255 characters.
+
Type: string
+
Ancestor: CORSRule
+
+
No
+
+
+
AllowedMethod
+
+
Method allowed by a CORS rule
+
Type: string
+
Possible values are GET, PUT, HEAD, POST, and DELETE.
+
Ancestor: CORSRule
+
+
Yes
+
+
+
AllowedOrigin
+
+
An origin that is allowed by a CORS rule. It is a character string and can contain a wildcard (*), and allows one wildcard character (*) at most.
+
Type: string
+
Ancestor: CORSRule
+
+
Yes
+
+
+
AllowedHeader
+
+
Headers that are allowed in a PutBucketCORS request via the Access-Control-Request-Headers header. If a request contains Access-Control-Request- Headers, only a CORS request that matches the configuration of AllowedHeader is considered as a valid request. Each AllowedHeader can contain at most one wildcard (*) and cannot contain spaces.
+
Type: string
+
Ancestor: CORSRule
+
+
No
+
+
+
MaxAgeSeconds
+
+
Indicates the response time of CORS that can be cached by a client. It is expressed in seconds.
+
Each CORSRule can contain only one MaxAgeSeconds. It can be set to a negative value.
+
Type: Integer
+
Ancestor: CORSRule
+
+
No
+
+
+
ExposeHeader
+
+
An additional header in CORS responses. The header provides additional information for clients. It cannot contain spaces.
+
Type: string
+
Ancestor: CORSRule
+
+
No
+
+
+
+
+
+
+
Response Syntax
1
+2
+3
+4
HTTP/1.1 status_code
+
+Date: date
+Content-Length: length
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response contains no element.
+
+
Error Responses
No special error responses are returned. For details about error responses, see Table 2.
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 default, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.
+
+
Request Syntax
1
+2
+3
+4
GET /?cors HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response contains elements to detail the configuration. Table 1 describes the elements.
+
+
Table 1 CORS configuration elements
Element
+
+
Description
+
+
+
+
CORSConfiguration
+
+
Root node of CORSRules and its capacity cannot exceed 64 KB.
+
Type: Container
+
Ancestor: none
+
+
+
CORSRule
+
+
CORS rule. CORSConfiguration can contain a maximum of 100 rules.
+
Type: Container
+
Ancestor: CORSConfiguration
+
+
+
ID
+
+
Unique identifier of a rule. The value can contain a maximum of 255 characters.
+
Type: string
+
Ancestor: CORSRule
+
+
+
AllowedMethod
+
+
Method allowed by a CORS rule.
+
Type: string
+
Possible values are GET, PUT, HEAD, POST, and DELETE.
+
Ancestor: CORSRule
+
+
+
AllowedOrigin
+
+
Indicates an origin that is allowed by a CORS rule. It is a character string and can contain a wildcard (*), and allows one wildcard character (*) at most.
+
Type: string
+
Ancestor: CORSRule
+
+
+
AllowedHeader
+
+
Indicates which headers are allowed in a PUT Bucket CORS request via the Access-Control-Request-Headers header. If a request contains Access-Control-Request- Headers, only a CORS request that matches the configuration of AllowedHeader is considered as a valid request. Each AllowedHeader can contain at most one wildcard (*) and cannot contain spaces.
+
Type: string
+
Ancestor: CORSRule
+
+
+
MaxAgeSeconds
+
+
Response time of CORS that can be cached by a client. It is expressed in seconds.
+
Each CORSRule can contain only one MaxAgeSeconds. It can be set to a negative value.
+
Type: Integer
+
Ancestor: CORSRule
+
+
+
ExposeHeader
+
+
Indicates a supplemented header in CORS responses. The header provides additional information for clients. It cannot contain spaces.
+
Type: string
+
Ancestor: CORSRule
+
+
+
+
+
+
+
Error Responses
Table 2 describes possible special errors in this request.
+
+
Table 2 Special error
Error Code
+
+
Description
+
+
HTTP Status Code
+
+
+
+
NoSuchCORSConfiguration
+
+
Indicates that the CORS configuration of buckets does not exist.
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 from other websites.
+
To perform this operation, you must have the PutBucketCORS permission.
+
+
Request Syntax
1
+2
+3
+4
DELETE /?cors HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request involves no elements.
+
+
Response Syntax
1
+2
+3
+4
HTTP/1.1 status_code
+Date: date
+Content-Type: application/xml
+Content-Length: length
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
No special error responses are returned. For details about error responses, see Table 2.
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 servers. Only after a pre-request is returned successfully, clients start to execute the follow-up requests.
+
The OBS allows buckets to store static web resources. OBS buckets can serve as website resources if the buckets are properly used. In this scenario, buckets in the OBS serve as servers to process OPTIONS pre-requests from clients.
+
OBS can process OPTIONS pre-requests only after CORS is configured for buckets in OBS. For details about CORS, see Configuring Bucket CORS.
+
+
Differences Between OPTIONS Bucket and OPTIONS Object
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 uses the bucket domain name as the URL. The request lines of the two methods are as follows:
When CORS and OPTIONS are configured for a bucket, no origin header is added.
+
+
400 BadRequest
+
+
+
AccessForbidden
+
+
CORSResponse: This CORS request is not allowed. This is usually because the evaluation of Origin, request method / Access-Control-Request-Method or Access-Control-Request-Headers are not whitelisted by the resource's CORS specification.
+
When CORS and OPTIONS are configured for a bucket, origin, method, and headers do not match any rule.
Differences Between OPTIONS Bucket and OPTIONS Object
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 uses the bucket domain name as the URL. The request lines of the two methods are as follows:
When CORS and OPTIONS are configured for a bucket, no origin header is added.
+
+
400 BadRequest
+
+
+
AccessForbidden
+
+
CORSResponse: This CORS request is not allowed. This is usually because the evaluation of Origin, request method/Access-Control-Request-Method or Access-Control-Request-Headers are not whitelisted by the resource's CORS spec.
+
When CORS and OPTIONS are configured for a bucket, origin, method, and headers do not match any rule.
After bucket creation in OBS, you can use this operation to upload an object to the bucket. Uploading an object adds it to a bucket. This requires users to have the write operation.
+
The name of each object in a bucket must be unique.
+
+
With versioning not enabled, if an object to be uploaded has the same name as an existing object in the bucket, the newly uploaded object will overwrite the existing one. To protect data from being corrupted during transmission, you can add the Content-MD5 parameter in the request header. After receiving the request, OBS will perform an MD5 consistency check. If the two MD5 values are inconsistent, the system returns an error message.
+
You can also specify the value of the x-obs-acl parameter to configure an access control policy for the object. If the x-obs-acl parameter is not specified when an anonymous user uploads an object, the object can be accessed by all OBS users by default.
+
This operation supports server-side encryption.
+
For a single upload, the size of the object to be uploaded ranges [0, 5 GB]. To upload a file greater than 5 GB, see Operations on Multipart Upload.
+
OBS does not have real folders. To facilitate data management, OBS provides a method to simulate a folder by adding a slash (/) to the object name, for example, test/123.jpg. You can simulate test as a folder and 123.jpg as the name of a file under the test folder. However, the object key remains test/123.jpg. Objects named in this format appear as folders on the console.
+
+
Differences Between PUT and POST Methods
Parameters are passed through the request header if the PUT method is used to upload objects; if the POST method is used to upload objects, parameters are passed through the form field in the message body.
+
With the PUT method, you need to specify the object name in the URL, but object name is not required with the POST method, which uses the bucket domain name as the URL. The request lines of the two methods are as follows:
If versioning is enabled for a bucket, the system automatically generates a unique version ID for the requested object in this bucket and returns the version ID in response header x-obs-version-id. If versioning is suspended for the bucket, the object version ID is null. For details about the versioning statuses of a bucket, see Configuring Versioning for a Bucket.
+
+
Request Syntax
1
+2
+3
+4
+5
+6
+7
+8
PUT /ObjectName HTTP/1.1
+Host: bucketname.obs.region.example.com
+Content-Type: application/xml
+Content-Length: length
+Authorization: authorization
+Date: date
+<OptionalAdditionalHeader>
+<objectContent>
+
+
+
+
Request Parameters
This request contains no parameter.
+
+
Request Headers
This request uses common headers. For details, see Table 3. The request can use additional headers, as listed in Table 1.
+
OBS supports the six HTTP request headers: Cache-Control, Expires, Content-Encoding, Content-Disposition, Content-Type, and Content-Language. If these headers are carried in an object upload request, their values are saved. You can also call the metadata modification API, provided by OBS, to change the values of the six headers. When the object is downloaded or queried, the saved values are set for corresponding HTTP headers and returned to the client.
+
+
+
Table 1 Request headers
Header
+
+
Description
+
+
Mandatory
+
+
+
+
Content-MD5
+
+
Base64-encoded 128-bit MD5 digest of the message according to RFC 1864.
+
Type: string
+
Example: n58IG6hfM7vqI4K0vnWpog==
+
+
No
+
+
+
x-obs-acl
+
+
This header can be added to set access control policies for objects when creating the objects. The access control policies are the predefined common policies, including private, public-read, public-read-write.
+
Type: string
+
Note: This header is a predefined policy expressed in a character string.
+
Example: x-obs-acl: public-read
+
+
No
+
+
+
x-obs-grant-read
+
+
When creating an object, you can use this header to authorize all users in an account the permission to read objects and obtain object metadata.
+
Type: string
+
Example: x-obs-grant-read: id=domainID. If multiple accounts are authorized, separate them with commas (,).
+
+
No
+
+
+
x-obs-grant-read-acp
+
+
When creating an object, you can use this header to authorize all users in an account the permission to obtain the object ACL.
+
Type: string
+
Example: x-obs-grant-read-acp: id=domainID. If multiple accounts are authorized, separate them with commas (,).
+
+
No
+
+
+
x-obs-grant-write-acp
+
+
When creating an object, you can use this header to authorize all users in an account the permission to write the object ACL.
+
Type: string
+
Example: x-obs-grant-write-acp: id=domainID. If multiple accounts are authorized, separate them with commas (,).
+
+
No
+
+
+
x-obs-grant-full-control
+
+
When creating an object, you can use this header to authorize all users in an account the permission to read the object, obtain the object metadata, obtain the object ACL, and write the object ACL.
+
Type: string
+
Example: x-obs-grant-full-control: id=domainID. If multiple accounts are authorized, separate them with commas (,).
+
+
No
+
+
+
x-obs-storage-class
+
+
When creating an object, you can use this header to specify the storage class for the object. If you do not use this header, the object storage class is the default storage class of the bucket.
+
Type: string
+
Note: There are three storage classes: STANDARD (Standard storage class), WARM (Warm storage class), and COLD (Cold storage class). Therefore, this parameter value can be STANDARD, WARM, or COLD. These values are case sensitive.
+
Example: x-obs-storage-class: STANDARD
+
+
No
+
+
+
x-obs-meta-*
+
+
When creating an object, you can use a header starting with x-obs-meta- to define object metadata in an HTTP request. Custom metadata will be returned in the response header when you retrieve or query the metadata of the object.
+
Type: string
+
Example: x-obs-meta-test: test metadata
+
+
No
+
+
+
x-obs-website-redirect-location
+
+
If a bucket is configured with the static website hosting function, it will redirect requests for this object to another object in the same bucket or to an external URL. OBS stores the value of this header in the object metadata.
+
In the following example, the request header sets the redirection to an object (anotherPage.html) in the same bucket:
+
x-obs-website-redirect-location:/anotherPage.html
+
In the following example, the request header sets the object redirection to an external URL:
Constraint: The value must be prefixed by a slash (/), http://, or https://. The length of the value cannot exceed 2 KB.
+
+
No
+
+
+
x-obs-server-side-encryption
+
+
Indicates that SSE-KMS is used.
+
Type: string
+
Example: x-obs-server-side-encryption: kms
+
+
No. This header is required when SSE-KMS is used.
+
+
+
x-obs-server-side-encryption-kms-key-id
+
+
Master key ID. This header is used in SSE-KMS mode. If the customer does not provide the master key ID, the default master key ID will be used.
+
Type: string
+
The following two formats are supported:
+
1. regionID:domainID:key/key_id
+
2. key_id
+
regionID is the ID of the region to which the key belongs. domainID is the account ID of the tenant to which the key belongs. key_id is the key ID created in KMS.
Constraint: This header is a Base64-encoded 256-bit key and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key-MD5.
+
+
No. This header is required when SSE-C is used.
+
+
+
x-obs-server-side-encryption-customer-key-MD5
+
+
Indicates the MD5 value of a key used to encrypt objects. The header is used in SSE-C mode. The MD5 value is used to check whether any error occurs during the transmission of the key.
Constraint: This header is a Base64-encoded 128-bit MD5 value and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key.
+
+
No. This header is required when SSE-C is used.
+
+
+
success-action-redirect
+
+
Indicates the address (URL) to which a successfully responded request is redirected.
+
If the value is valid and the request is successful, OBS returns status code 303. Location contains success_action_redirect as well as the bucket name, object name, and object ETag.
If this parameter is invalid, OBS ignores this parameter. The response code is 204, and the Location is the object address.
+
Type: string
+
+
No
+
+
+
x-obs-expires
+
+
Indicates the expiration time of an object, in days. An object will be automatically deleted once it expires (calculated from the last modification time of the object).
+
This field can be configured only when an object is uploaded and cannot be modified through the metadata modification API.
+
Type: integer
+
Example: x-obs-expires:3
+
+
No
+
+
+
+
+
+
+
Request Elements
This request contains no elements. Its body contains only the content of the requested object.
+
+
Response Syntax
1
+2
+3
HTTP/1.1 status_code
+Content-Length: length
+Content-Type: type
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
In addition to the common response headers, the following message headers may also be used. For details, see Table 2.
+
+
Table 2 Additional response header parameters
Header
+
+
Description
+
+
+
+
x-obs-version-id
+
+
Object version ID. If versioning is enabled for the bucket, the object version ID will be returned.
+
Type: string
+
+
+
x-obs-server-side-encryption
+
+
This header is included in a response if SSE-KMS is used.
+
Type: string
+
Example: x-obs-server-side-encryption:kms
+
+
+
x-obs-server-side-encryption-kms-key-id
+
+
Indicates the master key ID. This header is included in a response if SSE-KMS is used.
+
Type: string
+
Format: regionID:domainID:key/key_id
+
regionID is the ID of the region to which the key belongs. domainID is the account ID of the tenant to which the key belongs. key_id is the key ID used in this encryption.
Uploading an object adds it to a bucket. This requires users to have the write operation.
+
The name of each object in a bucket must be unique.
+
+
With versioning not enabled, if an object to be uploaded has the same name as an existing object in the bucket, the newly uploaded object will overwrite the existing one. To protect data from being corrupted during transmission, you can add the Content-MD5 parameter in the form field. After receiving the request, OBS will perform an MD5 consistency check. If the two MD5 values are inconsistent, the system returns an error message. You can also specify the value of the x-obs-acl parameter to configure an access control policy for the object.
+
You can also upload an object using the POST method.
+
For a single upload, the size of the object to be uploaded ranges [0, 5 GB]. To upload a file greater than 5 GB, see Operations on Multipart Upload.
+
This operation supports server-side encryption.
+
+
Differences Between PUT and POST Methods
Parameters are passed through the request header if the PUT method is used to upload objects; if the POST method is used to upload objects, parameters are passed through the form field in the message body.
+
With the PUT method, you need to specify the object name in the URL, but object name is not required with the POST method, which uses the bucket domain name as the URL. The request lines of the two methods are as follows:
If versioning is enabled for a bucket, the system automatically generates a unique version ID for the requested object in this bucket and returns the version ID in response header x-obs-version-id. If versioning is suspended for a bucket, the version ID of the requested object in this bucket is null. For details about the versioning statuses of a bucket, see Configuring Versioning for a Bucket.
This request uses common headers. For details, see Table 3.
+
If you want to get CORS configuration information, you must use the headers in Table 1.
+
+
Table 1 Request headers for obtaining CORS configuration
Header
+
+
Description
+
+
Mandatory
+
+
+
+
Origin
+
+
Origin of the cross-domain request specified by the pre-request. Generally, it is a domain name.
+
Type: string
+
+
Yes
+
+
+
Access-Control-Request-Headers
+
+
Indicates the HTTP headers of a request. The request can use multiple HTTP headers.
+
Type: string
+
+
No
+
+
+
+
+
+
+
Request Elements
This request uses form elements. Table 2 describes the form elements.
+
+
Table 2 Form elements
Parameter
+
+
Description
+
+
Mandatory
+
+
+
+
file
+
+
Indicates the content of the object to be uploaded.
+
Type: binary content or text
+
Constraint: This parameter must be the last parameter in a form. Otherwise, parameters after this parameter will be all discarded. Additionally, each request contains only one file parameter.
+
+
Yes
+
+
+
key
+
+
Indicates the name of the object to be created.
+
Type: string
+
+
Yes
+
+
+
AccessKeyId
+
+
Access key ID (AK) of the requester.
+
Type: string
+
Constraint: This parameter is mandatory if there is security policy parameter policy or signature in the request.
Constraint: This parameter is mandatory if the bucket provides the AccessKeyId (or signature).
+
+
Yes when the constraint is met.
+
+
+
signature
+
+
Indicates a signature string calculated based on StringToSign.
+
Type: string
+
Constraint: This parameter is mandatory if the bucket provides the AccessKeyId (or policy).
+
+
Yes when the constraint is met.
+
+
+
token
+
+
Specifies the AK, signature, and security policy of the request initiator. The priority of a token is higher than that of a specified AK, the request signature, and the security policy of the request initiator.
+
Type: string
+
Example:
+
In HTML: <input type= "text" name="token" value="ak:signature:policy" />
+
+
No
+
+
+
x-obs-acl
+
+
When creating an object, you can add this message header to set the permission control policy for the object. The predefined common policies are as follows: private, public-read, public-read-write, public-read-delivered, and public-read-write-delivered.
+
Type: string
+
An example is provided as follows:
+
In POLICY: {"acl": "public-read" }
+
In HTML: <input type="text" name="acl" value="public-read" />
+
+
No
+
+
+
x-obs-grant-read
+
+
When creating an object, you can use this header to authorize all users in an account the permission to read objects and obtain object metadata.
+
Type: string
+
An example is provided as follows:
+
In POLICY: {'grant-read': 'id=domainId1' },
+
In HTML: <input type="text" name="grant-read" value="id=domainId1" />
+
+
No
+
+
+
x-obs-grant-read-acp
+
+
When creating an object, you can use this header to authorize all users in an account the permission to obtain the object ACL.
+
Type: string
+
An example is provided as follows:
+
In POLICY: {"grant-read-acp": "id=domainId1" },
+
In HTML: <input type="text" name="grant-read-acp" value="id=domainId1" />
+
+
No
+
+
+
x-obs-grant-write-acp
+
+
When creating an object, you can use this header to authorize all users in an account the permission to write the object ACL.
+
Type: string
+
An example is provided as follows:
+
In POLICY: {"grant-write-acp": "id=domainId1" },
+
In HTML: <input type="text" name="grant-write-acp" value="id=domainId1" />
+
+
No
+
+
+
x-obs-grant-full-control
+
+
When creating an object, you can use this header to authorize all users in an account the permission to read the object, obtain the object metadata, obtain the object ACL, and write the object ACL.
+
Type: string
+
An example is provided as follows:
+
In POLICY: {"grant-full-control": "id=domainId1" },
+
In HTML: <input type="text" name="grant-full-control" value="id=domainId1" />
+
+
No
+
+
+
x-obs-storage-class
+
+
When creating an object, you can use this header to specify the storage class for the object. If you do not use this header, the object storage class is the default storage class of the bucket.
+
Type: string
+
Note: There are three storage classes: STANDARD (Standard storage class), WARM (Warm storage class), and COLD (Cold storage class). Therefore, this parameter value can be STANDARD, WARM, or COLD. These values are case sensitive.
+
An example is provided as follows:
+
In POLICY: {"storage-class": "STANDARD" },
+
In HTML: <input type="text" name="x-obs-storage-class" value="STANDARD" />
+
+
No
+
+
+
Cache-Control,
+
Content-Type,
+
Content-Disposition,
+
Content-Encoding
+
Expires
+
+
Standard HTTP headers. OBS records those headers. If you download the object or send the HEAD Object request, those parameter values are returned.
+
Type: string
+
An example is provided as follows:
+
In POLICY: ["starts-with", "$Content-Type", "text/"],
+
In HTML: <input type="text" name="content-type" value="text/plain" />
+
+
No
+
+
+
success_action_redirect
+
+
Indicates the address (URL) to which a successfully responded request is redirected.
+
If the value is valid and the request is successful, OBS returns status code 303. Location contains success_action_redirect as well as the bucket name, object name, and object ETag.
If this parameter is invalid, OBS ignores this parameter. The response code is 204, and the Location is the object address.
+
Type: string.
+
An example is provided as follows:
+
In POLICY: {"success_action_redirect": "http://123458.com"},
+
In HTML: <input type="text" name="success_action_redirect" value="http://123458.com" />
+
+
No
+
+
+
x-obs-meta-*
+
+
Indicates user-defined metadata. When creating an object, you can use this header or a header starting with x-obs-meta- to define object metadata in an HTTP request. Custom metadata will be returned in the response header when you retrieve or query the metadata of the object.
+
Type: string
+
An example is provided as follows:
+
In POLICY: {" x-obs-meta-test ": " test metadata " },
+
In HTML: <input type="text" name=" x-obs-meta-test " value=" test metadata " />
+
+
No
+
+
+
success_action_status
+
+
Indicates the status code returned after the request is successfully received. Possible values are 200, 201, and 204.
+
If this parameter is set to 200 or 204, the body in the OBS response message is empty.
If this parameter is set to 201, the OBS response message contains an XML document that describes the response to the request.
If the value is not set or if it is set to an invalid value, the OBS returns an empty document with a 204 status code.
+
Type: string
+
An example is provided as follows:
+
In POLICY: ["starts-with", "$success_action_status", ""],
+
In HTML: <input type="text" name="success_action_status" value="200" />
+
+
No
+
+
+
x-obs-website-redirect-location
+
+
If a bucket is configured with the static website hosting function, it will redirect requests for this object to another object in the same bucket or to an external URL. OBS stores the value of this header in the object metadata.
+
Default value: none
+
Constraint: The value must be prefixed by a slash (/), http://, or https://. The length of the value cannot exceed 2 KB.
+
+
No
+
+
+
x-obs-server-side-encryption
+
+
Indicates that SSE-KMS is used.
+
Type: string
+
Example: x-obs-server-side-encryption:kms
+
+
No. This header is required when SSE-KMS is used.
+
+
+
x-obs-server-side-encryption-kms-key-id
+
+
Master key ID. This header is used in SSE-KMS mode. If the customer does not provide the master key ID, the default master key ID will be used.
+
Type: string
+
The following two formats are supported:
+
1. regionID:domainID:key/key_id
+
2. key_id
+
regionID is the ID of the region to which the key belongs. domainID is the account ID of the tenant to which the key belongs. key_id is the key ID created in KMS.
Constraint: This header is a Base64-encoded 256-bit key and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key-MD5.
+
+
No. This header is required when SSE-C is used.
+
+
+
x-obs-server-side-encryption-customer-key-MD5
+
+
Indicates the MD5 value of a key used to encrypt objects. The header is used in SSE-C mode. The MD5 value is used to check whether any error occurs during the transmission of the key.
Constraint: This header is a Base64-encoded 128-bit MD5 value and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key.
+
+
No. This header is required when SSE-C is used.
+
+
+
x-obs-expires
+
+
Indicates the expiration time of an object, in days. An object will be automatically deleted once it expires (calculated from the last modification time of the object).
The response to the request uses common headers. For details, see Table 1.
+
In addition to the common response headers, the following message headers may also be used. For details, see Table 3.
+
+
Table 3 Additional response header parameters
Header
+
+
Description
+
+
+
+
x-obs-version-id
+
+
Object version ID. If versioning is enabled for the bucket, the object version ID will be returned. A string null will be returned if the bucket housing the object has versioning suspended.
+
Type: string
+
+
+
Access-Control-Allow-Origin
+
+
Indicates that the origin is included in the response if the origin in the request meets the CORS configuration requirements when CORS is configured for buckets.
+
Type: string
+
+
+
Access-Control-Allow-Headers
+
+
Indicates that the headers are included in the response if headers in the request meet the CORS configuration requirements when CORS is configured for buckets.
+
Type: string
+
+
+
Access-Control-Max-Age
+
+
Indicates MaxAgeSeconds in the CORS configuration of the server when CORS is configured for buckets.
+
Type: integer
+
+
+
Access-Control-Allow-Methods
+
+
Indicates that methods in the rule are included in the response if Access-Control-Request-Method in the request meets the CORS configuration requirements when CORS is configured for buckets.
+
Type: string
+
Possible values are GET, PUT, HEAD, POST, and DELETE.
+
+
+
Access-Control-Expose-Headers
+
+
Value of ExposeHeader in the CORS configuration of a server when CORS is configured for buckets.
+
Type: string
+
+
+
x-obs-server-side-encryption
+
+
This header is included in a response if SSE-KMS is used.
+
Type: string
+
Example: x-obs-server-side-encryption:kms
+
+
+
x-obs-server-side-encryption-kms-key-id
+
+
Indicates the master key ID. This header is included in a response if SSE-KMS is used.
+
Type: string
+
Format: regionID:domainID:key/key_id
+
regionID is the ID of the region to which the key belongs. domainID is the account ID of the tenant to which the key belongs. key_id is the key ID used in this encryption.
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 (by default) or replace the metadata of the target object with the metadata contained in the request. The ACL of the source object is not copied to the target object. By default, the ACL of the target object is private. You can set an ACL for the target object by sending an API request.
+
The request for copying an object needs to carry the information about the bucket and object to be copied in the header field. The message body cannot be carried.
+
This operation supports server-side encryption.
+
The target object size range is [0, 5 GB]. If the source object size exceeds 5 GB, you can only copy some objects using the Range API.
+
+
Versioning
By default, x-obs-copy-source specifies the latest version of the source object. If the latest version of the source object has a deletion marker, the object is considered to have been deleted. You can add versionId to request header x-obs-copy-source to copy an object with the specified version ID.
+
If a bucket has versioning enabled, the system automatically generates a unique version ID for the requested object in this bucket and returns the version ID in response header x-obs-version-id. If versioning is suspended for the bucket, the object version ID is null.
+
When the bucket versioning status is disabled, if you make a copy of object_A and save it as object_B, and an object named as object_B already exists, the new object_B will overwrite the existing one. After the copying is executed successfully, only new object_B can be downloaded because old object_B has been deleted. Therefore, before copying an object, ensure that there is no object with the same name as the object copy to prevent data from being deleted mistakenly. During the copying, object_A has no changes.
+
+
You cannot determine whether a request is executed successfully only using status_code in the header returned by HTTP. If 200 in status_code is returned, the server has received the request and starts to process the request. The body in the response shows whether the copy succeeds. If the body contains ETag, the copy succeeds. Otherwise, the copy failed.
+
+
OBS Cold Objects
If source objects are OBS Cold objects, check the restore status of the objects. You can copy these objects only after they are restored. If the source object is not retrieved or is being retrieved, the copying fails and error 403 Forbidden is returned. The fault is described as follows:
+
ErrorCode: InvalidObjectState
+
ErrorMessage: Operation is not valid for the source object's storage class
You can add optional headers to specify the object to be copied. Table 3 describes the optional headers.
+
+
Table 1 Request headers
Header
+
+
Description
+
+
Mandatory
+
+
+
+
x-obs-acl
+
+
This header can be added to set access control policies for objects when copying the objects. The access control policies are the predefined common policies, including private, public-read, public-read-write.
+
Type: string
+
Example: x-obs-acl: acl
+
+
No
+
+
+
x-obs-grant-read
+
+
When creating an object, you can use this header to authorize all users in an account the permission to read objects and obtain object metadata.
+
Type: string
+
+
No
+
+
+
x-obs-grant-read-acp
+
+
When creating an object, you can use this header to authorize all users in an account the permission to obtain the object ACL.
+
Type: string
+
+
No
+
+
+
x-obs-grant-write-acp
+
+
When creating an object, you can use this header to authorize all users in an account the permission to write the object ACL.
+
Type: string
+
+
No
+
+
+
x-obs-grant-full-control
+
+
When creating an object, you can use this header to authorize all users in an account the permission to read the object, obtain the object metadata, obtain the object ACL, and write the object ACL.
+
Type: string
+
+
No
+
+
+
x-obs-copy-source
+
+
Indicates names of the source bucket and the source object. If the source object has multiple versions, the versionId parameter can be used to specify the desired version.
+
Type: string
+
Constraint: URL encoding is required for handling Chinese characters.
Constraints: Values other than COPY or REPLACE result in an immediate 400-based error response. If you need to modify the metadata (the same for both the source and target objects), this parameter must be set to REPLACE, otherwise, the request is invalid and the server returns a 400 HTTP status code error. This parameter cannot be used to change an encrypted object to a non-encrypted object (the same for both the source and target objects). If you use this parameter to change the encrypted object, the system returns 400.
+
+
No
+
+
+
x-obs-copy-source-if-match
+
+
Copies the source object only if its ETag matches the one specified by this header. Otherwise, a 412 HTTP status code error (failed precondition) is returned.
+
Type: string
+
Example: x-obs-copy-source-if-match: etag
+
Constraint: This parameter can be used with x-obs-copy-source-if-unmodified-since but not other conditional copy parameters.
+
+
No
+
+
+
x-obs-copy-source-if-none-match
+
+
Copies the object only if its ETag does not match the one specified in this header. Otherwise, a 412 HTTP status code error (failed precondition) is returned.
+
Type: string
+
Example: x-obs-copy-source-if-none-match: etag
+
Constraint: This parameter can be used with x-obs-copy-source-if-modified-since but not other conditional copy parameters.
+
+
No
+
+
+
x-obs-copy-source-if-unmodified- since
+
+
Copies the source object only if it has not been modified since the time specified by this header. Otherwise, a 412 HTTP status code error (failed precondition) is returned. This header can be used with x-obs-copy-source-if-match, but cannot be used with other conditional copy headers.
+
Type: HTTP time character string complying with the format specified at http://www.ietf.org/rfc/rfc2616.txt
Copies the source object only if it has not been modified since the time specified by this header. Otherwise, a 412 HTTP status code error (failed precondition) is returned. This header can be used with x-obs-copy-source-if-none-match, but cannot be used with other conditional copy headers
+
Type: HTTP time character string complying with the format specified at http://www.ietf.org/rfc/rfc2616.txt
When copying an object, you can use this header to specify the storage class for the object. If you do not use this header, the object storage class is the default storage class of the destination bucket where the object is copied to.
+
Type: string
+
Note: There are three storage classes: STANDARD (Standard storage class), WARM (Warm storage class), and COLD (Cold storage class). Therefore, this parameter value can be STANDARD, WARM, or COLD. These values are case sensitive.
+
Example: x-obs-storage-class: STANDARD
+
+
No
+
+
+
x-obs-website-redirect-location
+
+
If a bucket is configured with the static website hosting function, it will redirect requests for this object to another object in the same bucket or to an external URL. OBS stores the value of this header in the object metadata.
+
Type: string
+
Default value: none
+
Constraint: The value must be prefixed by a slash (/), http://, or https://. The length of the value cannot exceed 2 KB.
+
+
No
+
+
+
x-obs-server-side-encryption
+
+
Indicates that SSE-KMS is used. Objects are encrypted using SSE-KMS.
+
Type: string
+
Example: x-obs-server-side-encryption: kms
+
+
No. This header is required when SSE-KMS is used.
+
+
+
x-obs-server-side-encryption-kms-key-id
+
+
Indicates the master key ID of an encrypted object. This header is used in SSE-KMS mode. If the customer does not provide the master key ID, the default master key ID will be used.
+
Type: string
+
The following two formats are supported:
+
1. regionID:domainID:key/key_id
+
2. key_id
+
regionID is the ID of the region to which the key belongs. domainID is the account ID of the tenant to which the key belongs. key_id is the key ID created in KMS.
Constraint: This header is a Base64-encoded 256-bit key and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key-MD5.
+
+
No. This header is required when SSE-C is used.
+
+
+
x-obs-server-side-encryption-customer-key-MD5
+
+
Indicates the MD5 value of a key used to encrypt a destination object. The header is used in SSE-C mode. The MD5 value is used to check whether any error occurs during the transmission of the key.
Constraint: This header is a Base64-encoded 128-bit MD5 value and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key.
Constraint: This header must be used together with x-obs-copy-source-server-side-encryption-customer-key and x-obs-copy-source-server-side-encryption-customer-key-MD5.
+
+
No. This header is required when SSE-C is used to copy a source object.
Constraint: This header is a Base64-encoded 256-bit key and must be used together with x-obs-copy-source-server-side-encryption-customer-algorithm and x-obs-copy-source-server-side-encryption-customer-key-MD5.
+
+
No. This header is required when SSE-C is used to copy a source object.
Indicates the MD5 value of the key used to decrypt a source object. The header is used in SSE-C mode. The MD5 value is used to check whether any error occurs during the transmission of the key.
Constraint: This header is a Base64-encoded 128-bit MD5 value and must be used together with x-obs-copy-source-server-side-encryption-customer-algorithm and x-obs-copy-source-server-side-encryption-customer-key.
+
+
No. This header is required when SSE-C is used to copy a source object.
+
+
+
success_action_redirect
+
+
Indicates the address (URL) to which a successfully responded request is redirected.
+
If the value is valid and the request is successful, OBS returns status code 303. Location contains success_action_redirect as well as the bucket name, object name, and object ETag.
If this parameter is invalid, OBS ignores this parameter. The response code is 204, and the Location is the object address.
The response to the request uses common headers. For details, see Table 1.
+
In addition to the common response headers, the following message headers may also be used. For details, see Table 2.
+
+
Table 2 Additional response header parameters
Header
+
+
Description
+
+
+
+
x-obs-copy-source-version-id
+
+
Version ID of the source object
+
Type: string
+
+
+
x-obs-version-id
+
+
Version ID of the target object
+
Type: string
+
+
+
x-obs-server-side-encryption
+
+
This header is included in a response if SSE-KMS is used.
+
Type: string
+
Example: x-obs-server-side-encryption: kms
+
+
+
x-obs-server-side-encryption-kms-key-id
+
+
Indicates the master key ID. This header is included in a response if SSE-KMS is used.
+
Type: string
+
Format: regionID:domainID:key/key_id
+
regionID is the ID of the region to which the key belongs. domainID is the account ID of the tenant to which the key belongs. key_id is the key ID used in this encryption.
This header is returned when the storage class of an object is not Standard. The value can be WARM or COLD.
+
Type: string
+
+
+
+
+
+
+
Response Elements
This response contains elements of a copy result. Table 3 describes the elements.
+
+
Table 3 Response elements
Element
+
+
Description
+
+
+
+
CopyObjectResult
+
+
Container for the copy result
+
Type: XML
+
+
+
LastModified
+
+
Latest time when the object was modified
+
Type: string
+
+
+
ETag
+
+
128-bit MD5 digest of the Base64 code of a new object. ETag is the unique identifier of the object content. It can be used to identify whether the object content is changed. For example, if ETag value is A when an object is uploaded and the ETag value has changed to B when the object is downloaded, it indicates that the object content is changed.
+
Type: string
+
+
+
+
+
+
+
Error Responses
No special error responses are returned. For details about error responses, see Table 2.
+
+
Sample Request 1
Copy the object srcobject in bucket bucket to the destobject object in bucket examplebucket.
Copy a multi-version object and copy the object srcobject whose version number is AAABQ4uBLdLc0vycq3gAAAAEVURTRkha in bucket bucket to the destobject object in bucket examplebucket.
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 anonymous users the read permission for the object, anonymous users can access this object without using the authentication header field.
+
+
Server-Side Encryption
If the object uploaded to the server is encrypted on the server using the encryption key provided by the client, downloading the object requires including the encryption key in the message.
+
+
Versioning
By default, the GET operation returns the current version of an object. If the current version of the object is a deletion marker, OBS returns a code meaning non-existence of the object. To obtain an object of a specified version, the versionId parameter can be used to specify the desired version.
+
+
OBS Cold Objects
If the object to be downloaded is a Cold object, restore it before downloading it. The response varies with the retrieval status of the object. If the object has been restored, the x-obs-restore header is returned indicating the expiry date of the object when it is successfully downloaded. If you request downloading Cold objects that are not restored or are being restored, a 403 Forbidden error is returned.
+
+
Request Syntax
1
+2
+3
+4
+5
+6
GET /ObjectName HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+Range:bytes=byte_range
+<OptionalAdditionalHeader>
+
+
+
The field is optional. If it does not exist, you can obtain the whole content.
+
+
+
Request Parameters
In a GET request, you can override values for a set of message headers using the request parameters. Message headers that you can override are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. If the target object has multiple versions, use the versionId parameter to specify the version to be downloaded. For details, see Table 1.
+
OBS does not process Accept-Encoding carried in a request or compress or decompress the uploaded data. The client determines whether to compress or decompress the data. Some HTTP clients may decompress data based on the Content-Encoding returned by the server. The client program needs to determine whether to decompress and how to decompress the data. To decompress the data, it can modify Content-Encoding (the object metadata stored in OBS) or rewrite Content-Encoding the object is downloaded. If an object download request specifies the rewrite header, the standard HTTP message header returned by OBS is subject to the rewrite content specified in the request.
+
+
+
Table 1 Request parameters
Parameter
+
+
Description
+
+
Mandatory
+
+
+
+
response-content-type
+
+
Rewrites the Content-Type header in the response.
+
Type: string
+
+
No
+
+
+
response-content-language
+
+
Rewrites the Content-Language header in the response.
+
Type: string
+
+
No
+
+
+
response-expires
+
+
Rewrites the Expires header in the response.
+
Type: string
+
+
No
+
+
+
response-cache-control
+
+
Rewrites the Cache-Control header in the response.
+
Type: string
+
+
No
+
+
+
response-content-disposition
+
+
+
Rewrites the Content-Disposition header in the response.
In this example, the downloaded object is renamed name1. If the new name contains Chinese characters, it must be URL-encoded.
+
+
No
+
+
+
response-content-encoding
+
+
Rewrites the Content-Encoding header in the response.
+
Type: string
+
+
No
+
+
+
versionId
+
+
Indicates the version ID of the object whose content is obtained.
+
Type: string
+
+
No
+
+
+
attname
+
+
Rewrites the Content-Disposition header in the response.
+
Type: string
+
Example:
+
attname=name1
+
Rename the downloaded object as name1.
+
+
No
+
+
+
+
+
+
+
Request Headers
This request uses common headers. In addition, you can add additional headers to this request. Table 2 describes the additional headers.
+
+
Table 2 Request headers
Header
+
+
Description
+
+
Mandatory
+
+
+
+
Range
+
+
Obtains the object content within the scope defined by Range. If the parameter value is invalid, the entire object is obtained.
+
Range value starts from 0, and the maximum value equals the object length minus 1. The start value of Range is mandatory. If only the start value is specified, the system obtains the object content from the start value to default maximum value.
+
After the Range header field is carried, the value of ETag in the response message is the ETag of the object instead of the ETag of the object in the Range field.
+
Type: string
+
bytes=byte_range
+
Example 1: bytes=0-4
+
Example 2: bytes=1024
+
Example 3: bytes=10-20, 30-40 (multiple ranges)
+
+
No
+
+
+
If-Modified-Since
+
+
Returns the object only if it has been modified since the time specified by this header. Otherwise, 304 Not Modified is returned.
+
Type: HTTP time character string complying with the format specified at http://www.ietf.org/rfc/rfc2616.txt
+
+
No
+
+
+
If-Unmodified-Since
+
+
Returns the object only if it has not been modified since the time specified by this header. Otherwise, 412 Precondition Failed is returned.
+
Type: HTTP time character string complying with the format specified at http://www.ietf.org/rfc/rfc2616.txt
+
+
No
+
+
+
If-Match
+
+
Returns the object only if its ETag is the same as the one specified by this header. Otherwise, 412 Precondition Failed is returned.
+
Type: string
+
(Example: 0f64741bf7cb1089e988e4585d0d3434)
+
+
No
+
+
+
If-None-Match
+
+
Returns the object only if its ETag is different from the one specified by this header. Otherwise, 304 Not Modified is returned.
+
Type: string
+
(Example: 0f64741bf7cb1089e988e4585d0d3434)
+
+
No
+
+
+
x-obs-server-side-encryption-customer-algorithm
+
+
Indicates an encryption algorithm. The header is used in SSE-C mode.
Constraint: This header is a Base64-encoded 256-bit key and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key-MD5.
+
+
No. This header is required when SSE-C is used.
+
+
+
x-obs-server-side-encryption-customer-key-MD5
+
+
Indicates the MD5 value of a key used to encrypt objects. The header is used in SSE-C mode. The MD5 value is used to check whether any error occurs during the transmission of the key.
Constraint: This header is a Base64-encoded 128-bit MD5 value and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key.
+
+
No. This header is required when SSE-C is used.
+
+
+
+
+
+
+
Request Elements
This request involves no elements.
+
+
Response Syntax
1
+2
+3
+4
+5
+6
+7
+8
HTTP/1.1 status_code
+Content-Type: type
+Date: date
+Content-Length: length
+Etag: etag
+Last-Modified: time
+
+<ObjectContent>
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
In addition to the common response headers, the following message headers may also be used. For details, see Table 3.
+
+
Table 3 Additional response header parameters
Header
+
+
Description
+
+
+
+
x-obs-expiration
+
+
When an object has its lifecycle rule, the object expiration time is subject to its lifecycle rule. This header field is use expiry-date to describe the object expiration date. If the lifecycle rule is configured only for the entire bucket not individual objects, the object expiration time is subject to the bucket lifecycle rule. This header field uses the expiry-date and rule-id to describe the detailed expiration information of objects. If no lifecycle rule is configured, this header field is not contained in the response.
+
Type: string
+
+
+
x-obs-website-redirect-location
+
+
Indicates the redirected-to location. If the bucket is configured with website information, this parameter can be set for the object metadata so that the website endpoint will evaluate the request for the object as a 301 redirect to another object in the same bucket or an external URL.
+
Type: string
+
+
+
x-obs-delete-marker
+
+
Indicates whether an object is a deletion marker. If the object is not marked as deleted, the response does not contain this header.
+
Type: boolean
+
Valid values: true or false
+
The default value is false.
+
+
+
x-obs-version-id
+
+
Object version ID. If the object has no version number specified, the response does not contain this header.
+
Valid value: character string
+
Default value: none
+
+
+
x-obs-server-side-encryption
+
+
This header is included in a response if SSE-KMS is used.
+
Type: string
+
Example: x-obs-server-side-encryption:kms
+
+
+
x-obs-server-side-encryption-kms-key-id
+
+
Indicates the master key ID. This header is included in a response if SSE-KMS is used.
+
Type: string
+
Format: regionID:domainID:key/key_id
+
regionID is the ID of the region to which the key belongs. domainID is the account ID of the tenant to which the key belongs. key_id is the key ID used in this encryption.
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 operation supports server-side encryption.
+
+
Versioning
By default, this operation returns the latest metadata of an object. If the object has a deletion marker, status code 404 is returned. To obtain the object metadata of a specified version, the versionId parameter can be used to specify the desired version.
+
+
Request Syntax
1
+2
+3
+4
HEAD /ObjectName HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
Constraint: This header is a Base64-encoded 256-bit key and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key-MD5.
+
+
No. This header is required when SSE-C is used.
+
+
+
x-obs-server-side-encryption-customer-key-MD5
+
+
Indicates the MD5 value of a key used to decrypt objects. The header is used in SSE-C mode. The MD5 value is used to check whether any error occurs during the transmission of the key.
Constraint: This header is a Base64-encoded 128-bit MD5 value and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key.
+
+
No. This header is required when SSE-C is used.
+
+
+
+
+
+
+
Request Elements
This request involves no elements.
+
+
Response Syntax
1
+2
+3
+4
+5
+6
HTTP/1.1 status_code
+Content-Type: type
+Date: date
+Content-Length: length
+Etag: etag
+Last-Modified: time
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
In addition to the common response headers, the following message headers may also be used. For details, see Table 3.
+
+
Table 3 Additional response header parameters
Header
+
+
Description
+
+
+
+
x-obs-expiration
+
+
When an object has its lifecycle rule, the object expiration time is subject to its lifecycle rule. This header field is use expiry-date to describe the object expiration date. If the lifecycle rule is configured only for the entire bucket not individual objects, the object expiration time is subject to the bucket lifecycle rule. This header field uses the expiry-date and rule-id to describe the detailed expiration information of objects. If no lifecycle rule is configured, this header field is not contained in the response.
+
Type: string
+
+
+
x-obs-website-redirect-location
+
+
Indicates the redirected-to location. If the bucket is configured with website information, this parameter can be set for the object metadata so that the website endpoint will evaluate the request for the object as a 301 redirect to another object in the same bucket or an external URL.
+
Type: string
+
+
+
x-obs-version-id
+
+
Object version ID. If the object has no version number specified, the response does not contain this header.
+
Type: string
+
Default value: none
+
+
+
Access-Control-Allow-Origin
+
+
Indicates that the origin is included in the response if the origin in the request meets the CORS configuration requirements when CORS is configured for buckets.
+
Type: string
+
+
+
Access-Control-Allow-Headers
+
+
Indicates that the headers are included in the response if headers in the request meet the CORS configuration requirements when CORS is configured for buckets.
+
Type: string
+
+
+
Access-Control-Max-Age
+
+
Value of MaxAgeSeconds in the CORS configuration of the server when CORS is configured for buckets.
+
Type: integer
+
+
+
Access-Control-Allow-Methods
+
+
Indicates that methods in the rule are included in the response if Access-Control-Request-Method in the request meets the CORS configuration requirements when CORS is configured for buckets.
+
Type: string
+
Possible values are GET, PUT, HEAD, POST, and DELETE.
+
+
+
Access-Control-Expose-Headers
+
+
Value of ExposeHeader in the CORS configuration of a server when CORS is configured for buckets.
+
Type: string
+
+
+
x-obs-server-side-encryption
+
+
This header is included in a response if SSE-KMS is used.
+
Type: string
+
Example: x-obs-server-side-encryption:kms
+
+
+
x-obs-server-side-encryption-kms-key-id
+
+
Indicates the master key ID. This header is included in a response if SSE-KMS is used.
+
Type: string
+
Format: regionID:domainID:key/key_idregionID is the ID of the region to which the key belongs. domainID is the account ID of the tenant to which the key belongs. key_id is the key ID used in this encryption.
This header is returned when the storage class of an object is not Standard. The value can be WARM or COLD.
+
Type: string
+
+
+
x-obs-restore
+
+
For a Cold object that is being restored or has been restored, this header is returned. Indicates the object restoring status. Value options are as follows: restoring ongoing-request=true; you have obtained ongoing-request=false, expiry-date=Wed, 07 Nov 2012 00:00:00 GMT. In the preceding information, expiry-date indicates the expiration time after the object is restored.
+
Type: string
+
+
+
x-obs-object-type
+
+
If the object is not a normal one, this header field is returned. The value can be Appendable
+
Type: string
+
+
+
x-obs-next-append-position
+
+
This header field is returned when the object is an appendable object.
+
Type: integer
+
+
+
x-obs-uploadId
+
+
This header is returned if the object is a combination of multiple parts. The header value indicates the ID of the corresponding multipart upload task.
+
Type: string
+
+
+
+
+
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
No special error responses are returned. For details about error responses, see Table 2.
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.
+
+
Versioning
When versioning is enabled for a bucket, a deletion marker with a unique version number is generated when an object is deleted without specifying the version. However, the object is not actually deleted. If versioning is suspended for a bucket and no version is specified when you delete an object, the object whose version number is null is deleted, and a deletion marker with version number null is generated.
+
To delete an object of a specified version, the versionId parameter can be used to specify the desired version.
+
+
Request Syntax
1
+2
+3
+4
DELETE /ObjectName HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
For deleting an object, only parameters listed in Table 1 are supported. If the request contains parameters that cannot be identified by OBS, the server returns the 400 error code.
+
+
+
Table 1 Request parameters
Parameter
+
+
Description
+
+
Mandatory
+
+
+
+
versionId
+
+
Object version ID
+
Type: string
+
+
No
+
+
+
+
+
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request involves no elements.
+
+
Response Syntax
1
+2
HTTP/1.1 status_code
+Date: date
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
In addition to the common response headers, the following message headers may also be used. For details, see Table 2.
+
+
Table 2 Additional response header parameters
Header
+
+
Description
+
+
+
+
x-obs-delete-marker
+
+
Indicates whether an object is deleted. If the object is not marked as deleted, the response does not contain this header.
+
Type: boolean
+
Valid values: true or false
+
The default value is false.
+
+
+
x-obs-version-id
+
+
Object version ID. If the object has no version number specified, the response does not contain this header.
+
Valid value: character string
+
There is no default value.
+
+
+
+
+
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
No special error responses are returned. For details about error responses, see Table 2.
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 the implementation result of each object in the specified bucket. OBS deletes the objects synchronously. The deletion result of each object is returned to the request user.
+
Objects in batches can be deleted in verbose or quiet mode. With verbose mode, OBS returns results of successful and failed deletion in an XML response; with quiet mode, OBS only returns results of failed deletion in an XML response. OBS uses the verbose mode by default and you can specify the quiet mode in the request body.
+
For batch deletion, the request header must contain Content-MD5 and Content-Length, so that the message body can be identified if network transmission error is detected at the server side.
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request uses elements to specify the list of objects to be deleted in a batch. Table 1 describes the elements.
+
+
Table 1 Request Elements
Element
+
+
Description
+
+
Mandatory
+
+
+
+
Quiet
+
+
Specifies the quiet mode. With the quiet mode, OBS only returns the list of objects that failed to be deleted. This element is valid when set to true. Otherwise, OBS ignores it.
+
Type: boolean
+
+
No
+
+
+
Delete
+
+
List of objects to be deleted
+
Type: XML
+
+
Yes
+
+
+
Object
+
+
Names of objects to be deleted
+
Type: XML
+
+
Yes
+
+
+
Key
+
+
Key of the object to be deleted
+
Type: string
+
+
Yes
+
+
+
VersionId
+
+
Version ID of the object to be deleted
+
Type: string
+
+
No
+
+
+
+
+
+
A maximum of 1000 objects can be deleted at a time. If you send a request for deleting more than 1000 objects, OBS returns an error message.
+
After concurrent tasks are assigned, OBS may encounter an internal error during cyclic deletion of multiple objects. In that case, the metadata still exists when the object index data is deleted, which means data inconsistency.
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response uses elements to return results of deleted objects in a batch. Table 2 describes the elements.
+
+
Table 2 Response elements
Element
+
+
Description
+
+
+
+
DeleteResult
+
+
Root node of batch deletion responses
+
Type: container
+
+
+
Deleted
+
+
Container for results of successful deletion
+
Type: container
+
+
+
Error
+
+
Container for results of failed deletion
+
Type: container
+
+
+
Key
+
+
Object names in a deletion result
+
Type: string
+
+
+
Code
+
+
Error code of a deletion failure
+
Type: string
+
+
+
Message
+
+
Error message of a deletion failure
+
Type: string
+
+
+
VersionId
+
+
Version IDs of objects to be deleted
+
Type: string
+
+
+
DeleteMarker
+
+
If this element is specified, true will be returned when you create or delete a deletion marker in the requested bucket with versioning enabled.
+
Type: boolean
+
+
+
DeleteMarkerVersionId
+
+
Indicates the version ID of the deletion marker deleted or created by the request.
+
If the request either creates or deletes a deletion marker, OBS returns this element in response with the version ID of the deletion marker. This element will be returned in either of the following cases:
+
You send a versionless request, that is, you specify only the object name but not the version ID. In this case, the UDS creates a deletion marker and returns its version ID in the response.
You send a request with versions, that is, you specify object keys and version IDs that identify deletion markers. In this case, OBS deletes the deletion marker and returns its version ID in the response.
+
Type: boolean
+
+
+
+
+
+
+
Error Responses
1. If the resolution result of an XML request contains more than 1000 objects, OBS returns 400 Bad Request.
+
2. If the object key in an XML request is invalid (for example, containing more than 1024 characters), OBS returns 400 Bad Request.
+
3. If the request header does not contain Content-MD5, OBS returns 400 Bad Request.
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 the object is saved in the Standard storage class. By doing so, the object in the Cold storage class and its copy in the Standard storage class co-exist in the bucket. The copy will be automatically deleted upon the expiration of its retention period.
+
+
Versioning
By default, this operation returns the latest version of an object. If the object has a deletion marker, status code 404 is returned. To restore an object of a specified version, the versionId parameter can be used to specify the desired version.
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 set a public access policy to assign the read permission to all other users. Even if the ACL is configured for an object encrypted in the SSE-KMS mode, the inter-tenant access is unavailable.
+
You can set an access control policy when uploading an object or make a call of an API operation to modify or obtain the object ACL. An object ACL supports a maximum of 100 grants.
+
This section explains how to modify an object ACL and change access permission on an object.
+
+
Versioning
By default, this operation modifies the ACL of the latest version of an object. To specify a specified version, the request can carry the versionId parameter.
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 permission for the object ACL.
+
+
Versioning
By default, this operation obtains the ACL of the latest version of an object. If the object has a delete marker, status code 404 is returned. To obtain the ACL of a specified version, the versionId parameter can be used to specify the desired version.
+
+
Request Syntax
1
+2
+3
+4
GET /ObjectName?acl HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
The request parameter specifies the object ACL to be obtained. For details about the parameters, see Table 1.
+
+
Table 1 Request parameters
Parameter
+
+
Description
+
+
Mandatory
+
+
+
+
acl
+
+
Indicates that the request is to obtain the object ACL.
+
Type: string
+
+
Yes
+
+
+
versionId
+
+
Version number of an object.
+
Type: string
+
+
No
+
+
+
+
+
+
+
Request Headers
This request uses common headers. For details, see Table 3.
This operation queries all the multipart upload tasks that are initialized but have not been merged or canceled in a bucket.
+
+
Request Syntax
GET /?uploads&max-uploads=max HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
Request Parameters
This request uses parameters to specify the query range for multipart uploads. Table 1 describes the parameters.
+
+
Table 1 Request parameters
Parameter
+
+
Description
+
+
Mandatory
+
+
+
+
delimiter
+
+
For a multipart upload that contains delimiters, the string between the first character and the first delimiter in the object name (excluding the prefix specified in the request, if any) are returned as CommonPrefix. Multipart uploads with objects that contain CommonPrefix are considered as a group and returned as one record. The record contains no information about the tasks, only informing the user that the group involves multipart uploads.
+
Type: string
+
+
No
+
+
+
prefix
+
+
If a prefix is specified, the response only contains tasks whose names start with the prefix value.
+
Type: string
+
+
No
+
+
+
max-uploads
+
+
Maximum number of multipart upload tasks returned. The value ranges from 1 to 1000. If the value has exceeded this range, 1000 tasks are returned by default.
+
Type: integer
+
+
No
+
+
+
key-marker
+
+
Lists multipart uploads that follow the value of key-marker.
+
Type: string
+
+
No
+
+
+
upload-id-marker
+
+
Lists multipart tasks that follow the value of upload-id-marker in key-marker. This parameter only functions together with key-marker.
+
Type: string
+
+
No
+
+
+
+
+
+
+
Request Headers
This request uses common headers. For details, see Table 3.
List the initialized multipart tasks with the prefix and delimiter.
+
The following example describes how to list initialized multipart tasks when there are two multipart tasks in the bucket examplebucket, and their object names are multipart-object001 and part2-key02. Set prefix to multipart and set delimiter to object001.
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 identifier. This identifier can be used in subsequent requests including UploadPart, CompleteMultipartUpload, and ListParts. Create a multipart upload task does not affect the object that has the same name as object to be uploaded in multiple parts. You can create more than one multipart upload tasks for an object. This operation request can contain headers x-obs-acl, x-obs-meta-*, Content-Type, and Content-Encoding. The headers are recorded in the multipart upload metadata.
+
This operation supports server-side encryption.
+
+
Request Syntax
1
+2
+3
+4
POST /ObjectName?uploads HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: authorization
+
+
+
+
Request Parameters
This request uses parameters to specify a multipart upload. Table 1 describes the parameters.
+
+
Table 1 Request parameters
Parameter
+
+
Description
+
+
Mandatory
+
+
+
+
uploads
+
+
Indicates a multipart upload.
+
Type: string
+
+
Yes
+
+
+
+
+
+
+
Request Headers
The request can use additional headers, as shown in Table 2.
+
+
Table 2 Request headers
Header
+
+
Description
+
+
Mandatory
+
+
+
+
x-obs-acl
+
+
When initializing a multipart upload task, you can add this message header to set the permission control policy for the object. The predefined common policies are as follows: private, public-read, and public-read-write.
+
Type: string
+
Note: This header is a predefined policy expressed in a character string.
+
Example: x-obs-acl: public-read-write
+
+
No
+
+
+
x-obs-grant-read
+
+
When initializing a multipart upload task, you can use this header to authorize all users in an account to read the object and obtain the object metadata.
+
Type: string
+
Example: x-obs-grant-read: ID=domainID If multiple accounts are authorized, separate them with commas (,).
+
+
No
+
+
+
x-obs-grant-read-acp
+
+
When initializing a multipart upload task, you can use this header to authorize all users in an account the permission to obtain the object ACL.
+
Type: string
+
Example: x-obs-grant-read-acp: ID=domainID If multiple accounts are authorized, separate them with commas (,).
+
+
No
+
+
+
x-obs-grant-write-acp
+
+
When initializing a multipart upload task, you can use this header to authorize all users in an account the permission to write the object ACL.
+
Type: string
+
Example: x-obs-grant-write-acp: ID=domainID If multiple accounts are authorized, separate them with commas (,).
+
+
No
+
+
+
x-obs-grant-full-control
+
+
When initializing a multipart upload task, you can use this header to authorize all users in an account the permission to read the object, obtain the object metadata, obtain the object ACL, and write the object ACL.
+
Type: string
+
Example: x-obs-grant-full-control: ID=domainID If multiple accounts are authorized, separate them with commas (,).
+
+
No
+
+
+
x-obs-storage-class
+
+
When initiating a multi-part upload task, you can add this header to specify the storage class for the object. If you do not use this header, the object storage class is the default storage class of the bucket.
+
Type: string
+
Note: There are three storage classes: STANDARD (Standard storage class), WARM (Warm storage class), and COLD (Cold storage class). Therefore, this parameter value can be STANDARD, WARM, or COLD. These values are case sensitive.
+
Example: x-obs-storage-class: STANDARD
+
+
No
+
+
+
x-obs-website-redirect-location
+
+
If a bucket is configured with the static website hosting function, it will redirect requests for this object to another object in the same bucket or to an external URL. OBS stores the value of this header in the object metadata.
+
Type: string
+
Default value: none
+
Constraint: The value must be prefixed by a slash (/), http://, or https://. The length of the value cannot exceed 2 KB.
+
+
No
+
+
+
x-obs-server-side-encryption
+
+
Indicates that SSE-KMS is used.
+
Type: string
+
Example: x-obs-server-side-encryption:kms
+
+
No. This header is required when SSE-KMS is used.
+
+
+
x-obs-server-side-encryption-kms-key-id
+
+
Master key ID. This header is used in SSE-KMS mode. If the customer does not provide the master key ID, the default master key ID will be used.
+
Type: string
+
The following two formats are supported:
+
1. regionID:domainID:key/key_id
+
2. key_id
+
regionID is the ID of the region to which the key belongs. domainID is the account ID of the tenant to which the key belongs. key_id is the key ID created in KMS.
Constraint: This header is a Base64-encoded 256-bit key and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key-MD5.
+
+
No. This header is required when SSE-C is used.
+
+
+
x-obs-server-side-encryption-customer-key-MD5
+
+
Indicates the MD5 value of a key used to encrypt objects. The header is used in SSE-C mode. The MD5 value is used to check whether any error occurs during the transmission of the key.
Constraint: This header is a Base64-encoded 128-bit MD5 value and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key.
+
+
No. This header is required when SSE-C is used.
+
+
+
x-obs-expires
+
+
Indicates the expiration time of an object, in days. An object will be automatically deleted once it expires (calculated from the last modification time of the object).
+
Type: integer
+
Example: x-obs-expires:3
+
+
No
+
+
+
+
+
+
For details about other common message headers, see Table 3.
The response to the request uses common headers. For details, see Table 1.
+
+
Table 3 Additional response headers
Header
+
+
Description
+
+
+
+
x-obs-server-side-encryption
+
+
This header is included in a response if SSE-KMS is used.
+
Type: string
+
Example: x-obs-server-side-encryption:kms
+
+
+
x-obs-server-side-encryption-kms-key-id
+
+
Indicates the master key ID. This header is included in a response if SSE-KMS is used.
+
Type: string
+
Format: regionID:domainID:key/key_id
+
regionID is the ID of the region to which the key belongs. domainID is the account ID of the tenant to which the key belongs. key_id is the key ID used in this encryption.
This response contains elements to indicate the upload ID and the key (name) of the object (bucket) for which the multipart upload was initiated. The returned information is used in the subsequent operations. Table 4 describes the elements.
+
+
Table 4 Response elements
Element
+
+
Description
+
+
+
+
InitiateMultipartUploadResult
+
+
Container of a multipart upload task.
+
Type: XML
+
+
+
Bucket
+
+
Indicates the name of the bucket to which the multipart upload was initiated.
+
Type: string
+
+
+
Key
+
+
Indicates the object key in a multipart upload.
+
Type: string
+
+
+
UploadId
+
+
Indicates the ID for the initiated multipart upload. This ID is used for the subsequent operation.
+
Type: string
+
+
+
+
+
+
+
Error Responses
1. If the AK or signature is invalid, OBS returns 403 Forbidden and the error code is AccessDenied.
+
2. If the bucket does not exist, OBS returns 404 Not Found and the error code is NoSuchBucket.
+
3. Check whether the user has the write permission for the specified bucket. If no, OBS returns 403 Forbidden and the error code is AccessDenied.
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 of an object, the upload sequence does not affect part merging, namely, multiple parts can be uploaded concurrently.
+
Part sizes range from 100 KB to 5 GB. However, when parts are being merged, the size of the last uploaded part ranges from 0 to 5 GB. The upload part ID ranges from 1 to 10,000.
+
This operation supports server-side encryption.
+
The value of partNumber in a multipart task is unique. If you upload a part of the same partNumber repeatedly, the last part uploaded will overwrite the previous one. When multiple concurrent uploading of the same partNumber part of the same object is performed, the Last Write Win policy is applied. The time of Last Write is defined as the time when the metadata of the part is created. To ensure data accuracy, the client must be locked to ensure concurrent upload of the same part of the same object. Concurrent upload of different parts of the same object does not need to be locked.
+
+
+
Request Syntax
PUT /ObjectName?partNumber=partNum&uploadId=uploadID HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Content-Length: length
+Authorization: authorization
+Content-MD5:md5
+<object Content>
+
+
Request Parameters
This request uses parameters to specify the upload task ID and part number. Table 1 describes the parameters.
+
+
Table 1 Request parameters
Parameter
+
+
Description
+
+
Mandatory
+
+
+
+
partNumber
+
+
Indicates the ID of a part to be uploaded. The value is an integer from 1 to 10000.
+
Type: integer
+
+
Yes
+
+
+
uploadId
+
+
Indicates a multipart upload ID.
+
Type: string
+
+
Yes
+
+
+
+
+
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
+
Table 2 Server encryption request headers
Header
+
+
Description
+
+
Mandatory
+
+
+
+
x-obs-server-side-encryption-customer-algorithm
+
+
Indicates an encryption algorithm. The header is used in SSE-C mode.
Constraint: This header is a Base64-encoded 256-bit key and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key-MD5.
+
+
No. This header is required when SSE-C is used. The key must be the same as that used to initiate multipart upload tasks.
+
+
+
x-obs-server-side-encryption-customer-key-MD5
+
+
Indicates the MD5 value of a key used to encrypt objects. The header is used in SSE-C mode. The MD5 value is used to check whether any error occurs during the transmission of the key.
Constraint: This header is a Base64-encoded 128-bit MD5 value and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key.
+
+
No. This header is required when SSE-C is used. The MD5 value must be the same as that used to initiate multipart upload tasks.
+
+
+
+
+
+
+
Request Elements
This request involves no elements.
+
+
Response Syntax
1
+2
+3
+4
HTTP/1.1 status_code
+Date: date
+ETag: etag
+Content-Length: length
+
+
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Table 3 Additional response headers
Header
+
+
Description
+
+
+
+
x-obs-server-side-encryption
+
+
This header is included in a response if SSE-KMS is used.
+
Type: string
+
Example: x-obs-server-side-encryption:kms
+
+
+
x-obs-server-side-encryption-kms-key-id
+
+
Indicates the master key ID. This header is included in a response if SSE-KMS is used.
+
Type: string
+
Format: regionID:domainID:key/key_id
+
regionID is the ID of the region to which the key belongs. domainID is the account ID of the tenant to which the key belongs. key_id is the key ID used in this encryption.
If a part number is not within the range from 1 to 10000, OBS returns 400 Bad Request.
If a part size has exceeded 5 GB, the error code 400 Bad Request is returned.
If the AK or signature is invalid, OBS returns 403 Forbidden and the error code is AccessDenied.
Check whether the bucket exists. If the bucket does not exist, OBS returns 404 Not Found and the error code is NoSuchBucket.
View the bucket ACL to check whether the user has the read permission for the requested bucket. If the user does not have the read permission, OBS returns 403 AccessDenied.
Check whether the multipart upload task exists. If the task does not exist, OBS returns 404 Not Found and the error code is NoSuchUpload.
Check whether the request user is the initiator of the multipart upload task. If not, OBS returns 403 Forbidden and the error code is AccessDenied.
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 an object or the whole object).
+
This operation supports server-side encryption.
+
You cannot determine whether a request is executed successfully only using status_code in the returned HTTP header. If 200 in status_code is returned, the server has received the request and starts to process the request. The body in the response shows whether the request is executed successfully. The request is executed successfully only when the body contains Etag; otherwise, the request fails to be executed.
+
+
Copy the source object and save it as part1. If a part1 already exists before the copying, the original part1 will be overwritten by the newly copied part1. After the copy is successful, only the latest part1 is displayed. The old part1 data will be deleted. Therefore, ensure that the target part does not exist or has no value when using the part copy operation. Otherwise, data may be deleted by mistake. The source object in the copy process does not change.
+
+
OBS Cold Objects
If source objects are Cold objects, check the restoration status of the objects. You can copy these objects only after they are restored. If the source object is not restored or is being restored, the copy fails and error 403 Forbidden is returned. The fault is described as follows:
+
ErrorCode: InvalidObjectState
+
ErrorMessage: Operation is not valid for the source object's storage class
+
+
Request Syntax
PUT /ObjectName?partNumber=partNum&uploadId=UploadID HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+x-obs-copy-source: sourceobject
+x-obs-copy-source-range:bytes=start-end
+Authorization: authorization
+Content-Length: length
+
+
Request Parameters
To copy a part, you need to specify the part number of the target part and the multipart upload task number. Table 1 describes the parameters.
+
+
Table 1 Request parameters
Parameter
+
+
Description
+
+
Mandatory
+
+
+
+
partNumber
+
+
Indicates the ID of a part to be uploaded.
+
Type: integer
+
+
Yes
+
+
+
uploadId
+
+
Indicates a multipart upload ID.
+
Type: string
+
+
Yes
+
+
+
+
+
+
+
Request Headers
In addition the common message headers, the request uses two extended headers. Table 3 describes the common message header.
+
+
Table 2 Request headers
Header
+
+
Description
+
+
Mandatory
+
+
+
+
x-obs-copy-source
+
+
Indicates the source object to be copied.
+
Type: string
+
+
Yes
+
+
+
x-obs-copy-source-range
+
+
Indicates the range of bytes (start - end) to be copied from the source object. start indicates the start byte of the part to be copied and end indicates the end byte.
+
Type: integer
+
+
No
+
+
+
x-obs-server-side-encryption-customer-algorithm
+
+
Indicates an algorithm used to encrypt a destination part. The header is used in SSE-C mode.
Constraint: This header is a Base64-encoded 256-bit key and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key-MD5.
+
+
No. This header is required when SSE-C is used. The key must be the same as that used to initiate multipart upload tasks.
+
+
+
x-obs-server-side-encryption-customer-key-MD5
+
+
Indicates the MD5 value of a key used to encrypt a destination part. The header is used in SSE-C mode. The MD5 value is used to check whether any error occurs during the transmission of the key.
Constraint: This header is a Base64-encoded 128-bit MD5 value and must be used together with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key.
+
+
No. This header is required when SSE-C is used. The MD5 value must be the same as that used to initiate multipart upload tasks.
Constraint: This header must be used together with x-obs-copy-source-server-side-encryption-customer-key and x-obs-copy-source-server-side-encryption-customer-key-MD5.
+
+
No. This header is required when SSE-C is used to copy a source object.
Constraint: This header is a Base64-encoded 256-bit key and must be used together with x-obs-copy-source-server-side-encryption-customer-algorithm and x-obs-copy-source-server-side-encryption-customer-key-MD5.
+
+
No. This header is required when SSE-C is used to copy a source object.
Indicates the MD5 value of the key used for the source object. The header is used in SSE-C mode. The MD5 value is used to check whether any error occurs during the transmission of the key.
Constraint: This header is a Base64-encoded 128-bit MD5 value and must be used together with x-obs-copy-source-server-side-encryption-customer-algorithm and x-obs-copy-source-server-side-encryption-customer-key.
+
+
No. This header is required when SSE-C is used to copy a source object.
The response to the request uses common headers. For details, see Table 1.
+
+
Table 3 Additional response headers
Header
+
+
Description
+
+
+
+
x-obs-server-side-encryption
+
+
This header is included in a response if SSE-KMS is used.
+
Type: string
+
Example: x-obs-server-side-encryption:kms
+
+
+
x-obs-server-side-encryption-kms-key-id
+
+
Indicates the master key ID. This header is included in a response if SSE-KMS is used.
+
Type: string
+
Format: regionID:domainID:key/key_id
+
regionID is the ID of the region to which the key belongs. domainID is the account ID of the tenant to which the key belongs. key_id is the key ID used in this encryption.
This response contains elements of a part copy result. Table 4 describes the elements.
+
+
Table 4 Response elements
Element
+
+
Description
+
+
+
+
LastModified
+
+
Indicates the latest time an object was modified.
+
Type: string
+
+
+
ETag
+
+
ETag value of the target part. It is the unique identifier of the part content and is used to verify data consistency when merging parts.
+
Type: string
+
+
+
+
+
+
+
Error Responses
If the AK or signature is invalid, OBS returns 403 Forbidden and the error code is AccessDenied.
Check whether the source bucket or destination bucket exists. If the source bucket or destination bucket does not exist, OBS returns 404 Not Found and the error code is NoSuchBucket.
If the source object does not exist, OBS returns 404 Not Found and the error code is NoSuchKey.
If the user does not have the read permission for the specified object, OBS returns 403 Forbidden and the error code is AccessDenied.
If the user does not have the write permission for the destination bucket, OBS returns 403 Forbidden and the error code is AccessDenied.
If the specified task does not exist, OBS returns 404 Not Found and the error code is NoSuchUpload.
If the user is not the initiator of the multipart upload task, OBS returns 403 Forbidden and the error code is AccessDenied.
When the size of a copied part has exceeded 5 GB, OBS returns 400 Bad Request.
If a part number is not within the range from 1 to 10000, OBS returns error code 400 Bad Request.
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.
+
+
Request Syntax
GET /ObjectName?uploadId=uploadid&max-parts=max&part-number-marker=marker HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: auth
+
+
Request Parameters
This request uses parameters to specify which parts in a multipart upload will be listed. Table 1 describes the parameters.
+
+
Table 1 Request parameters
Parameter
+
+
Description
+
+
Mandatory
+
+
+
+
uploadId
+
+
Indicates a multipart upload ID.
+
Type: string
+
Default value: none
+
+
Yes
+
+
+
max-parts
+
+
Specifies the maximum number of parts to be listed.
+
Type: string
+
Default value: 1000
+
+
No
+
+
+
part-number
+
-marker
+
+
Indicates the part after which the part listing begins. OBS lists only parts with greater numbers than that specified by this parameter.
+
Type: string
+
Default value: none
+
+
No
+
+
+
+
+
+
+
Request Headers
This request uses common headers. For details, see Table 3.
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response uses elements to return information about uploaded parts. Table 2 describes the elements.
+
+
Table 2 Response elements
Element
+
+
Description
+
+
+
+
ListPartsResult
+
+
Indicates the container for responses to List Parts requests.
+
Type: container
+
Children: Bucket, Key, UploadId, PartNumberMarker, NextPartNumberMarker, MaxParts, IsTruncated, Part
+
Ancestor: none
+
+
+
Bucket
+
+
Indicates a bucket name.
+
Type: string
+
Ancestor: ListPartsResult
+
+
+
Key
+
+
Indicates an object name.
+
Type: string
+
Ancestor: ListPartsResult
+
+
+
UploadId
+
+
Indicates the ID of a multipart upload.
+
Type: string
+
Ancestor: ListPartsResult
+
+
+
Initiator
+
+
Indicates the initiator of a multipart upload.
+
Type: container
+
Children: ID
+
Ancestor: ListPartsResult
+
+
+
Owner
+
+
The value of this parameter is the same as that of Initiator.
+
Type: container
+
Children: ID
+
Ancestor: ListPartsResult
+
+
+
ID
+
+
ID of the domain to which the owner belongs
+
Type: string
+
Ancestor: Initiator or Owner
+
+
+
StorageClass
+
+
Indicates the storage type.
+
Type: enumeration
+
Value options: STANDARD | WARM | COLD
+
Ancestor: ListPartsResult
+
+
+
PartNumberMarker
+
+
Part number after which listing parts begins.
+
Type: integer
+
Ancestor: ListPartsResult
+
+
+
NextPartNumberMarker
+
+
Indicates the value of PartNumberMarker in the next request when the returned result is incomplete.
+
Type: integer
+
Ancestor: ListPartsResult
+
+
+
MaxParts
+
+
Maximum number of parts returned in a response
+
Type: integer
+
Ancestor: ListPartsResult
+
+
+
IsTruncated
+
+
Indicates whether the returned part list is truncated. true: Not all results are returned. false: All results have been returned.
+
Type: boolean
+
Ancestor: ListPartsResult
+
+
+
Part
+
+
Indicates the container for elements related to a particular part.
+
Type: string
+
Children: PartNumber, LastModified, ETag, Size
+
Ancestor: ListPartsResult
+
PartNumber identifies a part.
+
+
+
PartNumber
+
+
Number of an uploaded part
+
Type: integer
+
Ancestor: ListPartsResult.Part
+
+
+
LastModified
+
+
Indicates the date and time a part was uploaded.
+
Type: date
+
Ancestor: ListPartsResult.Part
+
+
+
ETag
+
+
ETag value of the uploaded parts. It is the unique identifier of the part content and is used to verify data consistency during the combination of parts.
+
Type: string
+
Ancestor: ListPartsResult.Part
+
+
+
Size
+
+
Indicates the size of an uploaded part.
+
Type: integer
+
Ancestor: ListPartsResult.Part
+
+
+
+
+
+
+
Error Responses
If the AK or signature is invalid, OBS returns 403 Forbidden and the error code is AccessDenied.
If the requested bucket does not exist, OBS returns 404 Forbidden and the error code is NoSuchBucket.
If the requested multipart upload task does not exist, OBS returns 404 Not Found and the error code is NoSuchUpload.
OBS determines whether the use's domain ID has the read permission for the specified bucket. If the user does not have the permission, OBS returns 403 Forbidden and the error code is AccessDenied.
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 uploaded data. When merging parts, you need to copy the additional message header information recorded during the initialization of the multipart upload task to the object metadata. The processing process is the same as that of the common upload object with these message headers. In the case of merging parts concurrently, the Last Write Win policy must be followed but the time for initiating Last Write is specified as the time when a part multipart upload is initiated.
+
If a multipart upload has not been aborted, the uploaded parts occupy your storage quota. After all parts in the multipart upload are merged to an object, only the object occupies your storage quota. If a part uploaded in a multipart upload is not used in any merging parts multipart uploads, the part will be deleted to release storage quota.
+
You can send a request for downloading all or some data of the generated multipart by specifying a range.
+
You can send a request for deleting all parts uploaded in a multipart upload. Deleted data cannot be restored.
+
The merged parts do not use the MD5 value of entire object as the ETag. Their ETag is calculated as follows: MD5(M1M2...MN)-N, where Mn is the MD5 value of part n (N is the total number of parts). As described in the Sample Request, there are three parts and each part has an MD5 value. The MD5 values of the three parts are recalculated to obtain a new MD5 value. Then -N is added to the right of the MD5 value to get the ETag of the combined parts. In this example, -N is -3.
+
If the response to an object merge request times out and error 500 or 503 is returned, you can first obtain the object metadata of the multipart upload task. Then, check whether the value of header x-obs-uploadId in the response is the same as the ID of this multipart upload task. If they are the same, object parts have been successfully merged on the server and you do not need to try again. For details, see Consistency of Concurrent Operations.
+
+
Versioning
If a bucket has versioning enabled, a unique version ID is generated for an object created from a multipart upload in this bucket and the version ID is returned in response header x-obs-version-id. If versioning is suspended for a bucket, the object version obtained after the merge is null. For details about the versioning statuses of a bucket, see Configuring Versioning for a Bucket.
+
If 10 parts are uploaded but only nine parts are selected for merge, the parts that are not merged will be automatically deleted by the system. The parts that are not merged cannot be restored after being deleted. Before combining the parts, adopt the interface used to list the parts that have been uploaded to check all parts to ensure that no part is missed.
This request uses parameters to specify the ID of a multipart upload whose parts will be merged. Table 1 describes the parameters.
+
+
Table 1 Request parameters
Parameter
+
+
Description
+
+
Mandatory
+
+
+
+
uploadId
+
+
Indicates a multipart upload.
+
Type: string
+
+
Yes
+
+
+
+
+
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request uses elements to specify the list of parts to be merged. Table 2 describes the elements.
+
+
Table 2 Request Elements
Element
+
+
Description
+
+
Mandatory
+
+
+
+
CompleteMultipartUpload
+
+
List of parts to be combined
+
Type: XML
+
+
Yes
+
+
+
PartNumber
+
+
Part number
+
Type: integer
+
+
Yes
+
+
+
ETag
+
+
ETag value returned upon successful upload of a part. It is the unique identifier of the part content. This parameter is used to verify data consistency when parts are merged.
The response to the request uses common headers. For details, see Table 1.
+
In addition to the common response headers, the following message headers may also be used. For details, see Table 3.
+
+
Table 3 Additional response header parameters
Header
+
+
Description
+
+
+
+
x-obs-version-id
+
+
Version of the object after parts being merged.
+
Type: string
+
+
+
x-obs-server-side-encryption
+
+
This header is included in a response if SSE-KMS is used.
+
Type: string
+
Example: x-obs-server-side-encryption:kms
+
+
+
x-obs-server-side-encryption-kms-key-id
+
+
Indicates the master key ID. This header is included in a response if SSE-KMS is used.
+
Type: string
+
Format: regionID:domainID:key/key_id
+
regionID is the ID of the region to which the key belongs. domainID is the account ID of the tenant to which the key belongs. key_id is the key ID used in this encryption.
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.
+
+
Request Syntax
1
+2
+3
+4
DELETE /ObjectName?uploadId=uplaodID HTTP/1.1
+Host: bucketname.obs.region.example.com
+Date: date
+Authorization: auth
+
+
+
+
Request Parameters
This request uses message parameters to specify the multipart upload task number of the segment task. Table 1 describes the parameters.
+
+
Table 1 Request parameters
Parameter
+
+
Description
+
+
Mandatory
+
+
+
+
uploadId
+
+
Indicates a multipart upload.
+
Type: string
+
+
Yes
+
+
+
+
+
+
+
Request Headers
This request uses common headers. For details, see Table 3.
+
+
Request Elements
This request involves no elements.
+
+
Response Syntax
HTTP/1.1 status_code
+Date: date
+
+
Response Headers
The response to the request uses common headers. For details, see Table 1.
+
+
Response Elements
This response involves no elements.
+
+
Error Responses
If the AK or signature is invalid, OBS returns 403 Forbidden and the error code is AccessDenied.
If the requested bucket does not exist, OBS returns 404 Not Found and the error code is NoSuchBucket.
If you are neither the initiator of a multipart upload nor the bucket owner, OBS returns 403 Forbidden.
If the operation is successful, OBS returns 204 No Content to the user.
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 key type to meet site requirements. Two server-side encryption modes are supported: KMS server-side encryption (SSE-KMS) and server-side encryption (SSE-C) provided by the customer. Both the two modes use the industry-standard AES256 encryption algorithm.
+
In the SSE-KMS mode, OBS uses the keys provided by KMS for server-side encryption.
+
In the SSE-C mode, OBS uses the keys and MD5 values provided by customers for server-side encryption.
+
When server-side encryption is used, the returned ETag value is not the MD5 value of the object. OBS will verify the MD5 value of an uploaded object when the upload request carries the Content-MD5 header field, no matter whether server-side encryption is used or not.
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 time, OBS creates a default customer master key (CMK), which is used to encrypt and decrypt the keys provided by KMS. The SSE-KMS mode does not support the keys created by customers. The bucket ACL and policy do not allow cross-tenant authorized access to objects encrypted using SSE-KMS.
+
Two headers are added to support SSE-KMS in SSE-KMS mode.
+
You can also configure the default encryption method for a bucket to encrypt objects in the bucket. When default encryption is enabled for a bucket, any request for uploading objects without specified encryption header will trigger the default bucket encryption for the objects uploaded. For more information about bucket encryption configuration, see Configuring Bucket Encryption.
+
+
Table 1 Header fields used in SSE-KMS mode
Element
+
+
Description
+
+
+
+
x-obs-server-side-encryption
+
+
Indicates that SSE-KMS is used. Objects are encrypted using SSE-KMS.
+
Type: string
+
Example: x-obs-server-side-encryption:kms
+
+
+
x-obs-server-side-encryption-kms-key-id
+
+
Indicates the master key ID of an encrypted object. This header is used in SSE-KMS mode. If the customer does not provide the master key ID, the default master key ID will be used.
+
Type: string
+
The following two formats are supported:
+
1. regionID:domainID:key/key_id
+
2. key_id
+
regionID is the ID of the region to which the key belongs. domainID is the account ID of the tenant to which the key belongs. key_id is the key ID created inKMS.
API operations to which the newly added headers apply:
+
PUT operation for uploading objects
POST operation for uploading objects (x-obs-server-side-encryption and x-obs-server-side-encryption-kms-key-id need to be placed in the table instead of the header field)
PutObject-Copy (the newly added headers apply to target objects)
API operations for initiating a multipart upload task
+
OBS supports bucket policies. You can use a bucket policy to implement server-side encryption on all the objects stored in a bucket. For example, a tenant's object upload request does not contain the header x-obs-server-side-encryption:"kms" for server-side encryption (SSE-KMS), the following bucket policy will reject the upload request.
Indicates the MD5 value of the key used to encrypt an object. The header is used in SSE-C mode. The value of the element is an MD5 Base64-encoded hash. The MD5 value is used to check whether any error occurs during the transmission of the key.
Indicates the MD5 value of the key used to decrypt a source object. The header is used in SSE-C mode. The MD5 value is used to check whether any error occurs during the transmission of the key.
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 3xx, 4xx or 5xx is returned. The response body contains the specific error code and information.
+
Error Response Syntax
When an error occurs, the response header information contains:
+
Content-Type: application/xml
HTTP error status code 3xx, 4xx, or 5xx
+
+
The response body also contains information about the error. The following is an error response example that shows common elements in the Representational State Transfer (REST) error response body.
+
1
+2
+3
+4
+5
+6
+7
+8
+9
<?xml version="1.0" encoding="UTF-8"?>
+<Error>
+<Code>NoSuchKey</Code>
+<Message>The resource you requested does not exist</Message>
+<Resource>/example-bucket/object</Resource>
+<RequestId>001B21A61C6C0000013402C4616D5285</RequestId>
+<HostId>RkRCRDJENDc5MzdGQkQ4OUY3MTI4NTQ3NDk2Mjg0M0FB
+QUFBQUFBYmJiYmJiYmJD</HostId>
+</Error>
+
Root element that describes the error in an XML response body
+
+
+
Code
+
+
HTTP return code that corresponds to the error in the XML response body. For details about error codes, see Table 2.
+
+
+
Message
+
+
Details the error in the XML error response body. For details about error messages, see Table 2.
+
+
+
RequestId
+
+
ID of the request whose error response is returned. The ID is used for locating the error.
+
+
+
HostId
+
+
ID of the server that returns an error response
+
+
+
Resource
+
+
Bucket or object related to an error.
+
+
+
+
+
+
Some error responses contain more detailed information. It is recommended that all error information be logged for easier rectification of errors.
+
+
+
Description
If OBS encounters an error when processing a request, a response containing the error code and description is returned. Table 2 describes the error codes of OBS.
+
+
+
Table 2 Error codes
Status Code
+
+
Error Code
+
+
Error Message
+
+
Solution
+
+
+
+
301 Moved Permanently
+
+
PermanentRedirect
+
+
The requested bucket can be accessed only through the specified address. Send subsequent requests to the address.
+
+
Send the request to the returned redirection address.
+
+
+
301 Moved Permanently
+
+
WebsiteRedirect
+
+
The website request lacks bucketName.
+
+
Put the bucket name in the request and try again.
+
+
+
307 Moved Temporarily
+
+
TemporaryRedirect
+
+
Temporary redirection. If the DNS is updated, the request is redirected to the bucket.
+
+
The system automatically redirects the request or sends the request to the redirection address.
+
+
+
400 Bad Request
+
+
BadDigest
+
+
The specified value of Content-MD5 does not match the value received by OBS.
+
+
Check whether the MD5 value carried in the header is the same as that calculated by the message body.
+
+
+
400 Bad Request
+
+
BadDomainName
+
+
The domain name is invalid.
+
+
Use a valid domain name.
+
+
+
400 Bad Request
+
+
BadRequest
+
+
Invalid request parameters.
+
+
Modify the parameters according to the error details in the message body.
+
+
+
400 Bad Request
+
+
CustomDomainAreadyExist
+
+
The configured domain already exists.
+
+
It has been configured and does not need to be configured again.
+
+
+
400 Bad Request
+
+
CustomDomainNotExist
+
+
Delete the domain that does not exist.
+
+
It is not configured or has been deleted. You do not need to delete it.
+
+
+
400 Bad Request
+
+
EntityTooLarge
+
+
The size of the object uploaded using the POST method exceeds the upper limit.
+
+
Modify the conditions specified in the policy when posting the object or reduce the object size.
+
+
+
400 Bad Request
+
+
EntityTooSmall
+
+
The size of the object uploaded using the POST method does not reach the lower limit.
+
+
Modify the conditions specified in the policy when posting the object or increase the object size.
+
+
+
400 Bad Request
+
+
IllegalLocationConstraintException
+
+
A request without Location is sent for creating a bucket in a non-default region.
+
+
Send the bucket creation request to the default region, or send the request with the Location of the non-default region.
+
+
+
400 Bad Request
+
+
IncompleteBody
+
+
No complete request body is received due to network or other problems.
+
+
Upload the object again.
+
+
+
400 Bad Request
+
+
IncorrectNumberOfFilesInPost Request
+
+
Each POST request must contain one file to be uploaded.
+
+
Carry a file to be uploaded.
+
+
+
400 Bad Request
+
+
InvalidArgument
+
+
Invalid parameter.
+
+
Modify the parameter according to the error details in the message body.
+
+
+
400 Bad Request
+
+
InvalidBucket
+
+
The bucket to be accessed does not exist.
+
+
Change the bucket name.
+
+
+
400 Bad Request
+
+
InvalidBucketName
+
+
The bucket name specified in the request is invalid, which may have exceeded the maximum length, or contain special characters that are not allowed.
+
+
Change the bucket name.
+
+
+
400 Bad Request
+
+
InvalidEncryptionAlgorithmError
+
+
Incorrect encryption algorithm. The object cannot be decrypted due to incorrect encryption header carried when downloading the SSE-C encrypted object.
+
+
Carry the correct encryption header when downloading the object.
+
+
+
400 Bad Request
+
+
InvalidLocationConstraint
+
+
The specified Location in the bucket creation request is invalid or does not exist.
+
+
Correct the Location in the bucket creation request.
+
+
+
400 Bad Request
+
+
InvalidPart
+
+
One or more specified parts are not found. The parts may not be uploaded or the specified entity tags (ETags) do not match the parts' ETags.
+
+
Merge the parts correctly according to the ETags.
+
+
+
400 Bad Request
+
+
InvalidPartOrder
+
+
Parts are not listed in ascending order by part number.
+
+
Sort the parts in ascending order and merge them again.
+
+
+
400 Bad Request
+
+
InvalidPolicyDocument
+
+
The content of the form does not meet the conditions specified in the policy document.
+
+
Modify the policy in the constructed form according to the error details in the message body and try again.
+
+
+
400 Bad Request
+
+
InvalidRedirectLocation
+
+
Invalid redirect location.
+
+
Specifies the correct IP address.
+
+
+
400 Bad Request
+
+
InvalidRequest
+
+
Invalid request.
+
+
Modify the parameter according to the error details in the message body.
+
+
+
400 Bad Request
+
+
InvalidRequestBody
+
+
The request body is invalid. The request requires a message body but no message body is uploaded.
+
+
Upload the message body in the correct format.
+
+
+
400 Bad Request
+
+
InvalidTargetBucketForLogging
+
+
The delivery group has no ACL permission for the target bucket.
+
+
Configure the target bucket ACL and try again.
+
+
+
400 Bad Request
+
+
KeyTooLongError
+
+
The provided key is too long.
+
+
Use a shorter key.
+
+
+
400 Bad Request
+
+
KMS.DisabledException
+
+
The customer master key (CMK) is disabled in SSE-KMS mode.
+
+
Replace the key and try again, or contact with the technical support.
+
+
+
400 Bad Request
+
+
KMS.NotFoundException
+
+
The customer master key (CMK) does not exist in SSE-KMS mode.
+
+
Retry with the correct CMK.
+
+
+
400 Bad Request
+
+
MalformedACLError
+
+
The provided XML file is in an incorrect format or does not meet format requirements.
+
+
Use the correct XML format to retry.
+
+
+
400 Bad Request
+
+
MalformedError
+
+
The XML format in the request is incorrect.
+
+
Use the correct XML format to retry.
+
+
+
400 Bad Request
+
+
MalformedLoggingStatus
+
+
The XML format of Logging is incorrect.
+
+
Use the correct XML format to retry.
+
+
+
400 Bad Request
+
+
MalformedPolicy
+
+
The bucket policy does not pass.
+
+
Modify the bucket policy according to the error details returned in the message body.
+
+
+
400 Bad Request
+
+
MalformedQuotaError
+
+
The Quota XML format is incorrect.
+
+
Use the correct XML format to retry.
+
+
+
400 Bad Request
+
+
MalformedXML
+
+
An XML file of a configuration item is in incorrect format.
+
+
Use the correct XML format to retry.
+
+
+
400 Bad Request
+
+
MaxMessageLengthExceeded
+
+
Copying an object does not require a message body in the request.
+
+
Remove the message body and retry.
+
+
+
400 Bad Request
+
+
MetadataTooLarge
+
+
The size of the metadata header has exceeded the upper limit.
+
+
Reduce the size of the metadata header.
+
+
+
400 Bad Request
+
+
MissingRegion
+
+
No region contained in the request and no default region defined in the system.
+
+
Carry the region information in the request.
+
+
+
400 Bad Request
+
+
MissingRequestBodyError
+
+
This error code is returned after you send an empty XML file.
+
+
Provide the correct XML file.
+
+
+
400 Bad Request
+
+
MissingRequiredHeader
+
+
Required headers are missing in the request.
+
+
Provide required headers.
+
+
+
400 Bad Request
+
+
MissingSecurityHeader
+
+
A required header is not provided.
+
+
Provide required headers.
+
+
+
400 Bad Request
+
+
TooManyBuckets
+
+
You have attempted to create more buckets than allowed.
+
+
Delete some buckets and try again.
+
+
+
400 Bad Request
+
+
TooManyCustomDomains
+
+
Too many user accounts are configured.
+
+
Delete some user accounts and try again.
+
+
+
400 Bad Request
+
+
TooManyWrongSignature
+
+
The request is rejected due to high-frequency errors.
+
+
Replace the Access Key and try again.
+
+
+
400 Bad Request
+
+
UnexpectedContent
+
+
The request requires a message body which is not carried by the client, or the request does not require a message body but the client carries the message body.
+
+
Try again according to the instruction.
+
+
+
400 Bad Request
+
+
UserKeyMustBeSpecified
+
+
This operation is available only to specific users.
+
+
Contact technical support.
+
+
+
403 Forbidden
+
+
AccessDenied
+
+
Access denied, because the request does not carry a date header or the header format is incorrect.
+
+
Provide a correct date header in the request.
+
+
+
403 Forbidden
+
+
AccessForbidden
+
+
Insufficient permission. No CORS configuration exists for the bucket or the CORS rule does not match.
+
+
Modify the CORS configuration of the bucket or send the matched OPTIONS request based on the CORS configuration of the bucket.
+
+
+
403 Forbidden
+
+
AllAccessDisabled
+
+
You have no permission to perform the operation. The bucket name is forbidden.
+
+
Change the bucket name.
+
+
+
403 Forbidden
+
+
DeregisterUserId
+
+
The user has been deregistered.
+
+
Top up or re-register.
+
+
+
403 Forbidden
+
+
InArrearOrInsufficientBalance
+
+
The subscriber owes fees or the account balance is insufficient, and the subscriber does not have the permission to perform an operation.
+
+
Top up.
+
+
+
403 Forbidden
+
+
InsufficientStorageSpace
+
+
Insufficient storage space.
+
+
If the quota is exceeded, increase quota or delete some objects.
+
+
+
403 Forbidden
+
+
InvalidAccessKeyId
+
+
The access key ID provided by the customer does not exist in the system.
+
+
Provide correct access key Id.
+
+
+
403 Forbidden
+
+
InvalidObjectState
+
+
You need to restore Cold objects first before downloading them.
+
+
Restore the object first.
+
+
+
403 Forbidden
+
+
NotSignedUp
+
+
Your account has not been registered with the system. Only a registered account can be used.
+
+
Register OBS.
+
+
+
403 Forbidden
+
+
RequestTimeTooSkewed
+
+
There was a large time offset between the OBS server time and the time when the client initiated a request.
+
For security purposes, OBS verifies the time offset between the client and server. If the offset is longer than 15 minutes, the OBS server will reject your requests and this error message is reported.
+
+
Check whether there is a large time offset between the client time and server time. If there is, adjust the client time based on your local time (UTC) and try again.
+
+
+
403 Forbidden
+
+
SignatureDoesNotMatch
+
+
The provided signature does not match the signature calculated by OBS.
+
+
Check your secret access key and signature algorithm.
When an API is called, 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 is as follows:
+
Log in to the console.
Click the username and select My Credentials from the drop-down list.
On the My Credentials page, view the domain ID and user ID.
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 times out in waiting for a response, or the server returns HTTP response status code 500 or 503, the subsequent read operations may fail. If such an error occurs, query whether the data has been successfully uploaded to the server. If not, upload the data again.
+
If a client simultaneously uploads, queries, or deletes the same object or bucket, these operations may reach the system at different times and have different latency periods, so different results may return. For example, if multiple clients simultaneously upload the same object, the latest upload request received by the system will replace the previous one. If you want to prevent an object from being simultaneously accessed, you must add a lock mechanism for the object in upper-layer applications.
+
Example of Concurrent Operations
1. When client1 is uploading an object V1, client2 is uploading an object V2 with the same name. After the successful uploads, both client1 and client2 can access the latest object data V2, as shown in Figure 1.
+
Figure 1 Concurrent upload of the same object
+
2. When client2 is uploading an object V1 and object metadata is not written yet, client1 deletes an object with the same name. In this scenario, the upload operation of client2 is still successful, and both client1 and client2 can access data object V1, as shown in Figure 2.
+
Figure 2 Concurrent upload and deletion of the same object (1)
+
3. When client2 has successfully uploaded an object V1 and object metadata is still being written, client1 deletes an object with the same name. In this scenario, the upload operation of client2 is still successful. However, when client1 and client2 attempt to download the object, they may be able to access data object V1, or an error may be returned indicating that the object does not exist, as shown in Figure 3.
+
Figure 3 Concurrent upload and deletion of the same object (2)
+
4. When client1 is downloading an object, client2 deletes an object with the same name. In this scenario, client1 may have downloaded a full copy or only part of the object data. After a deletion success message is returned to client2, an attempt to download the object will fail, and an error will be returned indicating that the object does not exist, as shown in Figure 4.
+
Figure 4 Concurrent download and deletion of the same object
+
5. When client1 is downloading an object, client2 is updating an object with the same name. In this scenario, client1 may have downloaded a full copy or only part of the object data. After an update success message is returned to client 2, an attempt to download the object will succeed, and the latest data will be returned, as shown in Figure 5.
+
Figure 5 Concurrent download and update of the same object
+
6. When client2 is uploading part V1 of an object, client1 is uploading part V2 of the same object. After part V2 is uploaded successfully, both client1 and client2 can list the information about the multipart whose entity tag (ETag) is part V2, as shown in Figure 6.
+
Figure 6 Concurrently uploading the same part of the same object
+
+
+
\ No newline at end of file
diff --git a/docs/obs/api-ref/public_sys-resources/ExpandCollapse.js b/docs/obs/api-ref/public_sys-resources/ExpandCollapse.js
new file mode 100644
index 00000000..116ddaab
--- /dev/null
+++ b/docs/obs/api-ref/public_sys-resources/ExpandCollapse.js
@@ -0,0 +1 @@
+var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(a.substring(a.lastIndexOf("#")+1))}}catch(c){}};
\ No newline at end of file
diff --git a/docs/obs/api-ref/public_sys-resources/avgCompile.js b/docs/obs/api-ref/public_sys-resources/avgCompile.js
new file mode 100644
index 00000000..32782268
--- /dev/null
+++ b/docs/obs/api-ref/public_sys-resources/avgCompile.js
@@ -0,0 +1 @@
+var name1=null;function test1(a){a=a.parentNode;a.className="test1"}function test2(a){a=a.parentNode;a.className="test2"}function test3(a){a=a.parentNode;a.className="test3"}function test4(a){a=a.parentNode;a.className="test4"}function test5(a){a=a.parentNode;a.className="test5"}function test6(a){a=a.parentNode;a.className="test6"}function test7(a){a=a.parentNode;a.className="test7"}function test8(a){a=a.parentNode;a.className="test8"}function test9(a){a=a.parentNode;a.className="test9"}function test10(a){a=a.parentNode;a.className="test10"}function test11(a){a=a.parentNode;a.className="test11"}function test12(a){a=a.parentNode;a.className="test12"}function test13(a){a=a.parentNode;a.className="test13"}function test2(a){a=a.parentNode;a.className="test2"}function test14(a){a=a.parentNode;a.className="test14"}function test15(a){a=a.parentNode;a.className="test15"}function test16(a){a=a.parentNode;a.className="test16"}function test17(a){a=a.parentNode;a.className="test17"}function test18(a){a=a.parentNode;a.className="test18"}function test19(a){a=a.parentNode;a.className="test19"}function test20(a){a=a.parentNode;a.className="test20"}function test21(a){a=a.parentNode;a.className="test21"}function test22(a){a=a.parentNode;a.className="test22"}function test23(a){a=a.parentNode;a.className="test23"};
\ No newline at end of file
diff --git a/docs/obs/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/obs/api-ref/public_sys-resources/caution_3.0-en-us.png
new file mode 100644
index 00000000..60f60762
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/caution_3.0-en-us.png differ
diff --git a/docs/obs/api-ref/public_sys-resources/commonltr.css b/docs/obs/api-ref/public_sys-resources/commonltr.css
new file mode 100644
index 00000000..c5480b0a
--- /dev/null
+++ b/docs/obs/api-ref/public_sys-resources/commonltr.css
@@ -0,0 +1 @@
+body{font-size:10pt;font-family:Arial;margin:1.5em;border-top:2pt;padding-top:1em;padding-bottom:2em}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:.6em;margin-bottom:.6em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.figcap{font-size:10pt}img{margin-top:.3em}.figdesc{font-style:normal}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.fignone{font-size:10pt;margin-top:8pt;margin-bottom:8pt}.familylinks{margin-top:1.5em;margin-bottom:1em}.ullinks{list-style-type:none}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-top:.6em;margin-bottom:.6em}.reltasks{margin-top:.6em;margin-bottom:.6em}.relref{margin-top:.6em;margin-bottom:.6em}.relinfo{margin-top:.6em;margin-bottom:.6em}.breadcrumb{font-size:smaller;margin-bottom:.6em}.prereq{margin-left:20px}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.topictitle1{margin-top:0;margin-bottom:1em;font-size:14pt;color:#007af4}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;color:#007af4}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;color:#007af4}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:1em;color:black;font-size:10.5pt;font-weight:bold;color:#007af4;overflow:auto}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.sectiontitle2contents:link{color:#007af4}.sectiontitle2contents:visited{color:#800080}.note{margin-top:1em;margin-bottom:1em;background-color:#ffc}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em;background-color:#ffc}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em;background-color:#ffc}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em;background-color:#ffc}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em;background-color:#ffc}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em;background-color:#ffc}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em;background-color:#ffc}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;background-color:#ffc}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;background-color:#ffc}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;background-color:#ffc}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;background-color:#ffc}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}ol{margin-top:1em;margin-bottom:1em;margin-left:2.4em;padding-left:0}ul{margin-top:1em;margin-bottom:1em;margin-left:2.0em;padding-left:0}ol ul{list-style:disc}ul ul{list-style:square}ol ul ul{list-style:square}ol ul{list-style-type:disc}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}.firstcol{font-weight:bold}th{background-color:#cfcfcf}table{margin-top:8pt;margin-bottom:12pt;width:100%}table caption{margin-top:8pt;text-align:left}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}
\ No newline at end of file
diff --git a/docs/obs/api-ref/public_sys-resources/commonltr_print.css b/docs/obs/api-ref/public_sys-resources/commonltr_print.css
new file mode 100644
index 00000000..a5982314
--- /dev/null
+++ b/docs/obs/api-ref/public_sys-resources/commonltr_print.css
@@ -0,0 +1 @@
+body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm}
\ No newline at end of file
diff --git a/docs/obs/api-ref/public_sys-resources/commonrtl.css b/docs/obs/api-ref/public_sys-resources/commonrtl.css
new file mode 100644
index 00000000..f261da75
--- /dev/null
+++ b/docs/obs/api-ref/public_sys-resources/commonrtl.css
@@ -0,0 +1,2 @@
+/*! Copyright (c) Huawei Technologies Co., Ltd. 2020-2022. All rights reserved. */.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式
+*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre}
\ No newline at end of file
diff --git a/docs/obs/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/obs/api-ref/public_sys-resources/danger_3.0-en-us.png
new file mode 100644
index 00000000..47a9c723
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/danger_3.0-en-us.png differ
diff --git a/docs/obs/api-ref/public_sys-resources/delta.gif b/docs/obs/api-ref/public_sys-resources/delta.gif
new file mode 100644
index 00000000..0d1b1f67
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/delta.gif differ
diff --git a/docs/obs/api-ref/public_sys-resources/deltaend.gif b/docs/obs/api-ref/public_sys-resources/deltaend.gif
new file mode 100644
index 00000000..cc7da0fc
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/deltaend.gif differ
diff --git a/docs/obs/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/obs/api-ref/public_sys-resources/icon-arrowdn.gif
new file mode 100644
index 00000000..84eec9be
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/icon-arrowdn.gif differ
diff --git a/docs/obs/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/obs/api-ref/public_sys-resources/icon-arrowrt.gif
new file mode 100644
index 00000000..39583d16
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/icon-arrowrt.gif differ
diff --git a/docs/obs/api-ref/public_sys-resources/icon-caution.gif b/docs/obs/api-ref/public_sys-resources/icon-caution.gif
new file mode 100644
index 00000000..079c79b2
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/icon-caution.gif differ
diff --git a/docs/obs/api-ref/public_sys-resources/icon-danger.gif b/docs/obs/api-ref/public_sys-resources/icon-danger.gif
new file mode 100644
index 00000000..079c79b2
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/icon-danger.gif differ
diff --git a/docs/obs/api-ref/public_sys-resources/icon-huawei.gif b/docs/obs/api-ref/public_sys-resources/icon-huawei.gif
new file mode 100644
index 00000000..a31d60f8
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/icon-huawei.gif differ
diff --git a/docs/obs/api-ref/public_sys-resources/icon-note.gif b/docs/obs/api-ref/public_sys-resources/icon-note.gif
new file mode 100644
index 00000000..31be2b03
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/icon-note.gif differ
diff --git a/docs/obs/api-ref/public_sys-resources/icon-notice.gif b/docs/obs/api-ref/public_sys-resources/icon-notice.gif
new file mode 100644
index 00000000..40907065
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/icon-notice.gif differ
diff --git a/docs/obs/api-ref/public_sys-resources/icon-tip.gif b/docs/obs/api-ref/public_sys-resources/icon-tip.gif
new file mode 100644
index 00000000..c47bae05
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/icon-tip.gif differ
diff --git a/docs/obs/api-ref/public_sys-resources/icon-warning.gif b/docs/obs/api-ref/public_sys-resources/icon-warning.gif
new file mode 100644
index 00000000..079c79b2
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/icon-warning.gif differ
diff --git a/docs/obs/api-ref/public_sys-resources/imageResize.js b/docs/obs/api-ref/public_sys-resources/imageResize.js
new file mode 100644
index 00000000..37309ce3
--- /dev/null
+++ b/docs/obs/api-ref/public_sys-resources/imageResize.js
@@ -0,0 +1,18 @@
+/** IDP renames $ to $$$,jQueryHW2 */
+var $$$, jQueryHW2;
+jQueryHW2 = $$$ = $;
+
+function image_size(a) {
+ $$$(window).on('load', function () {
+ $$$(a).each(function () {
+ var e = $$$(this);
+ var f = e.width();
+ var d = e.height();
+ var b = f;
+ var c = d;
+ e.click(function () {
+ tb_show("", this.src, false)
+ })
+ })
+ })
+};
\ No newline at end of file
diff --git a/docs/obs/api-ref/public_sys-resources/imageclose.gif b/docs/obs/api-ref/public_sys-resources/imageclose.gif
new file mode 100644
index 00000000..3a3344af
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/imageclose.gif differ
diff --git a/docs/obs/api-ref/public_sys-resources/imageclosehover.gif b/docs/obs/api-ref/public_sys-resources/imageclosehover.gif
new file mode 100644
index 00000000..8699d5e3
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/imageclosehover.gif differ
diff --git a/docs/obs/api-ref/public_sys-resources/imagemax.gif b/docs/obs/api-ref/public_sys-resources/imagemax.gif
new file mode 100644
index 00000000..99c07dc2
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/imagemax.gif differ
diff --git a/docs/obs/api-ref/public_sys-resources/imagemaxhover.gif b/docs/obs/api-ref/public_sys-resources/imagemaxhover.gif
new file mode 100644
index 00000000..d01d77d6
Binary files /dev/null and b/docs/obs/api-ref/public_sys-resources/imagemaxhover.gif differ
diff --git a/docs/obs/api-ref/public_sys-resources/jquery-migrate-1.2.1.min.js b/docs/obs/api-ref/public_sys-resources/jquery-migrate-1.2.1.min.js
new file mode 100644
index 00000000..88f4844b
--- /dev/null
+++ b/docs/obs/api-ref/public_sys-resources/jquery-migrate-1.2.1.min.js
@@ -0,0 +1,2 @@
+/*! jQuery Migrate v1.2.1 | (c) 2005, 2013 jQuery Foundation, Inc. and other contributors | jquery.org/license */
+jQueryHW2.migrateMute===void 0&&(jQueryHW2.migrateMute=!0),function(e,t,n){function r(n){}function a(t,a,i,o){if(Object.defineProperty)try{return Object.defineProperty(t,a,{configurable:!0,enumerable:!0,get:function(){return r(o),i},set:function(e){r(o),i=e}}),n}catch(s){}e._definePropertyBroken=!0,t[a]=i}var i={};e.migrateWarnings=[],!e.migrateMute,e.migrateTrace===n&&(e.migrateTrace=!0),e.migrateReset=function(){i={},e.migrateWarnings.length=0},"BackCompat"===document.compatMode&&r("jQueryHW2 is not compatible with Quirks Mode");var o=e("",{size:1}).attr("size")&&e.attrFn,s=e.attr,u=e.attrHooks.value&&e.attrHooks.value.get||function(){return null},c=e.attrHooks.value&&e.attrHooks.value.set||function(){return n},l=/^(?:input|button)$/i,d=/^[238]$/,p=/^(?:autofocus|autoplay|async|checked|controls|defer|disabled|hidden|loop|multiple|open|readonly|required|scoped|selected)$/i,f=/^(?:checked|selected)$/i;a(e,"attrFn",o||{},"jQueryHW2.attrFn is deprecated"),e.attr=function(t,a,i,u){var c=a.toLowerCase(),g=t&&t.nodeType;return u&&(4>s.length&&r("jQueryHW2.fn.attr( props, pass ) is deprecated"),t&&!d.test(g)&&(o?a in o:e.isFunction(e.fn[a])))?e(t)[a](i):("type"===a&&i!==n&&l.test(t.nodeName)&&t.parentNode&&r("Can't change the 'type' of an input or button in IE 6/7/8"),!e.attrHooks[c]&&p.test(c)&&(e.attrHooks[c]={get:function(t,r){var a,i=e.prop(t,r);return i===!0||"boolean"!=typeof i&&(a=t.getAttributeNode(r))&&a.nodeValue!==!1?r.toLowerCase():n},set:function(t,n,r){var a;return n===!1?e.removeAttr(t,r):(a=e.propFix[r]||r,a in t&&(t[a]=!0),t.setAttribute(r,r.toLowerCase())),r}},f.test(c)&&r("jQueryHW2.fn.attr('"+c+"') may use property instead of attribute")),s.call(e,t,a,i))},e.attrHooks.value={get:function(e,t){var n=(e.nodeName||"").toLowerCase();return"button"===n?u.apply(this,arguments):("input"!==n&&"option"!==n&&r("jQueryHW2.fn.attr('value') no longer gets properties"),t in e?e.value:null)},set:function(e,t){var a=(e.nodeName||"").toLowerCase();return"button"===a?c.apply(this,arguments):("input"!==a&&"option"!==a&&r("jQueryHW2.fn.attr('value', val) no longer sets properties"),e.value=t,n)}};var g,h,v=e.fn.init,m=e.parseJSON,y=/^([^<]*)(<[\w\W]+>)([^>]*)$/;e.fn.init=function(t,n,a){var i;return t&&"string"==typeof t&&!e.isPlainObject(n)&&(i=y.exec(e.trim(t)))&&i[0]&&("<"!==t.charAt(0)&&r("$(html) HTML strings must start with '<' character"),i[3]&&r("$(html) HTML text after last tag is ignored"),"#"===i[0].charAt(0)&&(r("HTML string cannot start with a '#' character"),e.error("JQMIGRATE: Invalid selector string (XSS)")),n&&n.context&&(n=n.context),e.parseHTML)?v.call(this,e.parseHTML(i[2],n,!0),n,a):v.apply(this,arguments)},e.fn.init.prototype=e.fn,e.parseJSON=function(e){return e||null===e?m.apply(this,arguments):(r("jQueryHW2.parseJSON requires a valid JSON string"),null)},e.uaMatch=function(e){e=e.toLowerCase();var t=/(chrome)[ \/]([\w.]+)/.exec(e)||/(webkit)[ \/]([\w.]+)/.exec(e)||/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(e)||/(msie) ([\w.]+)/.exec(e)||0>e.indexOf("compatible")&&/(mozilla)(?:.*? rv:([\w.]+)|)/.exec(e)||[];return{browser:t[1]||"",version:t[2]||"0"}},e.browser||(g=e.uaMatch(navigator.userAgent),h={},g.browser&&(h[g.browser]=!0,h.version=g.version),h.chrome?h.webkit=!0:h.webkit&&(h.safari=!0),e.browser=h),a(e,"browser",e.browser,"jQueryHW2.browser is deprecated"),e.sub=function(){function t(e,n){return new t.fn.init(e,n)}e.extend(!0,t,this),t.superclass=this,t.fn=t.prototype=this(),t.fn.constructor=t,t.sub=this.sub,t.fn.init=function(r,a){return a&&a instanceof e&&!(a instanceof t)&&(a=t(a)),e.fn.init.call(this,r,a,n)},t.fn.init.prototype=t.fn;var n=t(document);return r("jQueryHW2.sub() is deprecated"),t},e.ajaxSetup({converters:{"text json":e.parseJSON}});var b=e.fn.data;e.fn.data=function(t){var a,i,o=this[0];return!o||"events"!==t||1!==arguments.length||(a=e.data(o,t),i=e._data(o,t),a!==n&&a!==i||i===n)?b.apply(this,arguments):(r("Use of jQueryHW2.fn.data('events') is deprecated"),i)};var j=/\/(java|ecma)script/i,w=e.fn.andSelf||e.fn.addBack;e.fn.andSelf=function(){return r("jQueryHW2.fn.andSelf() replaced by jQueryHW2.fn.addBack()"),w.apply(this,arguments)},e.clean||(e.clean=function(t,a,i,o){a=a||document,a=!a.nodeType&&a[0]||a,a=a.ownerDocument||a,r("jQueryHW2.clean() is deprecated");var s,u,c,l,d=[];if(e.merge(d,e.buildFragment(t,a).childNodes),i)for(c=function(e){return!e.type||j.test(e.type)?o?o.push(e.parentNode?e.parentNode.removeChild(e):e):i.appendChild(e):n},s=0;null!=(u=d[s]);s++)e.nodeName(u,"script")&&c(u)||(i.appendChild(u),u.getElementsByTagName!==n&&(l=e.grep(e.merge([],u.getElementsByTagName("script")),c),d.splice.apply(d,[s+1,0].concat(l)),s+=l.length));return d});var Q=e.event.add,x=e.event.remove,k=e.event.trigger,N=e.fn.toggle,T=e.fn.live,M=e.fn.die,S="ajaxStart|ajaxStop|ajaxSend|ajaxComplete|ajaxError|ajaxSuccess",C=RegExp("\\b(?:"+S+")\\b"),H=/(?:^|\s)hover(\.\S+|)\b/,A=function(t){return"string"!=typeof t||e.event.special.hover?t:(H.test(t)&&r("'hover' pseudo-event is deprecated, use 'mouseenter mouseleave'"),t&&t.replace(H,"mouseenter$1 mouseleave$1"))};e.event.props&&"attrChange"!==e.event.props[0]&&e.event.props.unshift("attrChange","attrName","relatedNode","srcElement"),e.event.dispatch&&a(e.event,"handle",e.event.dispatch,"jQueryHW2.event.handle is undocumented and deprecated"),e.event.add=function(e,t,n,a,i){e!==document&&C.test(t)&&r("AJAX events should be attached to document: "+t),Q.call(this,e,A(t||""),n,a,i)},e.event.remove=function(e,t,n,r,a){x.call(this,e,A(t)||"",n,r,a)},e.fn.error=function(){var e=Array.prototype.slice.call(arguments,0);return r("jQueryHW2.fn.error() is deprecated"),e.splice(0,0,"error"),arguments.length?this.bind.apply(this,e):(this.triggerHandler.apply(this,e),this)},e.fn.toggle=function(t,n){if(!e.isFunction(t)||!e.isFunction(n))return N.apply(this,arguments);r("jQueryHW2.fn.toggle(handler, handler...) is deprecated");var a=arguments,i=t.guid||e.guid++,o=0,s=function(n){var r=(e._data(this,"lastToggle"+t.guid)||0)%o;return e._data(this,"lastToggle"+t.guid,r+1),n.preventDefault(),a[r].apply(this,arguments)||!1};for(s.guid=i;a.length>o;)a[o++].guid=i;return this.click(s)},e.fn.live=function(t,n,a){return r("jQueryHW2.fn.live() is deprecated"),T?T.apply(this,arguments):(e(this.context).on(t,this.selector,n,a),this)},e.fn.die=function(t,n){return r("jQueryHW2.fn.die() is deprecated"),M?M.apply(this,arguments):(e(this.context).off(t,this.selector||"**",n),this)},e.event.trigger=function(e,t,n,a){return n||C.test(e)||r("Global events are undocumented and deprecated"),k.call(this,e,t,n||document,a)},e.each(S.split("|"),function(t,n){e.event.special[n]={setup:function(){var t=this;return t!==document&&(e.event.add(document,n+"."+e.guid,function(){e.event.trigger(n,null,t,!0)}),e._data(this,n,e.guid++)),!1},teardown:function(){return this!==document&&e.event.remove(document,n+"."+e._data(this,n)),!1}}})}(jQueryHW2,window);
\ No newline at end of file
diff --git a/docs/obs/api-ref/public_sys-resources/jquery-ui.min.js b/docs/obs/api-ref/public_sys-resources/jquery-ui.min.js
new file mode 100644
index 00000000..5a2c95bd
--- /dev/null
+++ b/docs/obs/api-ref/public_sys-resources/jquery-ui.min.js
@@ -0,0 +1,6 @@
+/*! jQuery UI - v1.13.0 - 2021-10-07
+* http://jqueryui.com
+* Includes: widget.js, position.js, data.js, disable-selection.js, effect.js, effects/effect-blind.js, effects/effect-bounce.js, effects/effect-clip.js, effects/effect-drop.js, effects/effect-explode.js, effects/effect-fade.js, effects/effect-fold.js, effects/effect-highlight.js, effects/effect-puff.js, effects/effect-pulsate.js, effects/effect-scale.js, effects/effect-shake.js, effects/effect-size.js, effects/effect-slide.js, effects/effect-transfer.js, focusable.js, form-reset-mixin.js, jquery-patch.js, keycode.js, labels.js, scroll-parent.js, tabbable.js, unique-id.js, widgets/accordion.js, widgets/autocomplete.js, widgets/button.js, widgets/checkboxradio.js, widgets/controlgroup.js, widgets/datepicker.js, widgets/dialog.js, widgets/draggable.js, widgets/droppable.js, widgets/menu.js, widgets/mouse.js, widgets/progressbar.js, widgets/resizable.js, widgets/selectable.js, widgets/selectmenu.js, widgets/slider.js, widgets/sortable.js, widgets/spinner.js, widgets/tabs.js, widgets/tooltip.js
+* Copyright jQuery Foundation and other contributors; Licensed MIT */
+
+!function(t){"use strict";"function"==typeof define&&define.amd?define(["jquery"],t):t(jQuery)}(function(V){"use strict";V.ui=V.ui||{};V.ui.version="1.13.0";var n,i=0,a=Array.prototype.hasOwnProperty,r=Array.prototype.slice;V.cleanData=(n=V.cleanData,function(t){for(var e,i,s=0;null!=(i=t[s]);s++)(e=V._data(i,"events"))&&e.remove&&V(i).triggerHandler("remove");n(t)}),V.widget=function(t,i,e){var s,n,o,a={},r=t.split(".")[0],l=r+"-"+(t=t.split(".")[1]);return e||(e=i,i=V.Widget),Array.isArray(e)&&(e=V.extend.apply(null,[{}].concat(e))),V.expr.pseudos[l.toLowerCase()]=function(t){return!!V.data(t,l)},V[r]=V[r]||{},s=V[r][t],n=V[r][t]=function(t,e){if(!this._createWidget)return new n(t,e);arguments.length&&this._createWidget(t,e)},V.extend(n,s,{version:e.version,_proto:V.extend({},e),_childConstructors:[]}),(o=new i).options=V.widget.extend({},o.options),V.each(e,function(e,s){function n(){return i.prototype[e].apply(this,arguments)}function o(t){return i.prototype[e].apply(this,t)}a[e]="function"==typeof s?function(){var t,e=this._super,i=this._superApply;return this._super=n,this._superApply=o,t=s.apply(this,arguments),this._super=e,this._superApply=i,t}:s}),n.prototype=V.widget.extend(o,{widgetEventPrefix:s&&o.widgetEventPrefix||t},a,{constructor:n,namespace:r,widgetName:t,widgetFullName:l}),s?(V.each(s._childConstructors,function(t,e){var i=e.prototype;V.widget(i.namespace+"."+i.widgetName,n,e._proto)}),delete s._childConstructors):i._childConstructors.push(n),V.widget.bridge(t,n),n},V.widget.extend=function(t){for(var e,i,s=r.call(arguments,1),n=0,o=s.length;n",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=V(e||this.defaultElement||this)[0],this.element=V(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=V(),this.hoverable=V(),this.focusable=V(),this.classesElementLookup={},e!==this&&(V.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=V(e.style?e.ownerDocument:e.document||e),this.window=V(this.document[0].defaultView||this.document[0].parentWindow)),this.options=V.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:V.noop,_create:V.noop,_init:V.noop,destroy:function(){var i=this;this._destroy(),V.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:V.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return V.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=V.widget.extend({},this.options[t]),n=0;n
