1
2
diff --git a/docs/obs/api-ref/obs_04_0062.html b/docs/obs/api-ref/obs_04_0062.html
index 8120d92b0..c6cdc9d89 100644
--- a/docs/obs/api-ref/obs_04_0062.html
+++ b/docs/obs/api-ref/obs_04_0062.html
@@ -88,7 +88,7 @@ Content-Length: length
Server-side encryption algorithm used for the default encryption configuration of a bucket.
Type: string
Value options:
-- kms: SSE-KMS encryption and the AES256 algorithm are used. To use the SM4 algorithm, you need to configure KMSDataEncryption.
- AES256: SSE-OBS encryption and the AES256 algorithm are used.
+- kms: SSE-KMS encryption and the AES256 algorithm are used.
- AES256: SSE-OBS encryption and the AES256 algorithm are used.
Parent: ApplyServerSideEncryptionByDefault
|
Yes
diff --git a/docs/obs/api-ref/obs_04_0071.html b/docs/obs/api-ref/obs_04_0071.html
index cd0379c90..a03b26d1a 100644
--- a/docs/obs/api-ref/obs_04_0071.html
+++ b/docs/obs/api-ref/obs_04_0071.html
@@ -6,7 +6,7 @@
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.
+ The maximum size of a request body for configuring static website hosting for a bucket is 10 KB.
Request Syntax 1
diff --git a/docs/obs/api-ref/obs_04_0074.html b/docs/obs/api-ref/obs_04_0074.html
index bb96c1009..c1864c21f 100644
--- a/docs/obs/api-ref/obs_04_0074.html
+++ b/docs/obs/api-ref/obs_04_0074.html
@@ -2,9 +2,9 @@
Configuring Bucket CORS
FunctionsCross-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.
+ 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 cross-origin requests from another website only after CORS is 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.
+ - With CORS, you can use JavaScript and HTML5 to construct web applications that allow direct access to 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.
Request Syntax 1
@@ -66,7 +66,7 @@ Content-MD5: MD5
Explanation:
Base64-encoded 128-bit MD5 digest of the message according to RFC 1864
Example: n58IG6hfM7vqI4K0vnWpog==
-Restrictions:
+Restrictions:
None
Value range:
None
@@ -116,7 +116,7 @@ Content-MD5: MD5
| Explanation:
CORS rules
Parent: CORSConfiguration
-Restrictions:
+Restrictions:
CORSConfiguration can contain a maximum of 100 rules.
Value range:
None
@@ -155,7 +155,7 @@ Content-MD5: MD5
Value range:
The following HTTP methods are supported:
-Default value:
+Default value:
None
|
|
@@ -185,11 +185,11 @@ Content-MD5: MD5
Explanation:
What headers are allowed in a CORS request. If a CORS request contains the Access-Control-Request-Headers header, the headers listed in this header must match the headers in the AllowedHeader element so that the request can be considered valid. The matching is based on regular expressions.
Parent: CORSRule
-Restrictions:
+Restrictions:
At most one asterisk (*) is allowed. Spaces, ampersands (&), colons (:), less-than signs (<), and full-width characters are not allowed.
Value range:
The value must comply with the CORS protocol and contain 0 to 20480 characters.
-Default value:
+Default value:
None
|
@@ -223,7 +223,7 @@ Content-MD5: MD5
Spaces, asterisks (*), ampersands (&), colons (:), less-than signs (<), and full-width characters are not allowed.
Value range:
The value that complies with the CORS
-Default value:
+Default value:
None
diff --git a/docs/obs/api-ref/obs_04_0079.html b/docs/obs/api-ref/obs_04_0079.html
index 33eb44d40..205bc0af4 100644
--- a/docs/obs/api-ref/obs_04_0079.html
+++ b/docs/obs/api-ref/obs_04_0079.html
@@ -34,9 +34,9 @@
Adding Object Tags
-Obtaining Object Tags
+Obtaining Object Tags
-Deleting Object Tags
+Deleting Object Tags
Configuring WORM Retention for an Object
diff --git a/docs/obs/api-ref/obs_04_0080.html b/docs/obs/api-ref/obs_04_0080.html
index 9409a89f0..8a64a7c62 100644
--- a/docs/obs/api-ref/obs_04_0080.html
+++ b/docs/obs/api-ref/obs_04_0080.html
@@ -100,7 +100,7 @@ Date: date
When creating an object, you can use this header to grant all users in a domain the permissions to read the object and obtain the object metadata.
Example: x-obs-grant-read: id=domainID
Restrictions:
-If multiple domains are authorized, separate them with commas (,).
+Use commas (,) to separate multiple domains.
Value range:
The value must be a valid ID. For details, see Obtaining a Domain ID and a User ID.
Default value:
@@ -117,7 +117,7 @@ Date: date
When creating an object, you can use this header to grant all users in a domain the permissions to obtain the object ACL.
Example: x-obs-grant-read-acp: id=domainID
Restrictions:
-If multiple domains are authorized, separate them with commas (,).
+Use commas (,) to separate multiple domains.
Value range:
The value must be a valid ID. For details, see Obtaining a Domain ID and a User ID.
Default value:
@@ -134,7 +134,7 @@ Date: date
When creating an object, you can use this header to grant all users in a domain the permission to write the object ACL.
Example: x-obs-grant-write-acp: id=domainID
Restrictions:
-If multiple domains are authorized, separate them with commas (,).
+Use commas (,) to separate multiple domains.
Value range:
The value must be a valid ID. For details, see Obtaining a Domain ID and a User ID.
Default value:
@@ -151,7 +151,7 @@ Date: date
When creating an object, you can use this header to grant all users in a domain the permissions to read the object, obtain the object metadata and ACL, and write the object ACL.
Example: x-obs-grant-full-control: id=domainID
Restrictions:
-If multiple domains are authorized, separate them with commas (,).
+Use commas (,) to separate multiple domains.
Value range:
The value must be a valid ID. For details, see Obtaining a Domain ID and a User ID.
Default value:
@@ -182,10 +182,10 @@ Date: date
No
|
Explanation:
-When creating an object, you can use a header starting with x-obs-meta- to define object metadata in an HTTP request. The custom metadata will be returned in the response when you retrieve the object or query the object metadata.
-Example: x-obs-meta-test: test metadata
-Restrictions:
-Both custom metadata keys and their values must conform to US-ASCII standards.
+When creating an object, you can use a header starting with x-obs-meta- to define object metadata in an HTTP request. Such metadata will be returned in the response when you retrieve the object or query the object metadata.
+Example: x-obs-meta-test: test metadata
+Restrictions:
+Both metadata keys and their values must conform to US-ASCII standards.
Value range:
None
Default value:
@@ -200,7 +200,7 @@ Date: date
|
Explanation:
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:
+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:
x-obs-website-redirect-location:http://www.example.com/
@@ -221,7 +221,7 @@ Date: date
| Explanation:
Indicates that SSE-KMS is used.
Example: x-obs-server-side-encryption: kms
-Restrictions:
+Restrictions:
None
Value range:
kms, or AES256
@@ -251,7 +251,7 @@ Date: date
|
Explanation:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm: AES256
+Example: x-obs-server-side-encryption-customer-algorithm: AES256
Restrictions:
- This header is used only when SSE-C is used.
- This header must be used together with x-obs-server-side-encryption-customer-key and x-obs-server-side-encryption-customer-key-MD5.
Value range:
@@ -268,7 +268,7 @@ Date: date
|
Explanation:
The key used for encrypting an object.
-Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
Restrictions:
- This header is used only when SSE-C is used.
- 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.
Value range:
@@ -285,8 +285,8 @@ Date: date
|
Explanation:
The MD5 value of the key used for encryption. The MD5 value is used to check whether any error occurs during the transmission of the key.
-Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Restrictions:
- This header is used only when SSE-C is used.
- 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.
Value range:
MD5 value of the key.
@@ -302,8 +302,8 @@ Date: date
|
Explanation:
The redirection address used when requests were successfully responded to.
-- 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 value is invalid, OBS ignores this parameter. In such case, the Location header is the object address, and OBS returns the response code based on whether the operation succeeds or fails.
-Restrictions:
+- 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 value is invalid, OBS ignores this parameter. In such case, the Location header is the object address, and OBS returns the response code based on whether the operation succeeds or fails.
+Restrictions:
The value must be a valid URL, for example, http://domainname or https://domainname.
Value range:
URL
@@ -321,7 +321,7 @@ Date: date
Specifies when an object expires. It is measured in days. Once the object expires, it is automatically deleted. (The validity calculates from the object's creation time.)
You can configure this field when uploading an object or modify this field by using the metadata modification API after the object is uploaded.
Example: x-obs-expires:3
-Restrictions:
+Restrictions:
The value must be greater than the number of days that have passed since the object was created. For example, if the object was uploaded 10 days ago, you must specify a value greater than 10.
Value range:
The value is an integer greater than 0.
@@ -352,10 +352,10 @@ Date: date
|
No, but required when x-obs-object-lock-retain-until-date is present
|
-Explanation:
+ | Explanation:
WORM mode applied to the object.
Example: x-obs-object-lock-mode:COMPLIANCE
-Restrictions:
+Restrictions:
- Only COMPLIANCE (compliance mode) is supported.
- This parameter must be used together with x-obs-object-lock-retain-until-date.
Value range:
COMPLIANCE
@@ -367,12 +367,12 @@ Date: date
|
String
|
-No, but required when x-obs-object-lock-mode is present.
+ | No, but required when x-obs-object-lock-mode is present.
|
-Explanation:
+ | Explanation:
When the WORM policy of the object expires.
Example: x-obs-object-lock-retain-until-date:2015-07-01T04:11:15Z
-Restrictions:
+Restrictions:
- The value must be a UTC time that complies with the ISO 8601 standard. Example: 2015-07-01T04:11:15Z
- This parameter must be used together with x-obs-object-lock-mode.
Value range:
The time must be later than the current time.
@@ -411,7 +411,7 @@ Content-Type: type
|
Explanation:
Version ID of the object. If versioning is enabled for the bucket, the object version ID will be returned.
-Restrictions:
+Restrictions:
None
Value range:
None
@@ -423,10 +423,10 @@ Content-Type: type
|
String
|
-Explanation:
+ | Explanation:
The encryption method used by the server.
-Example: x-obs-server-side-encryption:kms
-Restrictions:
+Example: x-obs-server-side-encryption:kms
+Restrictions:
This header is included in a response if SSE-KMS is used.
Value range:
@@ -452,8 +452,8 @@ Content-Type: type
|
Explanation:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm: AES256
-Restrictions:
+Example: x-obs-server-side-encryption-customer-algorithm: AES256
+Restrictions:
This header is included in a response if SSE-C is used for server-side encryption.
Value range:
AES256
@@ -467,8 +467,8 @@ Content-Type: type
|
Explanation:
The MD5 value of the key used for encryption.
-Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Restrictions:
This header is included in a response if SSE-C is used for server-side encryption.
Value range:
MD5 value of the key.
@@ -482,7 +482,7 @@ Content-Type: type
|
Explanation:
Storage class of an object
-Restrictions:
+Restrictions:
This header is returned when the storage class of an object is not Standard.
Value range:
@@ -585,13 +585,11 @@ Content-Length: 0
7
8
9
-10
-11 | PUT /object01 HTTP/1.1
+10 | PUT /object01 HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.region.example.com
Accept: */*
Date: WED, 01 Jul 2015 04:17:12 GMT
-x-obs-storage-class: WARM
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:uFVJhp/dJqj/CJIVLrSZ0gpw3ng=
Content-Length: 10240
Expect: 100-continue
@@ -757,12 +755,14 @@ Expect: 100-continue
4
5
6
-7 | | HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BB7800000164846A2112F98BF970AA7E
ETag: "d41d8cd98f00b204e9800998ecf8427e"
x-obs-id-2: a39E0UgAIAABAAAQAAEAABAAAQAAEAABCTPOUJu5XlNyU32fvKjM/92MQZK2gtoB
Date: WED, 01 Jul 2015 04:15:07 GMT
+x-obs-storage-class: WARM
Content-Length: 0
|
diff --git a/docs/obs/api-ref/obs_04_0081.html b/docs/obs/api-ref/obs_04_0081.html
index c57cc0126..cbcc93d22 100644
--- a/docs/obs/api-ref/obs_04_0081.html
+++ b/docs/obs/api-ref/obs_04_0081.html
@@ -9,7 +9,7 @@
A single upload allows at most 5 GB of objects. To upload more than 5 GB of objects, see Operations on Multipart Upload.
This API supports server-side encryption.
- Differences Between PUT and POST MethodsPUT requests include parameters in the header; POST requests in the form.
+ Differences Between PUT and POST MethodsPUT requests include parameters in the header, while POST requests include them in the form.
In the URL, PUT requests require object names be specified; POST requests only require bucket domain names. Request lines of PUT and POST are as follows:
PUT /ObjectName HTTP/1.1
POST / HTTP/1.1
@@ -174,9 +174,9 @@ Upload to OBS HTTP headers in a request. Multiple headers can be included.
Restrictions:
None
-Value range:
+Value range:
An HTTP-compliant header value
-Default value:
+Default value:
None
|
@@ -203,12 +203,12 @@ Upload to OBS Yes
Explanation:
-Object content to upload. Both the file name and path are ignored and will not be used as the object name. The object name is the value of parameter key.
+Object content to upload. Both the file name and path are ignored and will not be used as the object name. The object name is the value of parameter key.
Restrictions:
- This parameter must be the last to specify. Otherwise, the parameters that follow it will be discarded.
- A request can contain only one file parameter.
-Value range:
+Value range:
None
-Default value:
+Default value:
None
|
@@ -218,13 +218,13 @@ Upload to OBS
Yes
|
-Explanation:
+ | Explanation:
Name of the object to be created. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name.
Restrictions:
None
-Value range:
+Value range:
1 to 1,024 characters
-Default value:
+Default value:
None
|
@@ -238,9 +238,9 @@ Upload to OBS Access key ID (AK) of the requester.
Restrictions:
This parameter is mandatory if there is security policy parameter policy or signature in the request.
-Value range:
+Value range:
AK of a user.
-Default value:
+Default value:
None
@@ -254,9 +254,9 @@ Upload to OBS A security policy
Restrictions:
This parameter is mandatory if AccessKeyId or signature is provided in the form.
-Value range:
-For the policy format, see Authentication of Signature Carried in the Table Uploaded Through a Browser.
-Default value:
+Value range:
+For the policy format, see Authenticating the Signature Carried in a Form Uploaded Through a Browser.
+Default value:
None
@@ -270,9 +270,9 @@ Upload to OBS A signature string calculated based on StringToSign.
Restrictions:
This parameter is mandatory if AccessKeyId or policy is provided in the form.
-Value range:
+Value range:
None
-Default value:
+Default value:
None
@@ -282,15 +282,15 @@ Upload to OBS
No
|
-Explanation:
+ | Explanation:
Specifies the access key, signature, and security policy of the requester all together.
Restrictions:
The priority of a token is higher than that of a separately specified AK, signature, or security policy.
Example:
In HTML: <input type= "text" name="token" value="ak:signature:policy" />
-Value range:
+Value range:
The value must be in the ak:signature:policy format.
-Default value:
+Default value:
None
|
@@ -327,9 +327,9 @@ Upload to OBS In HTML: <input type="text" name="grant-read" value="id=domainId1" />
Restrictions:
Use commas (,) to separate multiple domains.
-Value range:
+Value range:
The value of domainId must be valid. For details about how to obtain the ID, see Obtaining a Domain ID and a User ID.
-Default value:
+Default value:
None
@@ -346,9 +346,9 @@ Upload to OBS In HTML: <input type="text" name="grant-read-acp" value="id=domainId1" />
Restrictions:
None
-Value range:
+Value range:
The value of domainId must be valid. For details about how to obtain the ID, see Obtaining a Domain ID and a User ID.
-Default value:
+Default value:
None
@@ -365,9 +365,9 @@ Upload to OBS In HTML: <input type="text" name="grant-write-acp" value="id=domainId1" />
Restrictions:
None
-Value range:
+Value range:
The value of domainId must be valid. For details about how to obtain the ID, see Obtaining a Domain ID and a User ID.
-Default value:
+Default value:
None
@@ -384,9 +384,9 @@ Upload to OBS In HTML: <input type="text" name="grant-full-control" value="id=domainId1" />
Restrictions:
None
-Value range:
+Value range:
The value of domainId must be valid. For details about how to obtain the ID, see Obtaining a Domain ID and a User ID.
-Default value:
+Default value:
None
@@ -415,13 +415,13 @@ Upload to OBS
No
|
-Explanation:
+ | Explanation:
Standard HTTP header, returned in the response if a user downloads the object or makes a Head Object request.
Restrictions:
None
-Value range:
+Value range:
See the HTTP requirements for the Cache-Control header.
-Default value:
+Default value:
None
|
@@ -431,16 +431,16 @@ Upload to OBS
No
|
-Explanation:
+ | Explanation:
Standard HTTP header, returned in the response if a user downloads the object or makes a Head Object request.
Example:
In POLICY: ["starts-with", "$Content-Type", "text/"],
In HTML: <input type="text" name="content-type" value="text/plain" />
Restrictions:
None
-Value range:
+Value range:
See the HTTP requirements for the Content-Type header.
-Default value:
+Default value:
None
|
@@ -450,13 +450,13 @@ Upload to OBS
No
|
-Explanation:
+ | Explanation:
Standard HTTP header, returned in the response if a user downloads the object or makes a Head Object request.
Restrictions:
None
-Value range:
+Value range:
See the HTTP requirements for the Content-Disposition header.
-Default value:
+Default value:
None
|
@@ -466,13 +466,13 @@ Upload to OBS
No
|
-Explanation:
+ | Explanation:
Standard HTTP header, returned in the response if a user downloads the object or makes a Head Object request.
Restrictions:
None
-Value range:
+Value range:
See the HTTP requirements for the Content-Encoding header.
-Default value:
+Default value:
None
|
@@ -482,13 +482,13 @@ Upload to OBS
No
|
-Explanation:
+ | Explanation:
Standard HTTP header, returned in the response if a user downloads the object or makes a Head Object request.
Restrictions:
None
-Value range:
+Value range:
See the HTTP requirements for the Expires header.
-Default value:
+Default value:
None
|
@@ -498,17 +498,17 @@ Upload to OBS
No
|
-Explanation:
+ | Explanation:
Where a successful 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 the value is invalid, OBS ignores this parameter. Location contains the object address, and OBS returns the response code based on the actual result.
+- 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 the value is invalid, OBS ignores this parameter. Location contains the object address, and OBS returns the response code based on the actual result.
Examples:
In POLICY: {"success_action_redirect": "http://123458.com"},
In HTML: <input type="text" name="success_action_redirect" value="http://123458.com" />
Restrictions:
The value must start with http or https.
-Value range:
+Value range:
URL
-Default value:
+Default value:
None
|
@@ -525,9 +525,9 @@ Upload to OBS In HTML: <input type="text" name=" x-obs-meta-test " value=" test metadata " />
Restrictions:
None
-Value range:
+Value range:
For details, see Object Metadata.
-Default value:
+Default value:
None
@@ -543,7 +543,7 @@ Upload to OBS In POLICY: ["starts-with", "$success_action_status", ""],
In HTML: <input type="text" name="success_action_status" value="200" />
Restrictions:
-- If this parameter is set to 200 or 204, the response body is left blank.
- If this parameter is set to 201, the response message contains an XML document that describes the response.
- If this parameter is not specified or is invalid, the status code is 204.
+- If this parameter is set to 200 or 204, the response body is left blank.
- If this parameter is set to 201, the response message contains an XML document that describes the response.
- If this parameter is not specified or is invalid, the status code is 204.
Value range:
Default value:
@@ -562,7 +562,7 @@ Upload to OBS The value must start with a slash (/), http://, or https:// and cannot exceed 2K.
Value range:
None
-Default value:
+Default value:
None
@@ -574,12 +574,12 @@ Upload to OBS
Explanation:
Indicates that SSE-KMS is used for server-side encryption.
-Example: x-obs-server-side-encryption:kms
+Example: x-obs-server-side-encryption:kms
Restrictions:
None
-Value range:
+Value range:
-Default value:
+Default value:
None
|
@@ -591,9 +591,9 @@ Upload to OBS
Explanation:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Restrictions:
This header can only be used when you specify kms for the x-obs-server-side-encryption header.
-Default value:
+Default value:
If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it.
|
@@ -605,12 +605,12 @@ Upload to OBS
Explanation:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm:AES256
+Example: x-obs-server-side-encryption-customer-algorithm:AES256
Restrictions:
- This header is used only when SSE-C is used.
- This header must be used with x-obs-server-side-encryption-customer-key and x-obs-server-side-encryption-customer-key-MD5.
-Value range:
+Value range:
AES256
-Default value:
+Default value:
None
|
@@ -622,12 +622,12 @@ Upload to OBS
Explanation:
The key used for encrypting an object.
-Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
Restrictions:
- This header is used only when SSE-C is used.
- This header is a Base64-encoded 256-bit key. It must be used with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key-MD5.
-Value range:
+Value range:
None
-Default value:
+Default value:
None
|
@@ -639,12 +639,12 @@ Upload to OBS
Explanation:
The MD5 value of the key used for encryption. Used to check whether any error occurs during the key transmission.
-Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
Restrictions:
- This header is used only when SSE-C is used.
- This header is a Base64-encoded 128-bit MD5 value. It must be used with x-obs-server-side-encryption-customer-algorithm and x-obs-server-side-encryption-customer-key.
-Value range:
+Value range:
MD5 value of the key.
-Default value:
+Default value:
None
|
@@ -657,12 +657,12 @@ Upload to OBS Explanation:
When an object expires and is deleted (how many days after the last update).
You can configure this parameter when uploading an object. You can also modify it after the object is uploaded by using the metadata modification API.
-Example: x-obs-expires:3
+Example: x-obs-expires:3
Restrictions:
The value must be greater than the number of days that have passed since the object was created. For example, if the object was uploaded 10 days ago, you must specify a value greater than 10.
-Value range:
+Value range:
The value is an integer greater than 0.
-Default value:
+Default value:
None
@@ -678,9 +678,9 @@ Upload to OBS Restrictions:
Currently, only COMPLIANCE (compliance mode) is supported.
This parameter must be used with x-obs-object-lock-retain-until-date.
-Value range:
+Value range:
COMPLIANCE
-Default value:
+Default value:
None
@@ -692,13 +692,13 @@ Upload to OBS
Explanation:
When the WORM policy of the object expires.
-Example: x-obs-object-lock-retain-until-date:2015-07-01T04:11:15Z
+Example: x-obs-object-lock-retain-until-date:2015-07-01T04:11:15Z
Restrictions:
The value must be a UTC time that complies with the ISO 8601 standard. Example: 2015-07-01T04:11:15Z
This parameter must be used with x-obs-object-lock-mode.
-Value range:
+Value range:
The time must be later than the current time.
-Default value:
+Default value:
None
|
@@ -725,7 +725,7 @@ ETag: etag
Type
|
-Description
+ | Description
|
@@ -737,9 +737,9 @@ ETag: etag
Object version ID.
Restrictions:
- If versioning is enabled for the bucket, the object version ID will be returned.
- If versioning is suspended for the bucket, a string null is returned.
-Value range:
+Value range:
The value is automatically generated by the server.
-Default value:
+Default value:
None
@@ -751,9 +751,9 @@ ETag: etag
Returned if the request origin meets the CORS configured on the server.
Restrictions:
None
-Value range:
+Value range:
The value that complies with the CORS
-Default value:
+Default value:
None
@@ -765,9 +765,9 @@ ETag: etag
Returned if the request headers meet the CORS configured on the server.
Restrictions:
None
-Value range:
+Value range:
The value that complies with the CORS
-Default value:
+Default value:
None
@@ -779,9 +779,9 @@ ETag: etag
Value of MaxAgeSeconds in the CORS configuration on the server when CORS is configured for buckets.
Restrictions:
None
-Value range:
+Value range:
An integer greater than or equal to 0, in seconds
-Default value:
+Default value:
3000
@@ -803,13 +803,13 @@ ETag: etag
String
|
-Explanation:
+ | Explanation:
ExposeHeader in the CORS rules of the bucket. It specifies additional headers allowed in the response by a CORS rule. These headers provide extra information to clients. By default, a browser can access only headers Content-Length and Content-Type. If the browser needs to access other headers, you need to configure them as additional headers.
Restrictions:
Spaces, asterisks (*), ampersands (&), colons (:), less-than signs (<), and full-width characters are not allowed.
-Value range:
+Value range:
None
-Default value:
+Default value:
None
|
@@ -819,12 +819,12 @@ ETag: etag
Explanation:
The encryption method used by the server.
-Example: x-obs-server-side-encryption:kms
+Example: x-obs-server-side-encryption:kms
Restrictions:
This header is included in a response if SSE-KMS is used.
-Value range:
+Value range:
-Default value:
+Default value:
None
|
@@ -834,9 +834,9 @@ ETag: etag
Explanation:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Restrictions:
This header can only be used when you specify kms for the x-obs-server-side-encryption header.
-Default value:
+Default value:
If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it.
|
@@ -846,12 +846,12 @@ ETag: etag
Explanation:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm:AES256
+Example: x-obs-server-side-encryption-customer-algorithm:AES256
Restrictions:
Only for SSE-C server-side encryption.
-Value range:
+Value range:
AES256
-Default value:
+Default value:
None
|
@@ -861,12 +861,12 @@ ETag: etag
Explanation:
The MD5 value of the key used for encryption.
-Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
Restrictions:
Only for SSE-C server-side encryption.
-Value range:
+Value range:
MD5 value of the key.
-Default value:
+Default value:
None
|
@@ -985,7 +985,7 @@ Content-Disposition: form-data; na
id=52f24s3593as5730ea4f722483579xxx
--7db143f50da2
Content-Disposition: form-data; name="x-obs-server-side-encryption"
-
+
kms
--7db143f50da2
Content-Disposition: form-data; name="x-obs-website-redirect-location"
diff --git a/docs/obs/api-ref/obs_04_0082.html b/docs/obs/api-ref/obs_04_0082.html
index 02ab72827..18b589d99 100644
--- a/docs/obs/api-ref/obs_04_0082.html
+++ b/docs/obs/api-ref/obs_04_0082.html
@@ -3,7 +3,7 @@
Copying an Object
FunctionsYou 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.
+ The object copy request carries the information about the source bucket and object to be copied in the header field. The message body cannot be carried.
This operation supports server-side encryption.
An object copy can be up to 5 GB in size. If the source object size exceeds 5 GB, you can only copy part of the object.
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.
@@ -23,7 +23,7 @@
To add tags to an object copy, you must have the PutObjectTagging permission for the object copy. To add tags to an object copy version, you must have the PutObjectTagging and PutObjectVersionTagging permissions for the object copy version. These permissions can be granted using bucket ACLs or bucket policies.
- Cold ObjectsIf source objects are in the Cold storage class, ensure that these objects have been restored before you copy them. If a source object is not restored or is being restored, its copy will fail and error 403 Forbidden will be returned. The fault is described as follows:
+ Cold ObjectsIf source objects are in the Cold storage class, ensure that these objects have been restored before you copy them. If a source object is not restored or is being restored, its copy will fail and error 403 Forbidden will be returned. The fault is described as follows:
ErrorCode: InvalidObjectState
ErrorMessage: Operation is not valid for the source object's storage class
@@ -154,7 +154,7 @@ Date: date
Explanation:
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.
-Example: x-obs-copy-source: /source_bucket/sourceObject
+Example: x-obs-copy-source: /source_bucket/sourceObject
Restrictions:
Full-width characters and percent signs (%) must be URL-encoded.
Value range:
@@ -171,7 +171,7 @@ Date: date
|
Explanation:
Indicates whether the metadata of the target object is copied from the source object or replaced with the metadata contained in the request.
-Example: x-obs-metadata-directive: metadata_directive
+Example: x-obs-metadata-directive: metadata_directive
Restrictions:
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 change an encrypted object to a non-encrypted one (for both the source and target objects). If you use this parameter to change the encryption of an object, OBS returns a 400 error.
Value range:
@@ -188,7 +188,7 @@ Date: date
|
Explanation:
Indicates that the source object is copied only if its ETag matches the one specified in this header. Otherwise, a 412 status code (failed precondition) is returned.
-Example: x-obs-copy-source-if-match: etag
+Example: x-obs-copy-source-if-match: etag
Restrictions:
This parameter can be used with x-obs-copy-source-if-unmodified-since but cannot with other conditional copy headers.
Value range:
@@ -205,7 +205,7 @@ Date: date
|
Explanation:
Indicates that the source object is copied only if its ETag does not match the one specified in this header. Otherwise, a 412 status code (failed precondition) is returned.
-Example: x-obs-copy-source-if-none-match: etag
+Example: x-obs-copy-source-if-none-match: etag
Restrictions:
This parameter can be used with x-obs-copy-source-if-modified-since but cannot with other conditional copy headers.
Value range:
@@ -223,9 +223,9 @@ Date: date
| Explanation:
The source object is copied only if the source object has not been modified since the time specified by this parameter. Otherwise, a 412 status code (precondition failed) is returned.
Restrictions:
-- The time specified by this parameter cannot be later than the current server time (GMT time), or this parameter does not take effect.
- This parameter can be used with x-obs-copy-source-if-match but cannot with other conditional copy parameters.
- Format: HTTP time string complying with the format specified at http://www.ietf.org/rfc/rfc2616.txt, which can be any of the following:
- EEE, dd MMM yyyy HH:mm:ss z
- EEEE, dd-MMM-yy HH:mm:ss z
- EEE MMM dd HH:mm:ss yyyy
+- The time specified by this parameter cannot be later than the current server time (GMT time), or this parameter does not take effect.
- This parameter can be used with x-obs-copy-source-if-match but cannot with other conditional copy parameters.
- Format: HTTP time string complying with the format specified at http://www.ietf.org/rfc/rfc2616.txt, which can be any of the following:
- EEE, dd MMM yyyy HH:mm:ss z
- EEEE, dd-MMM-yy HH:mm:ss z
- EEE MMM dd HH:mm:ss yyyy
Examples:
-- x-obs-copy-source-if-unmodified-since: Sun, 06 Nov 1994 08:49:37 GMT
- x-obs-copy-source-if-unmodified-since: Sunday, 06-Nov-94 08:49:37 GMT
- x-obs-copy-source-if-unmodified-since: Sun Nov 6 08:49:37 1994
+- x-obs-copy-source-if-unmodified-since: Sun, 06 Nov 1994 08:49:37 GMT
- x-obs-copy-source-if-unmodified-since: Sunday, 06-Nov-94 08:49:37 GMT
- x-obs-copy-source-if-unmodified-since: Sun Nov 6 08:49:37 1994
Value range:
None
@@ -242,7 +242,7 @@ Date: date
Explanation:
The source object is copied only if the source object has been modified since the time specified by this parameter. Otherwise, a 412 status code (precondition failed) is returned.
Restrictions:
-- The time specified by this parameter cannot be later than the current server time (GMT time), or this parameter does not take effect.
- This parameter can be used with x-obs-copy-source-if-none-match but cannot with other conditional copy parameters.
- Format: HTTP time string complying with the format specified at http://www.ietf.org/rfc/rfc2616.txt, which can be any of the following:
- EEE, dd MMM yyyy HH:mm:ss z
- EEEE, dd-MMM-yy HH:mm:ss z
- EEE MMM dd HH:mm:ss yyyy
+- The time specified by this parameter cannot be later than the current server time (GMT time), or this parameter does not take effect.
- This parameter can be used with x-obs-copy-source-if-none-match but cannot with other conditional copy parameters.
- Format: HTTP time string complying with the format specified at http://www.ietf.org/rfc/rfc2616.txt, which can be any of the following:
- EEE, dd MMM yyyy HH:mm:ss z
- EEEE, dd-MMM-yy HH:mm:ss z
- EEE MMM dd HH:mm:ss yyyy
Examples:
- x-obs-copy-source-if-modified-since: Sun, 06 Nov 1994 08:49:37 GMT
- x-obs-copy-source-if-modified-since: Sunday, 06-Nov-94 08:49:37 GMT
- x-obs-copy-source-if-modified-since: Sun Nov 6 08:49:37 1994
@@ -310,9 +310,9 @@ Date: date
|
Explanation:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Restrictions:
This header can only be used when you specify kms for the x-obs-server-side-encryption header.
-Default value:
+Default value:
If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it.
|
@@ -324,7 +324,7 @@ Date: date
|
Explanation:
The algorithm used to encrypt a target object.
-Example: x-obs-server-side-encryption-customer-algorithm: AES256
+Example: x-obs-server-side-encryption-customer-algorithm: AES256
Restrictions:
- This header is used only when SSE-C is used.
- This header must be used together with x-obs-server-side-encryption-customer-key and x-obs-server-side-encryption-customer-key-MD5.
Value range:
@@ -341,7 +341,7 @@ Date: date
|
Explanation:
The key used to encrypt a target object.
-Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
Restrictions:
- This header is used only when SSE-C is used.
- 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.
Value range:
@@ -358,7 +358,7 @@ Date: date
|
Explanation:
The MD5 value of the key used to encrypt a target object. The MD5 value is used to check whether any error occurs during the transmission of the key.
-Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
Restrictions:
- This header is used only when SSE-C is used.
- 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.
Value range:
@@ -392,7 +392,7 @@ Date: date
|
Explanation:
Indicates the key used to decrypt a source object.
-Example: x-obs-copy-source-server-side-encryption-customer-key: K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Example: x-obs-copy-source-server-side-encryption-customer-key: K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
Restrictions:
- This header is used only when SSE-C is used.
- 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.
Value range:
@@ -409,7 +409,7 @@ Date: date
|
Explanation:
Indicates the MD5 value of the key used to decrypt a source object. The MD5 value is used to check whether any error occurs during the transmission of the key.
-Example: x-obs-copy-source-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Example: x-obs-copy-source-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
Restrictions:
- This header is used only when SSE-C is used.
- 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.
Value range:
@@ -426,7 +426,7 @@ Date: date
|
Explanation:
The redirection address used when requests were successfully responded to.
-- 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 value is invalid, OBS ignores this parameter. In such case, the Location header is the object address, and OBS returns the response code based on whether the operation succeeds or fails.
+- 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 value is invalid, OBS ignores this parameter. In such case, the Location header is the object address, and OBS returns the response code based on whether the operation succeeds or fails.
Restrictions:
The value must be a valid URL, for example, http://domainname or https://domainname.
Value range:
@@ -447,7 +447,7 @@ Date: date
Restrictions:
None
Value range:
-- COPY: Tags of source objects are copied to the target objects.
- REPLACE: The tags specified in the request are added to the target objects.
+- COPY: Tags of source objects are copied to the target objects.
- REPLACE: The tags specified in the request are added to the target objects.
Default value:
REPLACE
|
@@ -460,7 +460,7 @@ Date: date
Explanation:
WORM mode applied to the object.
-Example: x-obs-object-lock-mode:COMPLIANCE
+Example: x-obs-object-lock-mode:COMPLIANCE
Restrictions:
This parameter must be used together with x-obs-object-lock-retain-until-date.
Value range:
@@ -473,7 +473,7 @@ Date: date
|
String
|
- No, but required when x-obs-object-lock-mode is present.
+ | No, but required when x-obs-object-lock-mode is present.
|
Explanation:
When the WORM policy of the object expires.
@@ -492,14 +492,14 @@ Date: date
|
No
|
- Explanation:
+ | Explanation:
Object's tag information in key-value pairs. Multiple tags can be added at the same time.
-Example: x-obs-tagging:TagA=A&TagB&TagC
+Example: x-obs-tagging:TagA=A&TagB&TagC
Restrictions:
- If a tag key or value contains special characters, equal signs (=), or full-width characters, it must be URL-encoded.
- If there is no equal sign (=) in a configuration, the tag value is considered left blank.
-Value range:
+Value range:
None
-Default value:
+Default value:
None
|
@@ -577,7 +577,7 @@ Content-Length: length
Explanation:
The encryption method used by the server.
-Example: x-obs-server-side-encryption: kms
+Example: x-obs-server-side-encryption: kms
Restrictions:
This header is included in a response if SSE-KMS is used.
Value range:
@@ -592,9 +592,9 @@ Content-Length: length
|
Explanation:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Restrictions:
This header can only be used when you specify kms for the x-obs-server-side-encryption header.
-Default value:
+Default value:
If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it.
|
@@ -604,7 +604,7 @@ Content-Length: length
Explanation:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm: AES256
+Example: x-obs-server-side-encryption-customer-algorithm: AES256
Restrictions:
This header is included in a response if SSE-C is used for server-side encryption.
Value range:
@@ -619,7 +619,7 @@ Content-Length: length
|
Explanation:
The MD5 value of the key used for encryption.
-Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
Restrictions:
This header is included in a response if SSE-C is used for server-side encryption.
Value range:
@@ -674,7 +674,7 @@ Content-Length: length
|
String
|
- Explanation:
+ | Explanation:
Time (UTC) when an object was last modified
Restrictions:
The date is in the ISO8601 format.
@@ -690,7 +690,7 @@ Content-Length: length
| String
|
Explanation:
-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 determine whether the object content is changed. For example, if the ETag value is A when an object is uploaded, but this value has changed to B when the object is downloaded, it indicates that the object content has been changed.
+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 determine whether the object content is changed. For example, if the ETag value is A when an object is uploaded, but this value has changed to B when the object is downloaded, it indicates that the object content has been changed.
Restrictions:
If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.
Value range:
diff --git a/docs/obs/api-ref/obs_04_0083.html b/docs/obs/api-ref/obs_04_0083.html
index db2b2115a..8f12beb6a 100644
--- a/docs/obs/api-ref/obs_04_0083.html
+++ b/docs/obs/api-ref/obs_04_0083.html
@@ -7,7 +7,7 @@
VersioningBy default, the GET operation returns the current version of an object. If the current version of the object is a delete marker, OBS returns a code meaning that the object does not exist. To obtain an object of a specified version, the versionId parameter can be used to specify the desired version.
Cold ObjectsIf the object you want to download is in the Cold storage class, ensure that this object has been restored before you download it. The response varies depending on the object's restore state. If an object has been restored, the x-obs-restore header (indicating the expiry date of the object) is returned when the object is successfully downloaded. If you send a request to download Cold objects that have not been restored or are being restored, a 403 Forbidden error will be returned.
+ Cold ObjectsIf the object you want to download is in the Cold storage class, ensure that this object has been restored before you download it. The response varies depending on the object's restore state. If an object has been restored, the x-obs-restore header (indicating the expiry date of the object) is returned when the object is successfully downloaded. If you send a request to download Cold objects that have not been restored or are being restored, a 403 Forbidden error will be returned.
Request Syntax1
2
@@ -22,7 +22,7 @@ Range:bytes=byte_range
<Optional Additional Header>
|
- The field is optional. If it does not exist, you can obtain the whole content.
+ The Range field is optional. If it is not specified, the entire object is downloaded.
Request ParametersIn 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.
@@ -134,7 +134,7 @@ Range:bytes=byte_range
None
Value range:
See the Content-Encoding values defined in HTTP.
- Default value:
+ Default value:
None
|
@@ -169,7 +169,7 @@ Range:bytes=byte_range
None
Value range:
None
- Default value:
+ Default value:
None
@@ -196,16 +196,16 @@ Range:bytes=byte_range
No
|
Explanation:
-Obtains the object content within the scope defined by Range. If the parameter value is invalid, the entire object is obtained.
+Obtains the object content within the scope defined by Range. If the parameter value is invalid, the entire object is obtained.
Restrictions:
-
+
Value range:
-Range value starts from 0, and the maximum value equals the object length minus 1.
-Default value:
+Range value starts from 0, and the maximum value equals the object length minus 1.
+Default value:
None
|
@@ -216,7 +216,7 @@ Range:bytes=byte_range
No
|
Explanation:
-Returns the object only if it has been modified since the time specified by this header. Otherwise, 304 Not Modified is returned.
+Returns the object only if it has been modified since the time specified by this header. Otherwise, 304 Not Modified is returned.
Restrictions:
The time specified by this parameter cannot be later than the current server time (GMT time), or this parameter does not take effect.
Value range:
@@ -224,7 +224,7 @@ Range:bytes=byte_range
- EEE, dd MMM yyyy HH:mm:ss z
- EEEE, dd-MMM-yy HH:mm:ss z
- EEE MMM dd HH:mm:ss yyyy
Examples:
- if-modified-since: Sun, 06 Nov 1994 08:49:37 GMT
- if-modified-since: Sunday, 06-Nov-94 08:49:37 GMT
- if-modified-since: Sun Nov 6 08:49:37 1994
-Default value:
+Default value:
None
|
@@ -243,7 +243,7 @@ Range:bytes=byte_range
- EEE, dd MMM yyyy HH:mm:ss z
- EEEE, dd-MMM-yy HH:mm:ss z
- EEE MMM dd HH:mm:ss yyyy
Examples:
- if-unmodified-since: Sun, 06 Nov 1994 08:49:37 GMT
- if-unmodified-since: Sunday, 06-Nov-94 08:49:37 GMT
- if-unmodified-since: Sun Nov 6 08:49:37 1994
- Default value:
+ Default value:
None
@@ -254,13 +254,13 @@ Range:bytes=byte_range
No
|
Explanation:
-Returns the object only if its ETag is the same as the one specified by this header. Otherwise, 412 Precondition Failed is returned.
+Returns the object only if its ETag is the same as the one specified by this header. Otherwise, 412 Precondition Failed is returned.
ETag example: 0f64741bf7cb1089e988e4585d0d3434
Restrictions:
None
Value range:
Object ETag
-Default value:
+Default value:
None
|
@@ -271,13 +271,13 @@ Range:bytes=byte_range
No
|
Explanation:
-Returns the object only if its ETag is different from the one specified by this header. Otherwise, 304 Not Modified is returned.
+Returns the object only if its ETag is different from the one specified by this header. Otherwise, 304 Not Modified is returned.
ETag example: 0f64741bf7cb1089e988e4585d0d3434
Restrictions:
None
Value range:
Object ETag
-Default value:
+Default value:
None
|
@@ -289,12 +289,12 @@ Range:bytes=byte_range
Explanation:
Indicates the encryption algorithm used when SSE-C is used.
-Example: x-obs-server-side-encryption-customer-algorithm:AES256
+Example: x-obs-server-side-encryption-customer-algorithm:AES256
Restrictions:
This header must be used together with x-obs-server-side-encryption-customer-key and x-obs-server-side-encryption-customer-key-MD5.
Value range:
AES256
-Default value:
+Default value:
None
|
@@ -306,12 +306,12 @@ Range:bytes=byte_range
Explanation:
Indicates the encryption key used when SSE-C is used. This key is used to decrypt objects.
-Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
Restrictions:
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.
Value range:
None
-Default value:
+Default value:
None
|
@@ -323,12 +323,12 @@ Range:bytes=byte_range
Explanation:
Indicates the MD5 value of the encryption key when SSE-C is used. The MD5 value is used to check whether any error occurs during the transmission of the key.
-Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
Restrictions:
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.
Value range:
Base64-encoded MD5 value of the key ID.
-Default value:
+Default value:
None
|
@@ -371,14 +371,14 @@ Last-Modified: time
String
|
- Explanation:
+ | Explanation:
Expiration time of an object.
Restrictions:
-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.
+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.
Value range:
The time format is EEE, dd MMM yyyy HH:mm:ss z.
Example: expiry-date=Sun, 06 Nov 1994 08:49:37 GMT
-Default value:
+Default value:
None
|
@@ -395,7 +395,7 @@ Last-Modified: time
OBS obtains the specified value from the header and stores it in the object metadata WebsiteRedirectLocation.
Restrictions:
- The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
- OBS supports redirection for objects in the root directory of a bucket, not for those in folders.
- Default value:
+ Default value:
None
@@ -403,7 +403,7 @@ Last-Modified: time
Boolean
|
- Explanation:
+ | Explanation:
Whether the deleted object is a delete marker. If the object is not marked as deleted, the response does not contain this header.
Value range:
- true: The deleted object is a delete marker.
- false: The deleted object is not a delete marker.
@@ -415,13 +415,13 @@ Last-Modified: time
|
String
|
- Explanation:
+ | Explanation:
Object version ID.
Restrictions:
If the object has no version number specified, the response does not contain this header.
Value range:
The value must contain 32 characters.
-Default value:
+Default value:
None
|
@@ -429,14 +429,14 @@ Last-Modified: time
String
|
- Explanation:
+ | Explanation:
The encryption method used by the server.
-Example: x-obs-server-side-encryption:kms
+Example: x-obs-server-side-encryption:kms
Restrictions:
This header is included in a response if SSE-KMS is used.
Value range:
-Default value:
+Default value:
None
|
@@ -446,9 +446,9 @@ Last-Modified: time
Explanation:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Restrictions:
This header can only be used when you specify kms for the x-obs-server-side-encryption header.
-Default value:
+Default value:
If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it.
|
@@ -456,14 +456,14 @@ Last-Modified: time
String
|
- Explanation:
+ | Explanation:
Indicates a decryption algorithm. This header is included in a response if SSE-C is used.
Example: x-obs-server-side-encryption-customer-algorithm:AES256
Restrictions:
None
Value range:
AES256
-Default value:
+Default value:
None
|
@@ -471,12 +471,12 @@ Last-Modified: time
String
|
- Explanation:
+ | Explanation:
Indicates the MD5 value of a key used to decrypt objects. This header is included in a response if SSE-C is used.
-Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
Value range:
Base64-encoded MD5 value of the key ID.
-Default value:
+Default value:
None
|
@@ -490,7 +490,7 @@ Last-Modified: time
This header is returned when the object is not a Normal object.
Value range:
Appendable
- Default value:
+ Default value:
None
@@ -512,7 +512,7 @@ Last-Modified: time
String
|
- Explanation:
+ | Explanation:
Number of tags associated with an object.
Example: x-obs-tagging-count:1
Restrictions:
diff --git a/docs/obs/api-ref/obs_04_0084.html b/docs/obs/api-ref/obs_04_0084.html
index 0a9dfdf3f..3a2e140b1 100644
--- a/docs/obs/api-ref/obs_04_0084.html
+++ b/docs/obs/api-ref/obs_04_0084.html
@@ -101,7 +101,7 @@ Authorization: authorization
|
Explanation:
Indicates the decryption algorithm used when SSE-C is used.
-Example: x-obs-server-side-encryption-customer-algorithm:AES256
+Example: x-obs-server-side-encryption-customer-algorithm:AES256
Restrictions:
This header must be used together with x-obs-server-side-encryption-customer-key and x-obs-server-side-encryption-customer-key-MD5.
Value range:
@@ -118,7 +118,7 @@ Authorization: authorization
|
Explanation:
Indicates the decryption key used when SSE-C is used.
-Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
Restrictions:
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.
Value range:
@@ -135,7 +135,7 @@ Authorization: authorization
|
Explanation:
Indicates the MD5 value of the decryption key when SSE-C is used. The MD5 value is used to check whether any error occurs during the transmission of the key.
-Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
Restrictions:
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.
Value range:
@@ -179,12 +179,12 @@ Last-Modified: time
|
String
|
- Explanation:
+ | Explanation:
Expiration details
Restrictions:
None
Value range:
-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.
+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.
Default value:
None
|
@@ -193,7 +193,7 @@ Last-Modified: time
String
|
- Explanation:
+ | Explanation:
Indicates where an object request is redirected. If the bucket that contains the object is configured with Website settings, this parameter can be set in the object metadata so that the request for the object can be redirected to another object in the same bucket or an external URL after the website returns a 301 redirect response.
To another object in the same bucket:
x-obs-website-redirect-location:/anotherPage.html
@@ -252,7 +252,7 @@ Last-Modified: time
|
Integer
|
- Explanation:
+ | Explanation:
MaxAgeSeconds in the CORS rules of the bucket. It specifies the time your client can cache the response for a cross-origin request.
Restrictions:
Each CORS rule can contain at most one MaxAgeSeconds.
@@ -276,7 +276,7 @@ Last-Modified: time
|
String
|
- Explanation:
+ | Explanation:
ExposeHeader in the CORS rules of the bucket. It specifies additional headers allowed in the response by a CORS rule, which are used to provide extra information to clients. By default, a browser can access only headers Content-Length and Content-Type. If the browser needs to access other headers, you need to configure them as additional headers.
Restrictions:
Spaces, asterisks (*), ampersands (&), colons (:), less-than signs (<), and full-width characters are not allowed.
@@ -292,7 +292,7 @@ Last-Modified: time
|
Explanation:
The encryption method used by the server.
-Example: x-obs-server-side-encryption:kms
+Example: x-obs-server-side-encryption:kms
Restrictions:
This header is included in a response if SSE-KMS is used.
Value range:
@@ -307,9 +307,9 @@ Last-Modified: time
|
Explanation:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Restrictions:
This header can only be used when you specify kms for the x-obs-server-side-encryption header.
-Default value:
+Default value:
If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it.
|
@@ -319,7 +319,7 @@ Last-Modified: time
Explanation:
Indicates a decryption algorithm. This header is included in a response if SSE-C is used.
-Example: x-obs-server-side-encryption-customer-algorithm:AES256
+Example: x-obs-server-side-encryption-customer-algorithm:AES256
Restrictions:
None
Value range:
@@ -334,7 +334,7 @@ Last-Modified: time
|
Explanation:
Indicates the MD5 value of a key used to decrypt objects. This header is included in a response if SSE-C is used.
-Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
Restrictions:
Base64-encoded MD5 value of the key, for example, 4XvB3tbNTN+tIEVa0/fGaQ==.
Value range:
@@ -361,11 +361,11 @@ Last-Modified: time
|
String
|
- Explanation:
+ | Explanation:
Restore status of an object.
For example, ongoing-request="true" indicates that the object is being restored. ongoing-request="false", expiry-date="Wed, 7 Nov 2012 00:00:00 GMT" indicates that the object has been restored, where expiry-date indicates when the restored object expires.
Restrictions:
-This header is returned only when a Cold object is being restored or has been restored.
+This header is returned only when Cold objects are being restored or has been restored.
Value range:
None
Default value:
@@ -390,7 +390,7 @@ Last-Modified: time
|
Integer
|
- Explanation:
+ | Explanation:
Indicates the position that should be provided in the next request.
Restrictions:
This header is returned only when the object is an Appendable object.
@@ -420,7 +420,7 @@ Last-Modified: time
|
Explanation:
Number of tags associated with an object.
-Example: x-obs-tagging-count:1
+Example: x-obs-tagging-count:1
Restrictions:
This header is returned only when you have the permission to read tags.
Value range:
@@ -435,7 +435,7 @@ Last-Modified: time
|
Explanation:
WORM mode applied to the object.
-Example: x-obs-object-lock-mode:COMPLIANCE
+Example: x-obs-object-lock-mode:COMPLIANCE
Restrictions:
- This parameter is returned only when the object has any object-level WORM retention policy configured or has a default bucket-level WORM policy applied.
- The user must have the GetObjectRetention permission.
Value range:
@@ -450,7 +450,7 @@ Last-Modified: time
|
Explanation:
When an object lock expires.
-Example: x-obs-object-lock-retain-until-date:2015-07-01T04:11:15Z
+Example: x-obs-object-lock-retain-until-date:2015-07-01T04:11:15Z
Restrictions:
- The value must be a UTC time that complies with the ISO 8601 standard. Example: 2015-07-01T04:11:15Z
- This parameter is returned only when the object has any object-level WORM retention policy configured or has a default bucket-level WORM policy applied.
- The user must have the GetObjectRetention permission.
Value range:
diff --git a/docs/obs/api-ref/obs_04_0085.html b/docs/obs/api-ref/obs_04_0085.html
index ad5c3b393..ec24e3b51 100644
--- a/docs/obs/api-ref/obs_04_0085.html
+++ b/docs/obs/api-ref/obs_04_0085.html
@@ -33,8 +33,15 @@ Authorization: authorization
| versionId
|
-Object version ID
+ | Explanation:
+Version ID of the object to be deleted.
Type: string
+Restrictions:
+None
+Value range:
+The value must contain 32 characters.
+Default value:
+None
|
No
|
@@ -64,17 +71,28 @@ Date: date
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.
+ | Explanation:
+Whether an object has a delete marker. If the object is not marked as deleted, the response does not contain this header.
Type: boolean
-Value options: true, false
-The default value is false.
+Restrictions:
+None
+Value range:
+
+Default value:
+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: string
-Default value: none
+ | Explanation:
+Object version ID. If the object has no version number specified, the response does not contain this header.
+Type: string
+Restrictions:
+None
+Value range:
+The value must contain 32 characters.
+Default value:
+None
|
diff --git a/docs/obs/api-ref/obs_04_0087.html b/docs/obs/api-ref/obs_04_0087.html
index d8572681e..ab07600cf 100644
--- a/docs/obs/api-ref/obs_04_0087.html
+++ b/docs/obs/api-ref/obs_04_0087.html
@@ -1,7 +1,7 @@
- Restoring Cold Objects
- FunctionsTo 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 once its retention period ends.
+ Restoring Cold Objects
+ FunctionsTo 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 once its retention period ends.
VersioningBy default, this operation returns the latest version of an object. If the object has a delete 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.
@@ -36,7 +36,7 @@ Content-MD5: MD5
No
|
Explanation:
-Version ID of the Cold object to be restored
+Version ID of the Cold object to be restored
Restrictions:
None
Value range:
@@ -84,7 +84,7 @@ Content-MD5: MD5
|
Yes
|
- Explanation:
+ | Explanation:
After an object is restored, a Standard copy of it is generated. This parameter specifies how long the Standard copy can be retained, that is, the validity period of the restored object.
Restrictions:
None
@@ -116,7 +116,7 @@ Content-MD5: MD5
|
No
|
- Explanation:
+ | Explanation:
Retrieval speed tier. You can select a tier that suits your retrieval needs.
Value range:
- Expedited indicates that objects can be quickly restored from Archive storage within 1 to 5 minutes.
- Standard indicates that objects can be restored from Archive storage within 3 to 5 hours.
@@ -149,7 +149,7 @@ Date: date
| RestoreAlreadyInProgress
|
-Explanation:
+ | Explanation:
The object is being restored. The request conflicts with another.
ErrorMessage: Object restore is already in progress
|
@@ -158,7 +158,7 @@ Date: date
ObjectHasAlreadyRestored
|
-Explanation:
+ | Explanation:
The objects have been restored and the retention period of the objects cannot be shortened.
ErrorMessage: After restoring an archived object, you cannot shorten the restoration period of the archived object
|
@@ -167,8 +167,8 @@ Date: date
MalformedXML
|
-Explanation:
-Invalid value for the Days field (supposed to be an integer)
+ | Explanation:
+Invalid value for the Days field (supposed to be an integer)
ErrorMessage: The XML you provided was not well-formed or did not validate against our published schema
|
400 Bad Request
@@ -176,8 +176,8 @@ Date: date
|
InvalidArgument
|
-Explanation:
-Invalid value for the Days field (valid range: 1 to 30).
+ | Explanation:
+Invalid value for the Days field (valid range: 1 to 30).
ErrorMessage: restoration days should be at least 1 and at most 30
|
400 Bad Request
@@ -185,8 +185,8 @@ Date: date
|
MalformedXML
|
-Explanation:
-Invalid value for the Tier field.
+ | Explanation:
+Invalid value for the Tier field.
ErrorMessage: The XML you provided was not well-formed or did not validate against our published schema
|
400 Bad Request
@@ -194,8 +194,8 @@ Date: date
|
InvalidObjectState
|
-Explanation:
-The restored object is not in the Cold storage.
+ | Explanation:
+The restored object is not in the Cold storage.
ErrorMessage: Restore is not allowed, as object's storage class is not COLD
|
403 Forbidden
diff --git a/docs/obs/api-ref/obs_04_0091.html b/docs/obs/api-ref/obs_04_0091.html
index fe7fba5fc..a35e9880a 100644
--- a/docs/obs/api-ref/obs_04_0091.html
+++ b/docs/obs/api-ref/obs_04_0091.html
@@ -74,7 +74,7 @@ Date: date
| Explanation:
Metadata operation directive.
Restrictions:
-None
+If you want to change the storage class of an object by modifying its metadata, x-obs-metadata-directive must be set to REPLACE_NEW.
Value range:
- REPLACE_NEW: The metadata that has an existing value is replaced. A value is assigned to the metadata that does not have a value. The metadata that is not specified remains unchanged. Custom metadata is replaced.
- REPLACE: All original metadata is replaced by metadata specified in the request. Metadata that is not specified (except for x-obs-storage-class) is deleted.
Default value:
@@ -187,7 +187,7 @@ Date: date
|
Explanation:
If the bucket is configured with website hosting, the request for obtaining the object can be redirected to another object in the bucket or an external URL.
-In the following example, the request header sets the redirection to an object (anotherPage.html) in the same bucket:
+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:
x-obs-website-redirect-location:http://www.example.com/
@@ -207,7 +207,7 @@ Date: date
|
Explanation:
Specifies the storage class of an object.
-Example: x-obs-storage-class: STANDARD
+Example: x-obs-storage-class: STANDARD
Restrictions:
The value is case-sensitive.
Value range:
@@ -242,7 +242,7 @@ Date: date
|
Explanation:
An object's tag information in key-value pairs. Multiple tags can be added at the same time.
-Example: x-obs-tagging:TagA=A&TagB&TagC
+Example: x-obs-tagging:TagA=A&TagB&TagC
Restrictions:
- If a tag key or value contains special characters, equal signs (=), or full-width characters, it must be URL-encoded.
- If there is no equal sign (=) in a configuration, the tag value is considered left blank.
Value range:
@@ -286,7 +286,7 @@ Last-Modified: time
Metadata operation directive.
Value range:
- REPLACE_NEW: The metadata that has an existing value is replaced. A value is assigned to the metadata that does not have a value. The metadata that is not specified remains unchanged. Custom metadata is replaced.
- REPLACE: All original metadata is replaced by metadata specified in the request. Metadata that is not specified (except for x-obs-storage-class) is deleted.
-Default value:
+Default value:
None
|
@@ -366,7 +366,7 @@ Last-Modified: time
Explanation:
If the bucket is configured with website hosting, the request for obtaining the object can be redirected to another object in the bucket or an external URL.
-In the following example, the request header sets the redirection to an object (anotherPage.html) in the same bucket:
+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:
x-obs-website-redirect-location:http://www.example.com/
diff --git a/docs/obs/api-ref/obs_04_0098.html b/docs/obs/api-ref/obs_04_0098.html
index 4badbcdc4..21e1e8b96 100644
--- a/docs/obs/api-ref/obs_04_0098.html
+++ b/docs/obs/api-ref/obs_04_0098.html
@@ -69,8 +69,8 @@ Authorization: authorization
|
Explanation:
When initiating a multipart upload, you can add this header to set an object ACL.
-Example: x-obs-acl: public-read-write
-Restrictions:
+Example: x-obs-acl: public-read-write
+Restrictions:
Use character strings.
Value range:
- private
- public-read
- public-read-write
@@ -87,9 +87,9 @@ Authorization: authorization
|
Explanation:
When initiating a multipart upload, you can use this header to grant all users in a domain the permissions to read the object and obtain the object metadata.
-Example: x-obs-grant-read: ID=domainID.
+Example: x-obs-grant-read: ID=domainID.
Restrictions:
-If multiple accounts are authorized, separate them with commas (,).
+Use commas (,) to separate multiple domains.
Value range:
None
Default value:
@@ -104,12 +104,12 @@ Authorization: authorization
|
Explanation:
When initiating a multipart upload, you can use this header to grant all users in a domain the permissions to obtain the object ACL.
-Example: x-obs-grant-read-acp: ID=domainID.
+Example: x-obs-grant-read-acp: ID=domainID.
Restrictions:
-If multiple accounts are authorized, separate them with commas (,).
+Use commas (,) to separate multiple domains.
Value range:
None
-Default value:
+Default value:
None
|
@@ -123,10 +123,10 @@ Authorization: authorization
When initiating a multipart upload, you can use this header to grant all users in a domain the permissions to write the object ACL.
Example: x-obs-grant-write-acp: ID=domainID
Restrictions:
-If multiple accounts are authorized, separate them with commas (,).
+Use commas (,) to separate multiple domains.
Value range:
None
-Default value:
+Default value:
None
@@ -139,12 +139,12 @@ Authorization: authorization
Explanation:
When initiating a multipart upload, you can use this header to grant all users in a domain the following permissions:
Permissions to read objects, obtain object metadata, obtain object ACLs, and write object ACLs.
-Example: x-obs-grant-full-control: ID=domainID.
+Example: x-obs-grant-full-control: ID=domainID.
Restrictions:
-If multiple accounts are authorized, separate them with commas (,).
+Use commas (,) to separate multiple domains.
Value range:
None
-Default value:
+Default value:
None
|
@@ -172,14 +172,14 @@ Authorization: authorization
No
|
-Explanation:
+ | Explanation:
If the bucket is configured with website hosting, the request for obtaining the object can be redirected to another object in the bucket or an external URL.
To another object in the same bucket:
x-obs-website-redirect-location:/anotherPage.html
To an external URL:
x-obs-website-redirect-location:http://www.example.com/
OBS obtains the specified value from the header and stores it in the object metadata WebsiteRedirectLocation.
-Restrictions:
+Restrictions:
- The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
- OBS supports redirection for objects in the root directory of a bucket, not for those in folders.
Default value:
None
@@ -194,7 +194,7 @@ Authorization: authorization
| Explanation:
Indicates that SSE-KMS is used.
Example: x-obs-server-side-encryption: kms
-Restrictions:
+Restrictions:
None
Value range:
@@ -210,9 +210,9 @@ Authorization: authorization
|
Explanation:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Restrictions:
This header can only be used when you specify kms for the x-obs-server-side-encryption header.
-Default value:
+Default value:
If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it.
|
@@ -224,7 +224,7 @@ Authorization: authorization
Explanation:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm: AES256
+Example: x-obs-server-side-encryption-customer-algorithm: AES256
Restrictions:
- This header is used only when SSE-C is used.
- This header must be used together with x-obs-server-side-encryption-customer-key and x-obs-server-side-encryption-customer-key-MD5.
Value range:
@@ -241,7 +241,7 @@ Authorization: authorization
|
Explanation:
The key used for encrypting an object.
-Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
Restrictions:
- This header is used only when SSE-C is used.
- 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.
Value range:
@@ -258,7 +258,7 @@ Authorization: authorization
|
Explanation:
The MD5 value of the encryption key. The MD5 value is used to check whether any error occurs during the transmission of the key.
-Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
Restrictions:
- This header is used only when SSE-C is used.
- 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.
Value range:
@@ -276,7 +276,7 @@ Authorization: authorization
| Explanation:
Specifies when an object expires. It is measured in days. Once the object expires, it is automatically deleted. (The calculation starts from when the object was last modified).
Example: x-obs-expires:3
-Restrictions:
+Restrictions:
This parameter can be configured only when uploading the object. It cannot be modified by calling a metadata modification API.
Value range:
An integer greater than or equal to 0, in days
@@ -292,7 +292,7 @@ Authorization: authorization
|
Explanation:
An object's tag information in key-value pairs. Multiple tags can be added at the same time.
-Example: x-obs-tagging:TagA=A&TagB&TagC
+Example: x-obs-tagging:TagA=A&TagB&TagC
Restrictions:
- If a tag key or value contains special characters, equal signs (=), or full-width characters, it must be URL-encoded.
- If there is no equal sign (=) in a configuration, the tag value is considered left blank.
Value range:
@@ -305,7 +305,7 @@ Authorization: authorization
|
String
|
-No, but required when x-obs-object-lock-retain-until-date is present.
+ | No, but required when x-obs-object-lock-retain-until-date is present.
|
Explanation:
WORM mode to be applied to an object.
@@ -322,7 +322,7 @@ Authorization: authorization
|
String
|
-No, but required when x-obs-object-lock-mode is present.
+ | No, but required when x-obs-object-lock-mode is present.
|
Explanation:
When the WORM policy of the object expires.
@@ -344,11 +344,11 @@ Authorization: authorization
| Explanation:
When initiating a multipart upload, you can use a header starting with x-obs-meta- in the HTTP request to define object metadata for easy management. The custom metadata will be returned in the response when you retrieve the object or query the object metadata.
Example: x-obs-meta-test: test metadata
-Restrictions:
+Restrictions:
This parameter can only be passed in HTTP request headers and cannot exceed 8 KB.
Value range:
None
-Default value:
+Default value:
None
|
@@ -397,10 +397,10 @@ Connection: status
String
|
-Explanation:
+ | Explanation:
The encryption method used by the server.
-Example: x-obs-server-side-encryption: kms
-Restrictions:
+Example: x-obs-server-side-encryption: kms
+Restrictions:
This header is included in a response if SSE-KMS is used.
Value range:
@@ -414,9 +414,9 @@ Connection: status
|
Explanation:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Restrictions:
This header can only be used when you specify kms for the x-obs-server-side-encryption header.
-Default value:
+Default value:
If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it.
|
@@ -441,7 +441,7 @@ Connection: status
Explanation:
The MD5 value of the encryption key.
-Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
Restrictions:
This header is included in a response if SSE-C is used for server-side encryption.
Value range:
@@ -470,11 +470,11 @@ Connection: status
|
Explanation:
Container of a multipart upload task.
-Restrictions:
+Restrictions:
None
Value range:
None
-Default value:
+Default value:
None
|
@@ -484,7 +484,7 @@ Connection: status
Explanation:
Indicates the bucket name in the multipart upload.
-Restrictions:
+Restrictions:
- A bucket name must be unique across all accounts and regions.
- A bucket name:
- Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
- Cannot be formatted as an IP address.
- Cannot start or end with a hyphen (-) or period (.).
- Cannot contain two consecutive periods (..), for example, my..bucket.
- Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket.
- If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request.
Value range:
@@ -497,9 +497,9 @@ Connection: status
|
String
|
-Explanation:
+ | Explanation:
Name of the object in the multipart upload. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name.
-Restrictions:
+Restrictions:
None
Value range:
The value must contain 1 to 1,024 characters.
@@ -511,9 +511,9 @@ Connection: status
|
String
|
-Explanation:
+ | Explanation:
ID of the multipart upload, which is used to specify a multipart upload in uploading parts
-Restrictions:
+Restrictions:
None
Value range:
The value must contain 1 to 32 characters.
diff --git a/docs/obs/api-ref/obs_04_0099.html b/docs/obs/api-ref/obs_04_0099.html
index f05e44f3d..96e1ca5c5 100644
--- a/docs/obs/api-ref/obs_04_0099.html
+++ b/docs/obs/api-ref/obs_04_0099.html
@@ -2,7 +2,7 @@
Uploading Parts
FunctionsAfter a multipart upload task is created, you can upload parts for this task using the obtained multipart upload 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.
+ Ensure that the part size ranges from 100 KB to 5 GB and the size of the last part ranges from 0 to 5 GB. Otherwise, an error will be reported when you assemble parts. 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.
@@ -83,7 +83,7 @@ Content-MD5: md5
|
Explanation:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm:AES256
+Example: x-obs-server-side-encryption-customer-algorithm:AES256
Restrictions:
- Indicates the encryption algorithm used when SSE-C is used.
- This header must be used together with x-obs-server-side-encryption-customer-key and x-obs-server-side-encryption-customer-key-MD5.
Value range:
@@ -100,7 +100,7 @@ Content-MD5:md5
|
Explanation:
The key used for encrypting an object.
-Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
Restrictions:
- This header is used only when SSE-C is used for encryption.
- 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.
Value range:
@@ -117,7 +117,7 @@ Content-MD5:md5
|
Explanation:
The MD5 value of the encryption key. The MD5 value is used to check whether any error occurs during the transmission of the key.
-Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
Restrictions:
This header is used only when SSE-C is used for encryption.
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.
@@ -157,9 +157,9 @@ Content-Length: length
|
String
|
-Explanation:
+ | Explanation:
The encryption method used by the server.
-Example: x-obs-server-side-encryption:kms
+Example: x-obs-server-side-encryption:kms
Restrictions:
This header is included in a response if SSE-KMS is used.
Value range:
@@ -174,9 +174,9 @@ Content-Length: length
|
Explanation:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Restrictions:
This header can only be used when you specify kms for the x-obs-server-side-encryption header.
-Default value:
+Default value:
If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it.
|
@@ -201,7 +201,7 @@ Content-Length: length
Explanation:
The MD5 value of the encryption key.
-Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
Restrictions:
This header is included in a response if SSE-C is used for server-side encryption.
Value range:
diff --git a/docs/obs/api-ref/obs_04_0100.html b/docs/obs/api-ref/obs_04_0100.html
index e000bf0e7..64e54f7e9 100644
--- a/docs/obs/api-ref/obs_04_0100.html
+++ b/docs/obs/api-ref/obs_04_0100.html
@@ -1,13 +1,13 @@
Copying Parts
-FunctionsAfter a multipart upload task is created, you can upload parts for this task using the obtained multipart upload ID. Alternatively, you can make an API call to add a part (part of an object or the whole object).
+ FunctionsAfter a multipart upload task is created, you can upload parts for this task using the obtained multipart upload ID. Alternatively, you can make an API call to copy a part or a whole uploaded object as a part.
This operation supports server-side encryption.
You cannot determine whether a request is successful only based on the status_code in the returned HTTP header. If 200 is returned for status_code, the server has received the request and started to process the request. The copy is successful only when the body in the response contains ETag.
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.
- Cold ObjectsIf source objects are in the Cold storage class, ensure that these objects have been restored before you copy them. 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:
+ Cold ObjectsIf source objects are in the Cold storage class, ensure that these objects have been restored before you copy them. 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
@@ -49,7 +49,7 @@ Content-Length: length
|
- Request HeadersIn addition the common message headers, the request uses two extended headers. Table 3 describes the common message header.
+ Request HeadersIn addition to the common message headers, the request uses two extended headers. Table 3 describes the common message header.
Table 2 Request headersHeader
|
diff --git a/docs/obs/api-ref/obs_04_0102.html b/docs/obs/api-ref/obs_04_0102.html
index 6a3abe6c2..c93f1dd10 100644
--- a/docs/obs/api-ref/obs_04_0102.html
+++ b/docs/obs/api-ref/obs_04_0102.html
@@ -2,7 +2,7 @@
Completing a Multipart Upload
FunctionsAfter all parts are uploaded, you can call this API to assemble specified parts into an object. 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.
+ As long as the multipart upload is not aborted, all uploaded parts occupy the space. However, after you assembled the specified parts, the uploaded but not assembled parts will be deleted to free up space.
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.
@@ -110,7 +110,7 @@ Authorization: authorization
None
Value range:
None
- Default value:
+ Default value:
None
|---|
@@ -199,9 +199,9 @@ Date: date
String
|
-Explanation:
+ | Explanation:
The encryption method used by the server.
-Example: x-obs-server-side-encryption:kms
+Example: x-obs-server-side-encryption:kms
Restrictions:
This header is included in a response if SSE-KMS is used.
Value range:
@@ -216,10 +216,10 @@ Date: date
|
Explanation:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
-This header can only be used when you specify kms for the x-obs-server-side-encryption header.
-Default value:
-If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it.
+Restrictions:
+This header can only be used when you specify kms for the x-obs-server-side-encryption header.
+Default value:
+If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it.
|
x-obs-server-side-encryption-customer-algorithm
@@ -228,7 +228,7 @@ Date: date
|
Explanation:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm:AES256
+Example: x-obs-server-side-encryption-customer-algorithm:AES256
Restrictions:
This header is included in a response if SSE-C is used for server-side encryption.
Value range:
@@ -258,7 +258,7 @@ Date: date
| Explanation:
Path of the object after parts are assembled.
Restrictions:
-Format: /bucketName/objectName
+Format: http://bucketName.obs.region.example.com/objectName
Value range:
None
Default value:
@@ -269,7 +269,7 @@ Date: date
|
String
|
-Explanation:
+ | Explanation:
Bucket where parts are assembled
Restrictions:
- A bucket name must be unique across all accounts and regions.
- A bucket name:
- Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
- Cannot be formatted as an IP address.
- Cannot start or end with a hyphen (-) or period (.).
- Cannot contain two consecutive periods (..), for example, my..bucket.
- Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket.
@@ -284,7 +284,7 @@ Date: date
|
String
|
-Explanation:
+ | Explanation:
Object name obtained after part assembling.
An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name.
Restrictions:
@@ -299,7 +299,7 @@ Date: date
|
String
|
-Explanation:
+ | Explanation:
The ETag that uniquely identifies the object after its parts were assembled, calculated based on the ETag of each part.
Restrictions:
If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.
@@ -387,11 +387,11 @@ Date: WED, 01 326
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<CompleteMultipartUploadResult xmlns="http://obs.example.com/doc/2015-06-30/">
- <Location>/examplebucket/object02</Location>
- <Bucket>examplebucket</Bucket>
- <Key>object02</Key>
- <ETag>"03f814825e5a691489b947a2e120b2d3-3"</ETag>
+<CompleteMultipartUploadResult xmlns="http://obs.region.example.com/doc/2015-06-30/">
+ <Location>http://examplebucket.obs.region.example.com/object02</Location>
+ <Bucket>examplebucket</Bucket>
+ <Key>object02</Key>
+ <ETag>"03f814825e5a691489b947a2e120b2d3-3"</ETag>
</CompleteMultipartUploadResult>
|
diff --git a/docs/obs/api-ref/obs_04_0105.html b/docs/obs/api-ref/obs_04_0105.html
index 9baec12e7..f9da645ef 100644
--- a/docs/obs/api-ref/obs_04_0105.html
+++ b/docs/obs/api-ref/obs_04_0105.html
@@ -7,6 +7,7 @@
With SSE-KMS, OBS uses the keys provided by KMS for server-side encryption. You can create custom keys on KMS to encrypt your objects.
With SSE-C, 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 object's MD5 value.
+ When server-side encryption is used, you are advised to use HTTPS to transmit and receive data.
diff --git a/docs/obs/api-ref/obs_04_0106.html b/docs/obs/api-ref/obs_04_0106.html
index 0b048f783..e58e8995c 100644
--- a/docs/obs/api-ref/obs_04_0106.html
+++ b/docs/obs/api-ref/obs_04_0106.html
@@ -24,7 +24,7 @@
|
Explanation:
Indicates that SSE-KMS is used for server-side encryption.
-Example: x-obs-server-side-encryption:kms
+Example: x-obs-server-side-encryption:kms
Restrictions:
None
Value range:
@@ -39,9 +39,9 @@
|
Explanation:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Restrictions:
This header can only be used when you specify kms for the x-obs-server-side-encryption header.
-Default value:
+Default value:
If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it.
|