2025-05-09
|
This issue is the fourteenth official release.
This issue incorporates the following changes:
diff --git a/docs/obs/api-ref/obs_04_0007.html b/docs/obs/api-ref/obs_04_0007.html
index ff6612df8..3ed86a38f 100644
--- a/docs/obs/api-ref/obs_04_0007.html
+++ b/docs/obs/api-ref/obs_04_0007.html
@@ -6,55 +6,106 @@
The following provides a common URI format. The parameters in square brackets [ ] are optional.
protocol://[bucket.]domain[:port][/object][?param]
-Table 1 URI parametersParameter
+Table 1 URI parametersParameter
|
-Description
+ | Type
|
-Mandatory
+ | Mandatory (Yes/No)
+ |
+Description
|
|---|
-protocol
+ | protocol
|
-Protocol used for sending requests, which can be either HTTP or HTTPS. HTTPS is a protocol that ensures secure access to resources.
+ | String
|
-Yes
+ | Yes
+ |
+Definition:
+Protocol used for sending requests
+Constraints:
+None
+Range:
+- HTTP: HyperText Transfer Protocol. Data is transmitted in plaintext. It is easy to be eavesdropped and tampered with. It is usually used to transmit website content that does not contain sensitive information, such as news.
- HTTPS: HyperText Transfer Protocol Secure. Data is encrypted using SSL/TLS to provide secure and reliable communication. It is used to transmit sensitive information.
+Default value:
+None
|
-bucket
+ | bucket
|
-Resource path of a bucket, identifying only one bucket in OBS
+ | String
|
-No
+ | No
+ |
+Definition:
+Bucket name
+Constraints:
+- 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.
+Default value:
+None
|
-domain
+ | domain
|
-Domain name or IP address of the server for saving resources
+ | String
|
-Yes
+ | Yes
+ |
+Definition:
+Endpoint of each region, for example, obs.region.example.com
+Constraints:
+None
+Default value:
+None
|
-port
+ | port
|
-Port enabled for protocols used for sending requests. The value varies with software server deployment. If no port number is specified, the protocol uses the default value. Each transmission protocol has its default port number.
-In OBS, the default HTTP port number is 80 and that of HTTPS is 443.
+ | String
|
-No
+ | No
+ |
+Definition:
+Port enabled for sending requests. The value varies with software server deployment.
+Constraints:
+None
+Range:
+In OBS, the default HTTP port is 80 and that of HTTPS is 443.
+Default value:
+If no port number is specified, the protocol uses the default value. Each transmission protocol has its default port number.
|
-object
+ | object
|
-An object path used in the request
+ | String
|
-No
+ | No
+ |
+Definition:
+Object name. 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.
+For example, if the access path is examplebucket.obs.eu-de.otc.t-systems.com/folder/test.txt, the object name is folder/test.txt.
+Range:
+The value is a string of 1 to 1024 characters.
+Default value:
+None
|
-param
+ | param
|
-A specific resource contained by a bucket or object. Default value of this parameter indicates that the bucket or object itself is obtained.
+ | String
|
-No
+ | No
+ |
+Definition:
+Requested bucket and object
+Constraints:
+None
+Range:
+None
+Default value:
+If this parameter is not set, the bucket or object involved in the request is used by default.
|
@@ -108,60 +159,93 @@
Request HeadersRefers to optional and additional request fields, for example a field required by a specific URI or HTTP method. For details about the fields of common request headers, see Table 3.
- Table 3 Common request headersHeader
+Table 3 Common request headersHeader
|
-Description
+ | Type
|
-Mandatory
+ | Mandatory (Yes/No)
+ |
+Description
|
|---|
-Authorization
+ | Authorization
|
-Signature information contained in a request message
-Type: string
-No default value.
-Conditional: optional for anonymous requests and required for other requests.
+ | String
|
-Conditionally required
+ | Conditionally Yes
+ |
+Definition:
+Signature information contained in a request message
+Constraints:
+This header is optional for anonymous requests and is mandatory for other requests.
+Range:
+None
+Default value:
+None
|
-Content-Length
+ | Content-Length
|
-The message length (excluding headers) defined in RFC 2616
-Type: string
-No default value.
-Conditional: optional for PUT requests, but mandatory for the requests that load XML content
+ | String
|
-Conditionally required
+ | Conditionally Yes
+ |
+Definition:
+Length of a message (excluding the message header).
+Constraints:
+It is optional for the PUT operation and mandatory for the operation of loading XML files.
+Range:
+None
+Default value:
+None
|
-Content-Type
+ | Content-Type
|
-The content type of the requested resource, for example, text/plain
-Type: string
-No default value.
+ | String
|
-No
+ | No
+ |
+Definition:
+The content type of the requested resource, for example, text/plain
+Constraints:
+None
+Default value:
+If this header is not carried when an object is uploaded, the value of Content-Type returned by default when the object is downloaded is binary/octet-stream.
|
-Date
+ | Date
|
-Time when a request is initiated, for example, Wed, 27 Jun 2018 13:39:15 +0000.
-Type: string
-No default value.
-Conditional: optional for anonymous requests or those requests containing header x-obs-date, required for other requests.
+ | String
|
-Conditionally required
+ | Conditionally Yes
+ |
+Definition:
+Time when a request is initiated, for example, Wed, 27 Jun 2018 13:39:15 +0000
+Constraints:
+This header is optional for anonymous requests or requests whose headers contain the x-obs-date field and mandatory for other requests.
+Range:
+None
+Default value:
+None
|
-Host
+ | Host
|
-The host address, for example, bucketname.obs.region.example.com.
-Type: string
-No default value.
+ | String
|
-Yes
+ | Yes
+ |
+Definition:
+Access domain name of a bucket. The format is BucketName.Endpoint, for example, obs.region.example.com.
+Example: examplebucketname.obs.region.example.com
+Constraints:
+The constraints on bucket names are as follows:
+- 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.
+Default value:
+None
|
diff --git a/docs/obs/api-ref/obs_04_0020.html b/docs/obs/api-ref/obs_04_0020.html
index 75c84ff4f..dd01a099f 100644
--- a/docs/obs/api-ref/obs_04_0020.html
+++ b/docs/obs/api-ref/obs_04_0020.html
@@ -19,7 +19,7 @@ Authorization: authorization
Request ParametersThis request contains no parameters.
Request HeadersThis request header uses common message fields. For details, see Table 3.
- The operation message header is the same as that of a common request. For details, see Table 3. However, this request can contain additional headers. The following table describes the additional headers for this request.
+ This request's message header is the same as that of a common request. For details, see Table 3. This request can contain additional headers. The following table describes the additional headers for this request.
Table 1 Additional request headersHeader
|
diff --git a/docs/obs/api-ref/obs_04_0021.html b/docs/obs/api-ref/obs_04_0021.html
index 1eb62ad2b..b9d55b473 100644
--- a/docs/obs/api-ref/obs_04_0021.html
+++ b/docs/obs/api-ref/obs_04_0021.html
@@ -2,11 +2,11 @@
Creating a Bucket
FunctionsThis operation is used to create a bucket with a specified name.
-  - By default, a user can have a maximum of 100 buckets.
- The name of a deleted bucket can be reused for a bucket or a parallel file system at least 30 minutes after the deletion.
- You can enable WORM when you create a bucket. After WORM is enabled, you can configure retention policies for objects you upload to the bucket. For more information, see Configuring a Default WORM Policy for a Bucket. When you create a bucket with WORM enabled, OBS automatically enables versioning for the bucket, which cannot be suspended. When you create a parallel file system, you cannot enable WORM for it.
+ - By default, a user can have a maximum of 100 buckets.
- OBS buckets are global resources, so each bucket name must be unique across all users, including your own. To reuse the name of a deleted bucket for another bucket, you must wait until the bucket name is released. Deleting a bucket via API takes about 30 minutes. However, the process may take longer if the bucket is not empty, or if the account is in arrears or has been deregistered. OBS cannot guarantee immediate deletion. Therefore, if you attempt to create a new bucket using a name that has not been released, the creation will fail. Similarly, if the name is released but claimed by another user before you reuse it, the creation will also fail.
- You can enable WORM when you create a bucket. After WORM is enabled, you can configure retention policies for objects you upload to the bucket. For more information, see Configuring a Default WORM Policy for a Bucket. When you create a bucket with WORM enabled, OBS automatically enables versioning for the bucket, which cannot be suspended. When you create a parallel file system, you cannot enable WORM for it.
A bucket name must be unique in OBS. If a user creates a bucket with the same name as that of an existing bucket under the same account and in the same region, a 200 code (indicating success) is returned. In scenarios other than the preceding one, the request for creating a bucket with the same name as that of an existing one will receive the 409 code (indicating that a namesake bucket already exists). To set an access control policy for the bucket to be created, you can add the x-obs-acl parameter to request headers.
- Storage ClassYou can create buckets with different storage classes. The x-obs-storage-class header in a bucket creation request specifies the bucket's storage class. If you do not specify a storage class when you upload an object to the bucket, the object inherits the storage class of the bucket. The storage class options are as follows: STANDARD (Standard), WARM (Warm), COLD (Cold). If the x-obs-storage-class header is not in the request, a Standard bucket will be created.
+ Storage ClassYou can create buckets with different storage classes. The x-obs-storage-class header in a bucket creation request specifies the bucket's storage class. If you do not specify a storage class when you upload an object to the bucket, the object inherits the storage class of the bucket. The storage class options are as follows: STANDARD (Standard), WARM (Warm), COLD (Cold). If the x-obs-storage-class header is not in the request, a Standard bucket will be created.
If the storage class of an object is not specified when it is uploaded to a bucket (see Uploading an Object - PUT), the object will be stored in the default storage class of the bucket.
- OBS Standard features low access latency and high throughput. It is most suitable for storing frequently accessed (multiple times per month) hot files. Potential application scenarios include big data, mobile applications, trending videos, and social media images.
- OBS Warm storage class is suitable for storing data that is infrequently accessed (less than 12 times a year) yet has quick response requirements. Potential application scenarios include file synchronization or sharing and enterprise backup. It provides the same durability, access latency, and throughput as the Standard storage class but at a lower price. However, the Warm storage class has lower availability than the Standard one.
- OBS Cold storage class is applicable to archiving rarely-accessed (averagely once a year) data. The application scenarios include data archiving and long-term data retention for backup. The Cold storage class is secure, durable, and inexpensive, which can replace tape libraries. However, the low cost comes at the cost of minutes to hours needed to restore data from the Cold storage class.
@@ -32,7 +32,7 @@ Authorization: authorization
Request ParametersThis request contains no parameters.
- Request HeadersThe operation message header is the same as that of a common request. For details, see Table 3. However, this request can contain additional headers. The following table describes the additional headers for this request.
+ Request HeadersThe operation message header is the same as that of a common request. For details, see Table 3. However, this request can contain additional headers. The following table describes the additional headers for this request. Note that the bucket name is specified in the Host field of Table 3.
Table 1 Additional request headersHeader
|
@@ -40,7 +40,7 @@ Authorization: authorization
Mandatory (Yes/No)
|
-Description
+ | Description
|
|---|
@@ -50,9 +50,9 @@ Authorization: authorization
No
|
-Explanation:
+ | Definition:
When creating a bucket, you can use this parameter to set a pre-defined ACL.
-Value range:
+Range:
- private: A bucket or an object can be accessed only by its owner.
- public-read: If this permission is granted on a bucket, anyone can read the object list, multipart uploads, and bucket metadata.
- public-read-write: If this permission is granted on a bucket, anyone can obtain the object list, multipart tasks, and metadata, and can upload or delete objects, initiate multipart upload tasks, upload parts, assemble parts, copy parts, and cancel multipart upload tasks.
- public-read-delivered: If this permission is set for a bucket, everyone can obtain the object list, multipart uploads, and bucket metadata in the bucket, and obtain the content and metadata of the objects in the bucket.
- public-read-write-delivered: If this permission is set for a bucket, everyone can obtain the object list in the bucket, multipart uploads in the bucket, and metadata of the bucket; upload and delete objects; initiate multipart uploads; upload, assemble, and copy parts; cancel multipart uploads; and obtain content and metadata of objects in the bucket.
- bucket-owner-full-control: If this permission is granted on an object, only the bucket and object owners have the full control over the object.
By default, if you upload an object to a bucket of any other user, the bucket owner does not have the permissions on your object. After you grant this policy to the bucket owner, the bucket owner can have full control over your object.
For example, if user A uploads object x to user B's bucket, user B does not have the control over object x. If user A sets the bucket-owner-full-control policy for object x, user B then has the control over object x.
@@ -66,9 +66,9 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
When creating a bucket, you can add this header to set the default storage class for the bucket.
-Value range:
+Range:
- STANDARD (Standard storage)
- WARM (Warm storage)
- COLD (Cold storage)
Default value:
STANDARD
@@ -80,12 +80,12 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
Grants the read permission to all users in a specified domain. It allows you to list objects in a bucket, list multipart tasks in a bucket, list multi-version objects in a bucket, and obtain bucket metadata.
Example: x-obs-grant-read:id=tenant-ID
-Restrictions:
+Constraints:
None
-Value range:
+Range:
id=tenant-ID. For details, see Obtaining a Domain ID and a User ID.
Default value:
None
@@ -97,14 +97,14 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
Grants the WRITE permission to all users in a specified domain to create, delete, and overwrite all objects in a bucket; and initiate multipart uploads, upload parts, copy parts, assemble parts, and cancel multipart uploads.
Example: x-obs-grant-write:id=tenant-ID
-Restrictions:
+Constraints:
None
-Value range:
+Range:
id=tenant-ID. For details, see Obtaining a Domain ID and a User ID.
-Default value:
+Default value:
None
|
@@ -114,14 +114,14 @@ Authorization: authorization
No
|
-Explanation:
+ | Definition:
Grant the READ_ACP permission to all users in a specified domain to allow them to read the bucket ACL.
-Example: x-obs-grant-read-acp:id=Account ID
-Restrictions:
+Example: x-obs-grant-read-acp:id=Account ID
+Constraints:
None
-Value range:
+Range:
id=tenant-ID. For details, see Obtaining a Domain ID and a User ID.
-Default value:
+Default value:
None
|
@@ -131,14 +131,14 @@ Authorization: authorization
No
|
-Explanation:
+ | Definition:
Grants the WRITE_ACP permission to all users in a specified domain to allow them to modify the bucket ACL.
-Example: x-obs-grant-write-acp:id=Account ID
-Restrictions:
+Example: x-obs-grant-write-acp:id=Account ID
+Constraints:
None
-Value range:
+Range:
id=tenant-ID. For details, see Obtaining a Domain ID and a User ID.
-Default value:
+Default value:
None
|
@@ -148,14 +148,14 @@ Authorization: authorization
No
|
-Explanation:
+ | Definition:
Grants the FULL_CONTROL permission to all users in a specified domain.
Example: x-obs-grant-full-control:id=tenant-ID
-Restrictions:
+Constraints:
None
-Value range:
+Range:
id=tenant-ID. For details, see Obtaining a Domain ID and a User ID.
-Default value:
+Default value:
None
|
@@ -165,14 +165,14 @@ Authorization: authorization
No
|
-Explanation:
+ | Definition:
Grants the READ permission to all users in a specified domain. By default, the read permission is granted on all objects in the bucket.
Example: x-obs-grant-read-delivered:id=tenant-ID
-Restrictions:
+Constraints:
None
-Value range:
+Range:
id=tenant-ID. For details, see Obtaining a Domain ID and a User ID.
-Default value:
+Default value:
None
|
@@ -182,14 +182,14 @@ Authorization: authorization
No
|
-Explanation:
+ | Definition:
Grants the FULL_CONTROL permission to all users in a specified domain. By default, the FULL_CONTROL permission is granted on all objects in the bucket.
Example: x-obs-grant-full-control-delivered:id=tenant-ID
-Restrictions:
+Constraints:
None
-Value range:
+Range:
id=tenant-ID. For details, see Obtaining a Domain ID and a User ID.
-Default value:
+Default value:
None
|
@@ -199,10 +199,10 @@ Authorization: authorization
No
|
-Explanation:
+ | Definition:
This header can be carried when you want to create a parallel file system.
-Example: x-obs-fs-file-interface:Enabled
-Value range:
+Example: x-obs-fs-file-interface:Enabled
+Range:
Enabled
Default value:
If the header is specified, the value must be Enabled. There is no default value.
@@ -214,15 +214,15 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
When creating a bucket, you can use this header to enable WORM for the bucket.
-Example: x-obs-bucket-object-lock-enabled:true
-Restrictions:
+Example: x-obs-bucket-object-lock-enabled:true
+Constraints:
Only object buckets are supported.
-Value range:
-true: WORM is enabled.
+Range:
+
Default value:
-If the header is specified, the value must be true. There is no default value. If the header is not specified, WORM is disabled.
+If the header is specified, the value must be true or True. If the header is not specified, the object lock policy is disabled.
|
@@ -231,7 +231,7 @@ Authorization: authorization
Request ElementsThis request can use additional elements. For details about additional elements, see Table 2.
- Table 2 Additional request elementsElement
+Table 2 Additional request elementsElement
|
Type
|
@@ -247,14 +247,14 @@ Authorization: authorization
No
|
-Explanation:
+ | Definition:
Specifies the region where a bucket will be created.
-- When creating a bucket using the endpoint of the default region, note the following:
- If Location is not specified, the bucket is created in the default region.
- If Location is specified to other region, the bucket is created in the specified region.
- - When creating a bucket using the endpoint of a non-default region, Location must be specified to the region corresponding to the endpoint.
-Restrictions:
+- When creating a bucket using the endpoint of the default region, note the following:
- If Location is not specified, the bucket is created in the default region.
- If Location is specified to another region, the bucket is created in the specified region.
+ - When creating a bucket using the endpoint of a non-default region, Location must be specified to the region corresponding to the endpoint.
+Constraints:
If the used endpoint is obs.otc.t-systems.com, this parameter is not required. If any other endpoint is used, this parameter is required.
-Value range:
+Range:
For details about OBS regions and endpoints, see Regions and Endpoints.
Default value:
If the endpoint is obs.otc.t-systems.com and no region is specified, the default value is eu-de.
diff --git a/docs/obs/api-ref/obs_04_0022.html b/docs/obs/api-ref/obs_04_0022.html
index f9f76c278..c82951084 100644
--- a/docs/obs/api-ref/obs_04_0022.html
+++ b/docs/obs/api-ref/obs_04_0022.html
@@ -45,11 +45,11 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
Name prefix that the objects to be listed must contain.
-Restrictions:
+Constraints:
The value must comply with the format of the object name.
-Value range:
+Range:
The value can contain 1 to 1,024 characters.
Default value:
None
@@ -61,11 +61,11 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
Name of the object to start with when listing objects in a bucket. All objects following this object are listed in lexicographical order by object name.
-Restrictions:
+Constraints:
This parameter is used only for listing non-versioned objects.
-Value range:
+Range:
The value can contain 1 to 1,024 characters.
Default value:
None
@@ -77,11 +77,11 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
The maximum number of objects returned in the response in alphabetical order
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value ranges from 1 to 1000. If the specified value is greater than 1000, only 1,000 objects are returned.
Default value:
1000
@@ -93,13 +93,13 @@ Authorization: authorization
|
No
|
-Explanation:
-Separator used to group object names. If a prefix is specified, objects with the same string from the prefix to the first delimiter are grouped into one CommonPrefixes. If no prefix is specified, objects with the same string from the first character to the first delimiter are grouped into one CommonPrefixes.
-For example, there are three objects (abcd, abcde, and bbcde) in a bucket. If delimiter is set to d and prefix is set to a, objects abcd and abcde are grouped into a CommonPrefixes with abcd as the prefix. If only delimiter is set to d, objects abcd and abcde are grouped into a CommonPrefixes with abcd as the prefix, and bbcde is grouped separately into another CommonPrefixes with bbcd as the prefix.
-For a parallel file system, if this parameter is not specified, all the content in the directory is recursively listed by default, including the content in subdirectories. If there are a large number of subdirectories, the request response may be slow or the request may fail. In big data scenarios, parallel file systems usually have deep directory levels and each directory has a large number of files. In such case, you are advised to configure [delimiter=/] to list the content in the current directory, but not list subdirectories, thereby improving the listing efficiency.
-Restrictions:
+ | Definition:
+Separator used to group object names. If a prefix is specified, objects with the same string from the prefix to the first delimiter are grouped into one CommonPrefixes. If no prefix is specified, objects with the same string from the first character to the first delimiter are grouped into one CommonPrefixes.
+For example, there are three objects (abcd, abcde, and bbcde) in a bucket. If delimiter is set to d and prefix is set to a, objects abcd and abcde are grouped into a CommonPrefixes with abcd as the prefix. If only delimiter is set to d, objects abcd and abcde are grouped into a CommonPrefixes with abcd as the prefix, and bbcde is grouped separately into another CommonPrefixes with bbcd as the prefix.
+For a parallel file system, if this parameter is not specified, all the content in the directory is recursively listed by default, including the content in subdirectories. If there are a large number of subdirectories, the request response may be slow or the request may fail. In big data scenarios, parallel file systems usually have deep directory levels and each directory has a large number of files. In such case, you are advised to configure [delimiter=/] to list the content in the current directory, but not list subdirectories, thereby improving the listing efficiency.
+Constraints:
None
-Value range:
+Range:
The value can contain 1 to 1,024 characters.
Default value:
None
@@ -111,11 +111,11 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
Object name to start with when listing object versions in a bucket. All object versions following the specified value are listed in lexicographical order by object name.
-Restrictions:
+Constraints:
This field is used only for listing versioned objects.
-Value range:
+Range:
The value of NextKeyMarker in the response body of the last request
Default value:
None
@@ -127,11 +127,11 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
Version ID to start with when listing objects in a bucket. All objects following the specified value are listed in lexicographical order by object name and version ID. This parameter must be used together with key_marker. A maximum of 1,000 objects can be returned at a time. key_marker specifies the object name, and version_id_marker specifies the version of the specified object.
-Restrictions:
+Constraints:
- This parameter is only used for listing objects with multiple versions.
- If the value of version_id_marker is not a version ID that belongs to the object specified by key_marker, version_id_marker does not take effect.
-Value range:
+Range:
Object version ID, that is, the value of nextVersionIdMarker in the response body of the last request
Default value:
None
@@ -142,6 +142,37 @@ Authorization: authorization
Request HeadersThis request uses common request headers. For details, see Table 3.
+ In addition to the common request headers, the header listed in Table 2 may be used.
+
+ Table 2 Additional request headerHeader
+ |
+Type
+ |
+Mandatory (Yes/No)
+ |
+Description
+ |
+
|---|
+
+x-obs-request-payer
+ |
+String
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Request ElementsThis request contains no elements.
Response HeadersThe response to the request uses common headers. For details, see Table 1.
- Response ElementsThis response lists objects in XML format. Specific elements are described in Table 2.
+ In addition to the common response headers, the header listed in Table 3 may be used.
- Table 2 Response elementsParameter
+Table 3 Additional response headerHeader
+ |
+Type
+ |
+Mandatory (Yes/No)
+ |
+Description
+ |
+
|---|
+
+x-obs-request-payer
+ |
+string
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Response ElementsThis response lists objects in XML format. Specific elements are described in Table 4.
+
+ Table 4 Response elementsParameter
|
Type
|
@@ -180,11 +242,11 @@ Authorization: authorization
XML
|
-Explanation:
+ | Definition:
A list of objects in a bucket
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -194,12 +256,12 @@ Authorization: authorization
|
XML
|
-Explanation:
+ | Definition:
Object metadata
Parent: ListBucketResult
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -209,12 +271,12 @@ Authorization: authorization
|
XML
|
-Explanation:
+ | Definition:
Group information. If you specify a delimiter in the request, the response contains group information in CommonPrefixes.
Parent: ListBucketResult
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -224,13 +286,13 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Separator used to group object names. If a prefix is specified, objects with the same string from the prefix to the first delimiter are grouped into one CommonPrefix. If no prefix is specified, objects with the same string from the first character to the first delimiter are grouped into one CommonPrefix.
Assume that a bucket has objects abcd, abcde, and bbcde in it. If delimiter is set to d and prefix is set to a, objects abcd and abcde are grouped into a commonPrefix with abcd as the prefix. If only delimiter is set to d, objects abcd and abcde are grouped into a commonPrefix with abcd as the prefix, and bbcde is grouped separately into another commonPrefix with bbcd as the prefix.
Parent: ListBucketResult
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value can contain 1 to 1,024 characters.
Default value:
None
@@ -240,12 +302,12 @@ Authorization: authorization
|
String
|
-Explanation:
-Base64-encoded 128-bit MD5 digest of an 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. The ETag value is a hash of the object. The ETag reflects changes to the object content, rather than the object metadata. An uploaded object or copied object has a unique ETag after being encrypted using MD5.
+ | Definition:
+Base64-encoded 128-bit MD5 digest of an 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. The ETag value is a hash of the object. The ETag reflects changes to the object content, rather than the object metadata. An uploaded object or copied object has a unique ETag after being encrypted using MD5.
Parent: ListBucketResult.Contents
Restriction:
If the object is encrypted on the server side, the ETag value is not the MD5 digest of the object, but the unique identifier calculated through server-side encryption.
-Value range:
+Range:
The value must contain 32 characters.
Default value:
None
@@ -255,12 +317,12 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Object type
Parent: ListBucketResult.Contents
-Restrictions:
+Constraints:
This parameter is returned when the object is not a Normal object.
-Value range:
+Range:
- Normal: normal objects
- APPENDABLE: appendable objects
Default value:
None
@@ -270,12 +332,12 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Domain ID of the object owner
Parent: ListBucketResult.Contents.Owner
-Restrictions:
+Constraints:
None
-Value range:
+Range:
DomainId
Default value:
None
@@ -285,12 +347,12 @@ Authorization: authorization
|
Boolean
|
-Explanation:
+ | Definition:
Whether all results are returned in the response.
Parent: ListBucketResult
-Restrictions:
+Constraints:
None
-Value range:
+Range:
- true: Not all results are returned.
- false: All results are returned.
Default value:
None
@@ -300,12 +362,12 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Object name. 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.
Parent: ListBucketResult.Contents
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value can contain 1 to 1,024 characters.
Default value:
None
@@ -315,13 +377,13 @@ Authorization: authorization
|
Date
|
-Explanation:
+ | Definition:
Time (UTC) when an object was last modified
Parent: ListBucketResult.Contents
-Restrictions:
+Constraints:
The date is in the ISO8601 format.
Example: 2018-01-01T00:00:00.000Z
-Value range:
+Range:
None
Default value:
None
@@ -331,13 +393,13 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Name of the object to start with when listing objects in a bucket. All objects following this object are listed in lexicographical order by object name.
Assume that you have the following objects: test/a, test/b, test/c, and test/d. If you specify test/b as the marker, test/c and test/d are returned.
Parent: ListBucketResult
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value can contain 1 to 1,024 characters.
Default value:
None
@@ -347,12 +409,12 @@ Authorization: authorization
|
String
|
-Explanation:
-The last object in the returned list. This parameter is returned when not all the objects are listed. You can set the Marker value to list the remaining objects in follow-up requests.
+ | Definition:
+The last object in the returned list. This parameter is returned when not all the objects are listed. You can set the Marker value to list the remaining objects in follow-up requests.
Parent: ListBucketResult
-Restrictions:
+Constraints:
None
-Value range:
+Range:
An object name string
Default value:
None
@@ -362,12 +424,12 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
The maximum number of objects returned in the response in alphabetical order
Parent: ListBucketResult
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value ranges from 1 to 1000. If a value larger than 1000 is specified, 1000 is used.
Default value:
1000
@@ -377,10 +439,10 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Bucket name
Parent: ListBucketResult
-Restrictions:
+Constraints:
- 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.
Default value:
@@ -391,12 +453,12 @@ Authorization: authorization
|
XML
|
-Explanation:
+ | Definition:
User information, including the domain ID and name of the object owner
Parent: ListBucketResult.Contents
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -406,12 +468,12 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Name of the object owner
Parent: ListBucketResult.Contents.Owner
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -421,13 +483,13 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Name prefix that the objects to be listed must contain.
Assume that you have the following objects: logs/day1, logs/day2, logs/day3, and ExampleObject.jpg. If you specify logs/ as the prefix, logs/day1, logs/day2, and logs/day3 will be returned. If you leave this parameter blank and there are also no other filters specified, all objects in the bucket will be returned.
Parent: ListBucketResult
-Restrictions:
+Constraints:
The prefix you specified must already exist in the bucket.
-Value range:
+Range:
The value can contain 1 to 1,024 characters.
Default value:
None
@@ -437,12 +499,12 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Object size in bytes
Parent: ListBucketResult.Contents
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value ranges from 0 TB to 48.8 TB, in bytes.
Default value:
None
@@ -452,12 +514,12 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Storage class of an object.
Parent: ListBucketResult.Contents
-Restrictions:
+Constraints:
None
-Value range:
+Range:
Default value:
None
@@ -467,9 +529,9 @@ Authorization: authorization
|
|---|
- Table 3 Elements in the response message for listing versioned objectsParameter
+Table 5 Elements in the response message for listing versioned objectsParameter
|
-Type
+ | Type
|
Description
|
@@ -479,11 +541,11 @@ Authorization: authorization
Container
|
-Explanation:
+ | Definition:
Container for the list of objects (including versioned objects)
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -493,13 +555,13 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Bucket name
Parent: ListVersionsResult
-Restrictions:
+Constraints:
- 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:
+Range:
None
Default value:
None
@@ -509,13 +571,13 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Name prefix that the objects to be listed must contain.
-Assume that you have the following objects: logs/day1, logs/day2, logs/day3, and ExampleObject.jpg. If you specify logs/ as the prefix, logs/day1, logs/day2, and logs/day3 will be returned. If you leave this parameter blank and there are also no other filters specified, all objects in the bucket will be returned.
+Assume that you have the following objects: logs/day1, logs/day2, logs/day3, and ExampleObject.jpg. If you specify logs/ as the prefix, logs/day1, logs/day2, and logs/day3 will be returned. If you leave this parameter blank and there are also no other filters specified, all objects in the bucket will be returned.
Parent: ListVersionsResult
-Restrictions:
+Constraints:
The prefix you specified must already exist in the bucket.
-Value range:
+Range:
The value can contain 1 to 1,024 characters.
Default value:
None
@@ -525,13 +587,13 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Name of the object to start with when listing objects in a bucket. All objects following this object are listed in lexicographical order by object name.
-Assume that you have the following objects: test/a, test/b, test/c, and test/d. If you specify test/b as the marker, test/c and test/d are returned.
+Assume that you have the following objects: test/a, test/b, test/c, and test/d. If you specify test/b as the marker, test/c and test/d are returned.
Parent: ListVersionsResult
-Restrictions:
+Constraints:
This parameter is used only for listing versioned objects.
-Value range:
+Range:
The value can contain 1 to 1,024 characters.
Default value:
None
@@ -541,11 +603,11 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Version ID to start with when listing versioned objects, which is consistent with that set in the request
-Restrictions:
+Constraints:
This parameter is used only for listing versioned objects.
-Value range:
+Range:
The value must contain 32 characters.
Default value:
None
@@ -555,12 +617,12 @@ Authorization: authorization
|
String
|
-Explanation:
-Start position when listing versioned objects in the next request. Key marker for the last returned object in the list. NextKeyMarker is returned when not all the objects are listed. You can set the KeyMarker value to list the remaining objects in follow-up requests.
+ | Definition:
+Start position when listing versioned objects in the next request. Key marker for the last returned object in the list. NextKeyMarker is returned when not all the objects are listed. You can set the KeyMarker value to list the remaining objects in follow-up requests.
Parent: ListVersionsResult
-Restrictions:
+Constraints:
None
-Value range:
+Range:
An object name string
Default value:
None
@@ -570,14 +632,14 @@ Authorization: authorization
|
String
|
-Explanation:
-Version ID to start with when listing versioned objects in the next request. It is used with the nextKeyMarker parameter. Version ID marker for the last returned object in the list. NextVersionIdMarker is returned when not all the objects are listed. You can set the VersionIdMarker value to list the remaining objects in follow-up requests.
+ | Definition:
+Version ID to start with when listing versioned objects in the next request. It is used with the nextKeyMarker parameter. Version ID marker for the last returned object in the list. NextVersionIdMarker is returned when not all the objects are listed. You can set the VersionIdMarker value to list the remaining objects in follow-up requests.
Parent: ListVersionsResult
-Restrictions:
+Constraints:
This parameter is used only for listing versioned objects.
-Value range:
+Range:
The value must contain 32 characters.
-Default value:
+Default value:
None
|
|---|
@@ -585,12 +647,12 @@ Authorization: authorization
String
|
-Explanation:
+ | Definition:
The maximum number of objects returned in the response in alphabetical order
Parent: ListVersionsResult
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value ranges from 1 to 1000. If a value larger than 1000 is specified, 1000 is used.
Default value:
1000
@@ -600,12 +662,12 @@ Authorization: authorization
|
Boolean
|
-Explanation:
+ | Definition:
Whether all results are returned in the response.
Parent: ListVersionsResult
-Restrictions:
+Constraints:
None
-Value range:
+Range:
- true: Not all results are returned.
- false: All results are returned.
Default value:
None
@@ -615,12 +677,12 @@ Authorization: authorization
|
Container
|
-Explanation:
+ | Definition:
Container that contains the version information
Parent: ListVersionsResult
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -630,14 +692,14 @@ Authorization: authorization
|
Container
|
-Explanation:
+ | Definition:
Container that contains objects with delete markers
Parent: ListVersionsResult
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
-Default value:
+Default value:
None
|
@@ -645,12 +707,12 @@ Authorization: authorization
String
|
-Explanation:
+ | Definition:
Name of the versioned object. 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.
Parent: ListVersionsResult.Version | ListVersionsResult.DeleteMarker
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value can contain 1 to 1,024 characters.
Default value:
None
@@ -660,14 +722,14 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Version ID of the object.
Parent: ListVersionsResult.Version | ListVersionsResult.DeleteMarker
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value must contain 32 characters.
-Default value:
+Default value:
None
|
@@ -675,12 +737,12 @@ Authorization: authorization
Boolean
|
-Explanation:
+ | Definition:
Whether the object is of the latest version
Parent: ListVersionsResult.Version | ListVersionsResult.DeleteMarker
-Restrictions:
+Constraints:
None
-Value range:
+Range:
- true: The version is the latest.
- false: The version is not the latest.
Default value:
None
@@ -690,13 +752,13 @@ Authorization: authorization
|
Date
|
-Explanation:
+ | Definition:
Time (UTC) when an object was last modified
Parent: ListVersionsResult.Version | ListVersionsResult.DeleteMarker
-Restrictions:
+Constraints:
The date is in the ISO8601 format.
Example: 2018-01-01T00:00:00.000Z
-Value range:
+Range:
None
Default value:
None
@@ -706,12 +768,12 @@ Authorization: authorization
|
String
|
-Explanation:
-Base64-encoded 128-bit MD5 digest of an 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. The ETag value is a hash of the object. The ETag reflects changes to the object content, rather than the object metadata. An uploaded object or copied object has a unique ETag after being encrypted using MD5.
+ | Definition:
+Base64-encoded 128-bit MD5 digest of an 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. The ETag value is a hash of the object. The ETag reflects changes to the object content, rather than the object metadata. An uploaded object or copied object has a unique ETag after being encrypted using MD5.
Parent: ListVersionsResult.Version
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value must contain 32 characters.
Default value:
None
@@ -721,12 +783,12 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Object type
Parent: ListVersionsResult.Version
-Restrictions:
+Constraints:
This parameter is returned when the object is not a Normal object.
-Value range:
+Range:
- NORMAL: normal objects
- APPENDABLE: appendable objects
Default value:
None
@@ -736,12 +798,12 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Object size in bytes
Parent: ListVersionsResult.Version
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value ranges from 0 TB to 48.8 TB, in bytes.
Default value:
None
@@ -751,12 +813,12 @@ Authorization: authorization
|
Container
|
-Explanation:
+ | Definition:
User information, including the domain ID and name of the object owner
Parent: ListVersionsResult.Version | ListVersionsResult.DeleteMarker
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -766,12 +828,12 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Domain ID of the object owner
Parent: ListVersionsResult.Version.Owner | ListVersionsResult.DeleteMarker.Owner
-Restrictions:
+Constraints:
None
-Value range:
+Range:
DomainId
Default value:
None
@@ -781,12 +843,12 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Name of the object owner
Parent: ListVersionsResult.Version.Owner | ListVersionsResult.DeleteMarker.Owner
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -796,12 +858,12 @@ Authorization: authorization
|
String
|
-Explanation:
+ | Definition:
Storage class of an object
Parent: ListVersionsResult.Version
-Restrictions:
+Constraints:
None
-Value range:
+Range:
Default value:
None
@@ -811,12 +873,12 @@ Authorization: authorization
|
Container
|
-Explanation:
+ | Definition:
Group information. If you specify a delimiter in the request, the response contains group information in CommonPrefixes.
Parent: ListVersionsResult
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -826,12 +888,12 @@ Authorization: authorization
|
String
|
-Explanation:
-Indicates a different prefix in the group information in CommonPrefixes.
+ | Definition:
+Indicates a different prefix in the group information in CommonPrefixes.
Parent: ListVersionsResult.CommonPrefixes
-Restrictions:
+Constraints:
The prefix you specified must already exist in the bucket.
-Value range:
+Range:
The value can contain 1 to 1,024 characters.
Default value:
None
diff --git a/docs/obs/api-ref/obs_04_0023.html b/docs/obs/api-ref/obs_04_0023.html
index 32afbd2a5..e46c6ede0 100644
--- a/docs/obs/api-ref/obs_04_0023.html
+++ b/docs/obs/api-ref/obs_04_0023.html
@@ -15,46 +15,76 @@ Authorization: authorization
Request ParametersThis request contains no parameters.
Request HeadersThis request uses common headers. For details, see Table 3.
- If you want to get CORS configuration information, you must use the headers in Table 1.
+ Request HeadersThis request uses common headers. For details, see Table 3. You can also use the header in Table 1.
+ If you want to get CORS configuration information, you must use the headers in Table 2.
- Table 1 Request headers for obtaining CORS configurationHeader
+Table 1 Additional request headerHeader
|
-Type
+ | Type
|
-Mandatory (Yes/No)
+ | Mandatory (Yes/No)
|
-Description
+ | Description
|
|---|
-Origin
+ | x-obs-request-payer
|
-String
+ | string
|
-Yes
+ | No
|
-Explanation:
+ | Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Table 2 Request headers for obtaining CORS configurationHeader
+ |
+Type
+ |
+Mandatory (Yes/No)
+ |
+Description
+ |
+
|---|
+
+Origin
+ |
+String
+ |
+Yes
+ |
+Definition:
Origin of the cross-domain request specified by the pre-request. Generally, it is a domain name.
-Restrictions:
+Constraints:
You can enter multiple origins, with one separated from another using a line break. Each origin can contain at most one wildcard character (*).
-Value range:
+Range:
An HTTP-compliant header value
Default value:
None
|
-Access-Control-Request-Headers
+ | Access-Control-Request-Headers
|
-String
+ | String
|
-No
+ | No
|
-Explanation:
+ | Definition:
HTTP headers in a request
-Restrictions:
+Constraints:
You can enter multiple allowed headers, with one separated from another using a line break. Each header can contain one wildcard character (*) at most. Spaces, ampersands (&), colons (:), and less-than signs (<) are not allowed.
-Value range:
+Range:
An HTTP-compliant header value
Default value:
None
@@ -75,9 +105,9 @@ Date: date
Response HeadersThe response to the request uses common headers. For details, see Table 1.
- In addition to the common response headers, the headers listed in Table 2 may be used.
+ In addition to the common response headers, the headers listed in Table 3 may be used.
- Table 2 Additional response headersHeader
+Table 3 Additional response headersHeader
|
Type
|
@@ -89,11 +119,11 @@ Date: date
String
|
-Explanation:
+ | Definition:
The region where the bucket resides.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -103,11 +133,11 @@ Date: date
|
String
|
-Explanation:
+ | Definition:
Default storage class of the bucket.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
- STANDARD (Standard storage)
- WARM (Warm storage)
- COLD(Cold storage)
Default value:
None
@@ -117,11 +147,11 @@ Date: date
|
String
|
-Explanation:
+ | Definition:
OBS version of the bucket.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
- 3.0: bucket of the latest version
- --: bucket of an earlier version
Default value:
None
@@ -131,12 +161,12 @@ Date: date
|
String
|
-Explanation:
+ | Definition:
Whether it is a parallel file system
-Restrictions:
+Constraints:
If this header field is not carried, the bucket is not a parallel file system.
-Value range:
-The value can be Enabled (parallel file system).
+Range:
+The value can be Enabled (parallel file system).
Default value:
None
|
@@ -145,11 +175,11 @@ Date: date
String
|
-Explanation:
+ | Definition:
Indicates that the origin is included in the response if the origin in the request meets the CORS configuration requirements when CORS is configured for buckets.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value that complies with the CORS
Default value:
None
@@ -159,11 +189,11 @@ Date: date
|
String
|
-Explanation:
+ | Definition:
Indicates that the headers are included in the response if headers in the request meet the CORS configuration requirements when CORS is configured for buckets.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value that complies with the CORS
Default value:
None
@@ -173,11 +203,11 @@ Date: date
|
Integer
|
-Explanation:
-Value of MaxAgeSeconds in the CORS configuration of the server when CORS is configured for buckets.
-Restrictions:
+ | Definition:
+Value of MaxAgeSeconds in the CORS configuration of the server when CORS is configured for buckets.
+Constraints:
None
-Value range:
+Range:
An integer greater than or equal to 0, in seconds
Default value:
3000
@@ -187,11 +217,11 @@ Date: date
|
String
|
-Explanation:
-Indicates that methods in the rule are included in the response if Access-Control-Request-Method in the request meets the CORS configuration requirements when CORS is configured for buckets.
-Restrictions:
+ | Definition:
+Indicates that methods in the rule are included in the response if Access-Control-Request-Method in the request meets the CORS configuration requirements when CORS is configured for buckets.
+Constraints:
None
-Value range:
+Range:
Default value:
None
@@ -201,16 +231,30 @@ Date: date
|
String
|
-Explanation:
+ | Definition:
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 in this parameter.
-Restrictions:
+Constraints:
Spaces, wildcard characters (*), ampersands (&), colons (:), less-than signs (<), and full-width characters are not allowed.
-Value range:
+Range:
None
-Default value:
+Default value:
None
|
|---|
+x-obs-request-payer
+ |
+string
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
| No
|
-Explanation:
+ | Definition:
Uses the canned ACL for a bucket.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
- private
- public-read
- public-read-write
- public-read-delivered
- public-read-write-delivered
.
Default value:
@@ -95,20 +95,68 @@ Content-Length: length
|
|---|
-Owner
+ | Owner
|
XML
|
Yes
|
-Explanation:
-Bucket owner information, including the ID
-Restrictions:
+ | Definition:
+Owner information of a bucket. Owner is a parent node of ID.
+Constraints:
None
-Value range:
-None
-Default value:
-None
+ |
+
+ID
+ |
+String
+ |
+Yes
+ |
+Definition:
+Account ID of the bucket owner.
+Constraints:
+None
+Range:
+None
+Default value:
+None
+ |
+
+AccessControlList
+ |
+XML
+ |
+Yes
+ |
+Definition:
+Access control list, which is the parent node of Grant.
+Constraints:
+None
+ |
+
+Grant
+ |
+XML
+ |
+No
+ |
+Definition:
+Used to identify users and user permissions. It is the parent node of Grantee, Permission and Delivered.
+Constraints:
+A single bucket can contain at most 100 grants in its ACL.
+ |
+
+Grantee
+ |
+XML
+ |
+No
+ |
+Definition:
+Records user information and is the parent node of the authorized account ID.
+Constraints:
+None
|
ID
@@ -117,112 +165,64 @@ Content-Length: length
|
Yes
|
-Explanation:
+ | Definition:
Account ID of the authorized user.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
-Default value:
+Default value:
None
|
-Grant
- |
-XML
- |
-No
- |
-Explanation:
-Container for the grantee and the granted permissions
-Restrictions:
-A single bucket can contain at most 100 grants in its ACL.
-Value range:
-None
-Default value:
-None
- |
-
-Grantee
- |
-XML
- |
-No
- |
-Explanation:
-Grantee information
-Restrictions:
-None
-Value range:
-None
-Default value:
-None
- |
-
-Canned
+ | Canned
|
String
|
No
|
-Explanation:
+ | Definition:
Grants permissions to all users.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
Everyone
Default value:
None
|
+Permission
+ |
+String
+ |
+Yes
+ |
+Definition:
+Permissions to be granted.
+Constraints:
+None
+Range:
+- READ: Grants the permission to obtain the list of objects in the bucket and the metadata of the bucket.
- READ_ACP: Grants the permission to read the ACL of the bucket.
- WRITE: Grants the permission to upload objects to the bucket and allows to delete and overwrite existing objects in a bucket.
- WRITE_ACP: Grants the permission to update the ACL of the bucket.
- FULL_CONTROL: Grants the permission to read, write, read ACL, and write ACL of the bucket.
+Default value:
+None
+ |
+
Delivered
|
Boolean
|
No
|
-Explanation:
+ | Definition:
Whether the bucket ACL is applied to all objects in the bucket.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
- true: The bucket ACL is applied to all objects in the bucket.
- false: The bucket ACL is not applied to any objects in the bucket.
Default value:
false
|
-Permission
- |
-String
- |
-Yes
- |
-Explanation:
-Permissions to be granted.
-Restrictions:
-None
-Value range:
-- READ
- READ_ACP
- WRITE
- WRITE_ACP
- FULL_CONTROL
-Default value:
-None
- |
-
-AccessControlList
- |
-XML
- |
-Yes
- |
-Explanation:
-Indicates an ACL, which consists of three elements: Grant, Grantee, and Permission.
-Restrictions:
-None
-Value range:
-None
-Default value:
-None
- |
-
diff --git a/docs/obs/api-ref/obs_04_0032.html b/docs/obs/api-ref/obs_04_0032.html
index fa4196230..786e1fbb3 100644
--- a/docs/obs/api-ref/obs_04_0032.html
+++ b/docs/obs/api-ref/obs_04_0032.html
@@ -255,7 +255,7 @@ Authorization: signatureValue
|
200
|
-Response code
+ | Return code.
|
ErrorCode
@@ -328,6 +328,7 @@ Authorization: signatureValue
| STANDARD_IA
|
Current object storage class
+- STANDARD: Standard storage
- STANDARD_IA (also WARM): Infrequent Access storage class
- COLD: Archive storage class
|
TargetStorageClass
diff --git a/docs/obs/api-ref/obs_04_0034.html b/docs/obs/api-ref/obs_04_0034.html
index f3bf3fa0d..e27231c80 100644
--- a/docs/obs/api-ref/obs_04_0034.html
+++ b/docs/obs/api-ref/obs_04_0034.html
@@ -113,7 +113,7 @@ Content-MD5: MD5
| Description
|
-Mandatory
+ | Mandatory (Yes/No)
|
|---|
@@ -130,8 +130,8 @@ Content-MD5: MD5
Request ElementsIn this request body, you need to specify the lifecycle configuration in XML format. Table 2 describes the specific configuration elements.
- - If the versioning of a bucket is enabled or suspended, you can set NoncurrentVersionTransition or NoncurrentVersionExpiration to control the lifecycle of historical object versions. The lifecycle of a historical version depends on the time when it becomes a historical one (time when the version is replaced by a new version) and the value of NoncurrentDays. If NoncurrentDays is set to 1 in an object deletion scenario, an object version will be deleted one day after it becomes historical. If the version V1 of object A is created on the first date of a month and new version V2 is uploaded on the fifth date of the month, V1 becomes a historical version. At 00:00 on the seventh date of the month, V1 will expire. If an object version does not meet the deletion conditions, but NoncurrentDays is set to 1 and StorageClass is set to WARM, the version transitions to the Warm storage class one day after it has become a historical version. For example, the V1 version of object A is created on the first day of a month, and its new version V2 is uploaded on the fifth day of the month. Then V1 becomes a historical version. One day later, that is, at 0 o'clock of the seventh day, V1 transitions to the Warm storage class. The deletion or transition of the object after the expiration time may be delayed. The delay is within 48 hours.
- Objects are processed according to the following procedures, if their latest versions meet the expiration rule and versioning is enabled or suspended for the bucket.
|
Description
|
-Mandatory
+ | Mandatory (Yes/No)
|
|---|
@@ -233,7 +233,7 @@ Content-MD5: MD5
Child: NoncurrentDays, StorageClass
Parent: Rule
-Yes if the Transition, Expiration, AbortIncompleteMultipartUpload, and NoncurrentVersionExpiration elements are absent.
+ | Yes if the Transition, Expiration, AbortIncompleteMultipartUpload, and NoncurrentVersionExpiration elements are absent.
|
NoncurrentVersionExpiration
@@ -308,7 +308,7 @@ Content-MD5: MD5
Type: string
Parent: Tag
Constraints:
-A tag key is case sensitive and must be unique. It cannot be left blank or exceed 128 characters. The following characters are not allowed: =*<>\,|/?!;
+- If there are multiple tags specified for an object, each tag key must be unique.
- A tag key must contain 1 to 36 characters and be case sensitive.
- A tag key cannot start or end with a space or contain the following characters: ,/|<>=*\
|
Yes if Tag is present.
|
@@ -319,7 +319,7 @@ Content-MD5: MD5
Type: string
Parent: Tag
Constraints:
-A tag value is case sensitive and can be left blank. It cannot exceed 255 characters. The following characters are not allowed: =*<>\,|?!;
+- A tag value can contain 0 to 43 characters and must be case sensitive.
- A tag value cannot contain the following characters: ,/|<>=*\
Yes if Tag is present.
|
diff --git a/docs/obs/api-ref/obs_04_0037.html b/docs/obs/api-ref/obs_04_0037.html
index 0e88cd240..e17e0ccbf 100644
--- a/docs/obs/api-ref/obs_04_0037.html
+++ b/docs/obs/api-ref/obs_04_0037.html
@@ -37,30 +37,42 @@ Content-Length: length
Request ElementsThis request contains elements to configure the bucket versioning in XML format. Table 1 lists the request elements.
- Table 1 Elements for configuring bucket versioningElement
+Table 1 Elements for configuring bucket versioningParameter
|
-Description
+ | Type
|
-Mandatory
+ | Mandatory (Yes/No)
+ |
+Description
|
|---|
-VersioningConfiguration
+ | VersioningConfiguration
|
-Root node for configuring versioning
-Parent: none
+ | XML
|
-Yes
+ | Yes
+ |
+Definition:
+Root node of versioning configuration, which is the parent node of Status.
+Constraints:
+None
|
-Status
+ | Status
|
-Versioning status of the bucket
-Type: string
-Parent: VersioningConfiguration
-Value options: Enabled, Suspended
+ | String
|
-Yes
+ | Yes
+ |
+Definition:
+Versioning status of the bucket.
+Constraints:
+None
+Range:
+- Enabled: Versioning is enabled.
- Suspended: Versioning is suspended.
+Default value:
+None
|
diff --git a/docs/obs/api-ref/obs_04_0038.html b/docs/obs/api-ref/obs_04_0038.html
index cfcf1adc3..90fc9ea8d 100644
--- a/docs/obs/api-ref/obs_04_0038.html
+++ b/docs/obs/api-ref/obs_04_0038.html
@@ -42,23 +42,36 @@ Content-Length: length
Response ElementsThis response contains elements to specify the bucket versioning status. Table 1 describes the elements.
- Table 1 Response elementsElement
+Table 1 Response elementsParameter
|
-Description
+ | Type
+ |
+Description
|
|---|
-VersioningConfiguration
+ | VersioningConfiguration
|
-Element of versioning status information.
-Type: container
+ | XML
+ |
+Definition:
+Root node of versioning configuration, which is the parent node of Status.
+Constraints:
+None
|
-Status
+ | Status
|
-Versioning status of the bucket.
-Type: string
-Value options: Enabled, Suspended
+ | String
+ |
+Definition:
+Versioning status of the bucket.
+Constraints:
+None
+Range:
+- Enabled: Versioning is enabled.
- Suspended: Versioning is suspended.
+Default value:
+None
|
diff --git a/docs/obs/api-ref/obs_04_0044.html b/docs/obs/api-ref/obs_04_0044.html
index 63f8cb642..a344d57e1 100644
--- a/docs/obs/api-ref/obs_04_0044.html
+++ b/docs/obs/api-ref/obs_04_0044.html
@@ -1,10 +1,9 @@
Configuring Storage Class for a Bucket
-FunctionsThis operation sets or updates the default storage class of a bucket.
+ FunctionsThis operation sets or updates the default storage class for a bucket.
To perform this operation, you must have the PutBucketStoragePolicy permission. By default, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.
If you do not specify a storage class when uploading or copying an object, or initiating a multipart upload, the object inherits the bucket's storage class.
- The default storage class of a bucket is Standard.
Request Syntax1
2
diff --git a/docs/obs/api-ref/obs_04_0046.html b/docs/obs/api-ref/obs_04_0046.html
index 957dc58c7..8630a1286 100644
--- a/docs/obs/api-ref/obs_04_0046.html
+++ b/docs/obs/api-ref/obs_04_0046.html
@@ -2,7 +2,7 @@
Configuring Cross-Region Replication for a Bucket
FunctionsCross-region replication refers to the automatic and asynchronous replication of objects across buckets in different regions. By activating cross-region replication, OBS can copy new objects and modified objects from a source bucket in one region to a destination bucket in a different region.
- An IAM agency is required for configuring cross-region replication. For details, see section "Creating an IAM Agency" in the Object Storage Service User Guide.
+ An IAM agency is required for configuring cross-region replication. For details, see Related Operations > Creating an IAM Agency > Creating an Agency for Cross-Region Replication in the Object Storage Service User Guide.
To configure cross-region replication for a bucket, the following two requirements must be met:
- The versioning statuses of the source and destination buckets are the same. For details, see Configuring Versioning for a Bucket.
- The source bucket's owner and agency (OBS) have the write permission for the destination bucket (with a bucket policy configured), and the agency (OBS) also has the read permission for the source bucket. This permission delegation needs to be implemented by using a bucket policy.
@@ -60,7 +60,7 @@ Content-Length: contentlength
Description
|
- Mandatory
+ | Mandatory (Yes/No)
|
|
@@ -75,13 +75,13 @@ Content-Length: contentlength
- Request ElementsThis request contains elements to specify the replication configuration for the bucket in XML format. The following table lists request elements:
+ Request ElementsThe request body contains elements to specify the replication configuration for the bucket in XML format. The following table lists request elements:
Table 2 Bucket replication configuration elementsElement
|
Description
|
-Mandatory
+ | Mandatory (Yes/No)
|
|---|
diff --git a/docs/obs/api-ref/obs_04_0049.html b/docs/obs/api-ref/obs_04_0049.html
index 974a3124a..67236d3e4 100644
--- a/docs/obs/api-ref/obs_04_0049.html
+++ b/docs/obs/api-ref/obs_04_0049.html
@@ -5,7 +5,7 @@
After tags are added to a bucket, all service detail records (SDRs) generated by the requests for this bucket will have the same tags. You can categorize the SDRs for detailed cost analysis. For example, if a running application uploads data to a bucket, you can tag the bucket with the application name. In this manner, the costs on the application can be analyzed using tags in SDRs.
To perform this operation, you must have the PutBucketTagging permission. By default, only the bucket owner can delete the tags of a bucket. The bucket owner can allow other users to perform this operation by setting a bucket policy or granting them the permission.
-Restrictions- A bucket can have up to 20 tags.
+ Constraints- A bucket can have up to 20 tags.
Request Syntax 1
2
@@ -39,29 +39,32 @@ Content-MD5: md5
Request HeadersTable 1 lists the request header.
- Table 1 Request headersHeader
+Table 1 Request headersHeader
|
-Description
+ | Type
|
-Mandatory
+ | Mandatory
+ |
+Description
|
|---|
-Content-MD5
+ | Content-MD5
|
-Explanation:
+ | String
+ |
+Yes
+ |
+Definition:
Base64-encoded 128-bit MD5 digest of the message according to RFC 1864.
-Type: string
Example: n58IG6hfM7vqI4K0vnWpog==
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
|
-Yes
- |
@@ -69,71 +72,83 @@ Content-MD5: md5
Request ElementsIn this request, you must configure bucket tags in the request body. The tag configuration is uploaded in XML format. Table 2 describes the configuration elements.
- Table 2 Bucket tag configuration elementsHeader
+Table 2 Bucket tag configuration elementsHeader
|
-Description
+ | Type
|
-Mandatory
+ | Mandatory (Yes/No)
+ |
+Description
|
|---|
-Tagging
+ | Tagging
|
-Explanation:
+ | XML
+ |
+Yes
+ |
+Definition:
Root element for TagSet and Tag
-Type: container
-Parent: none
- |
-Yes
+Constraints:
+None
|
-TagSet
+ | TagSet
|
-Explanation:
-Element of the tag set
-Type: container
-Parent: Tagging
+ | XML
|
-Yes
+ | Yes
+ |
+Definition:
+Parent element of Tag. Parent: Tagging
+Constraints:
+A maximum of 20 tags can be set for a bucket. That means a TagSet can contain a maximum of 20 Tag nodes.
|
-Tag
+ | Tag
|
-Explanation:
-Information element of Tag
-Type: container
-Parent: TagSet
+ | XML
|
-Yes
+ | Yes
+ |
+Definition:
+Information element of Tag Parent: TagSet
+Constraints:
+A maximum of 20 tags can be set for a bucket. That means a TagSet can contain a maximum of 20 Tag nodes.
|
-Key
+ | Key
|
-Explanation:
-Name of a tag. Type: string. Parent: Tag.
-Restrictions:
-- A tag key can contain a maximum of 36 characters.
- Only digits, letters, underscores (_), hyphens (-) are allowed.
-Value range:
+ | String
+ |
+Yes
+ |
+Definition:
+Name of a tag. Parent: Tag.
+Constraints:
+- A tag key can contain a maximum of 36 characters.
- A tag key cannot start or end with a space or contain the following characters: ,/|<>=*\
+Range:
A string between 1 and 36 characters long.
Default value:
None
|
-Yes
- |
-Value
+ | Value
|
-Explanation:
-Tag value. Type: string. Parent: Tag.
-Restrictions:
-- A key value can contain a maximum of 43 characters.
- Only digits, letters, underscores (_), hyphens (-) are allowed.
-Value range:
+ | String
+ |
+Yes
+ |
+Definition:
+Tag value. Parent: Tag.
+Constraints:
+- A tag value can contain a maximum of 43 characters.
- A tag value cannot contain the following characters: ,/|<>=*\
+Range:
A string of 0 (included) to 43 (excluded) characters.
Default value:
None
|
-Yes
- |
diff --git a/docs/obs/api-ref/obs_04_0050.html b/docs/obs/api-ref/obs_04_0050.html
index 3a67539b0..896c9551f 100644
--- a/docs/obs/api-ref/obs_04_0050.html
+++ b/docs/obs/api-ref/obs_04_0050.html
@@ -54,47 +54,72 @@ Date: date
Response HeadersThe response to the request uses common headers. For details, see Table 1.
Response ElementsThis response contains elements to detail bucket tag configuration. Table 1 describes the elements.
+ Response ElementsThis response contains elements to detail bucket tag configuration. Table 1 describes the elements.
- Table 1 Elements for configuring bucket tagsElement
+Table 1 Bucket tag configuration elementsHeader
|
-Description
+ | Type
+ |
+Description
|
|---|
-Tagging
+ | Tagging
|
-Element of the tag set and tag.
-Type: container
-Parent: none
+ | XML
+ |
+Definition:
+Parent element of TagSet and Tag.
+Constraints:
+None
|
-TagSet
+ | TagSet
|
-Element of the tag set.
-Type: container
-Parent: Tagging
+ | XML
+ |
+Definition:
+Parent element of Tag. Parent: Tagging
+Constraints:
+A maximum of 20 tags can be set for a bucket. That means a TagSet can contain a maximum of 20 Tag nodes.
|
-Tag
+ | Tag
|
-Element of the tag information.
-Type: container
-Parent: TagSet
+ | XML
+ |
+Definition:
+Information element of Tag Parent: TagSet
+Constraints:
+A maximum of 20 tags can be set for a bucket. That means a TagSet can contain a maximum of 20 Tag nodes.
|
-Key
+ | Key
|
-Tag name.
-Type: string
-Parent: Tag
+ | String
+ |
+Definition:
+Name of a tag. Parent: Tag
+Constraints:
+- A tag key can contain a maximum of 36 characters.
- A tag key cannot start or end with a space or contain the following characters: ,/|<>=*\
+Range:
+A string between 1 and 36 characters long.
+Default value:
+None
|
-Value
+ | Value
|
-Tag value.
-Type: string
-Parent: Tag
+ | String
+ |
+Definition:
+Tag value. Parent: Tag
+Constraints:
+- A tag value can contain a maximum of 43 characters.
- A tag value cannot contain the following characters: ,/|<>=*\
+Range:
+A string of 0 (included) to 43 (excluded) characters.
+Default value:
+None
|
@@ -163,7 +188,7 @@ Content-Length: 441
<TagSet>
<Tag>
<Key>TagName1</Key>
- <Value>TageSetVaule1</Value>
+ <Value>TagSetValue1</Value>
</Tag>
</TagSet>
</Tagging>
diff --git a/docs/obs/api-ref/obs_04_0059.html b/docs/obs/api-ref/obs_04_0059.html
index 006d5dbb8..af92574cc 100644
--- a/docs/obs/api-ref/obs_04_0059.html
+++ b/docs/obs/api-ref/obs_04_0059.html
@@ -26,18 +26,18 @@ Content-Length: 0
Description
|
-Mandatory
+ | Mandatory (Yes/No)
|
customdomain
|
-Explanation:
+ | Definition:
Custom domain name of a bucket.
Type: String, which must meet the naming conventions of domain names.
-Restrictions:
+Constraints:
A bucket can have a maximum of 30 domain names. One custom domain name can be used for only one bucket.
-Value range:
+Range:
The maximum length is 256 bytes.
Default value:
None
@@ -49,7 +49,39 @@ Content-Length: 0
|
Request HeaderThis request uses common headers. For details, see Table 3.
+ Request Header
+ Table 2 Request headersHeader
+ |
+Type
+ |
+Mandatory (Yes/No)
+ |
+Description
+ |
+
|---|
+
+Content-MD5
+ |
+String
+ |
+No
+ |
+Definition:
+This header is mandatory when you configure a custom domain name certificate to verify that the content of the request body is consistent with what was sent.
+Base64-encoded 128-bit MD5 value of the request body calculated according to RFC 1864.
+Example: n58IG6hfM7vqI4K0vnWpog==
+Constraints:
+None
+Range:
+None
+Default value:
+None
+ |
+
+
+
+
+ For details about other common headers, see Table 3.
Request ElementsThis request involves no elements.
diff --git a/docs/obs/api-ref/obs_04_0061.html b/docs/obs/api-ref/obs_04_0061.html
index b77c1e771..57ae934bf 100644
--- a/docs/obs/api-ref/obs_04_0061.html
+++ b/docs/obs/api-ref/obs_04_0061.html
@@ -23,7 +23,7 @@ Authorization: authorization strin
|
Description
|
-Mandatory
+ | Mandatory (Yes/No)
|
|---|
diff --git a/docs/obs/api-ref/obs_04_0062.html b/docs/obs/api-ref/obs_04_0062.html
index c6cdc9d89..1918963ae 100644
--- a/docs/obs/api-ref/obs_04_0062.html
+++ b/docs/obs/api-ref/obs_04_0062.html
@@ -101,7 +101,7 @@ Content-Length: length
Valid value formats are as follows:
- regionID:domainID:key/key_id
- key_id
In the preceding formats:
-- regionID indicates the ID of the region where the key belongs.
- domainID indicates the ID of the domain to which the key belongs. For details, see Obtaining a Domain ID and a User ID.
- key_id indicates the ID of the key created in KMS.
+- regionID indicates the ID of the region where the key belongs.
- domainID indicates the ID of the domain to which the key belongs. For details, see Obtaining a Domain ID and a User ID.
- key_id indicates the ID of the key created in KMS.
Parent: ApplyServerSideEncryptionByDefault
No
@@ -112,7 +112,7 @@ Content-Length: length
| ID of the project where the KMS master key belongs when SSE-KMS is used. If the project is not the default one, you must use this parameter to specify the project ID.
Type: string
Value options:
-- Project ID that matches KMSMasterKeyID.
- If KMSMasterKeyID is not specified, do not set the project ID.
+- Project ID that matches KMSMasterKeyID.
- If KMSMasterKeyID is not specified, do not set the project ID.
Parent: ApplyServerSideEncryptionByDefault
NOTE: When a custom key in a non-default IAM project is used to encrypt objects, only the key owner can upload or download the encrypted objects.
diff --git a/docs/obs/api-ref/obs_04_0074.html b/docs/obs/api-ref/obs_04_0074.html
index c1864c21f..3c0cb6822 100644
--- a/docs/obs/api-ref/obs_04_0074.html
+++ b/docs/obs/api-ref/obs_04_0074.html
@@ -63,12 +63,12 @@ Content-MD5: MD5
|
Yes
|
-Explanation:
+ | Definition:
Base64-encoded 128-bit MD5 digest of the message according to RFC 1864
Example: n58IG6hfM7vqI4K0vnWpog==
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -96,12 +96,12 @@ Content-MD5: MD5
|
Yes
|
-Explanation:
+ | Definition:
Root node of CORSRules.
Parent: none
-Restrictions:
+Constraints:
The maximum size is 64 KB.
-Value range:
+Range:
None
Default value:
None
@@ -113,12 +113,12 @@ Content-MD5: MD5
|
Yes
|
-Explanation:
+ | Definition:
CORS rules
Parent: CORSConfiguration
-Restrictions:
+Constraints:
CORSConfiguration can contain a maximum of 100 rules.
-Value range:
+Range:
None
Default value:
None
@@ -130,12 +130,12 @@ Content-MD5: MD5
|
No
|
-Explanation:
+ | Definition:
The ID of a CORS rule.
Parent: CORSRule
-Restrictions:
+Constraints:
The ID cannot be longer than 255 characters.
-Value range:
+Range:
A string of 1 to 255 characters.
Default value:
None
@@ -147,15 +147,15 @@ Content-MD5: MD5
|
Yes
|
-Explanation:
+ | Definition:
The allowed HTTP methods (types of operations on buckets and objects) for a cross-origin request.
Parent: CORSRule
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The following HTTP methods are supported:
-Default value:
+Default value:
None
|
@@ -165,12 +165,12 @@ Content-MD5: MD5
Yes
|
-Explanation:
+ | Definition:
The origin that is allowed to access the bucket.
Parent: CORSRule
-Restrictions:
+Constraints:
Only English domain names are supported. Regular expressions are used to match. Each rule allows at most one asterisk (*). For example, https://*.vbs.example.com.
-Value range:
+Range:
The value must comply with the CORS protocol and contain 0 to 20480 characters.
Default value:
None
@@ -182,14 +182,14 @@ Content-MD5: MD5
|
No
|
-Explanation:
+ | Definition:
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:
+Constraints:
At most one asterisk (*) is allowed. Spaces, ampersands (&), colons (:), less-than signs (<), and full-width characters are not allowed.
-Value range:
+Range:
The value must comply with the CORS protocol and contain 0 to 20480 characters.
-Default value:
+Default value:
None
|
@@ -199,12 +199,12 @@ Content-MD5: MD5
No
|
-Explanation:
+ | Definition:
How long the response can be cached on a client
Parent: CORSRule
-Restrictions:
+Constraints:
Each CORS rule can contain at most one MaxAgeSeconds.
-Value range:
+Range:
An integer greater than or equal to 0, in seconds
Default value:
3000
@@ -216,14 +216,14 @@ Content-MD5: MD5
|
No
|
-Explanation:
+ | Definition:
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 in this parameter.
Parent: CORSRule
-Restrictions:
+Constraints:
Spaces, asterisks (*), ampersands (&), colons (:), less-than signs (<), and full-width characters are not allowed.
-Value range:
+Range:
The value that complies with the CORS
-Default value:
+Default value:
None
|
diff --git a/docs/obs/api-ref/obs_04_0077.html b/docs/obs/api-ref/obs_04_0077.html
index e1a8132e7..15b649530 100644
--- a/docs/obs/api-ref/obs_04_0077.html
+++ b/docs/obs/api-ref/obs_04_0077.html
@@ -159,7 +159,7 @@ Content-Length: length
AccessForbidden
|
-CORSResponse: This CORS request is not allowed. This is usually because the evaluation of Origin, request method / Access-Control-Request-Method or Access-Control-Request-Headers are not whitelisted by the resource's CORS specification.
+ | CORSResponse: This CORS request is not allowed. This is usually because the evaluation of Origin, request method / Access-Control-Request-Method or Access-Control-Request-Headers are not whitelisted by the resource's CORS spec.
When CORS and OPTIONS are configured for a bucket, origin, method, and headers do not match any rule.
|
403 Forbidden
diff --git a/docs/obs/api-ref/obs_04_0078.html b/docs/obs/api-ref/obs_04_0078.html
index a1113b264..5e267b0ff 100644
--- a/docs/obs/api-ref/obs_04_0078.html
+++ b/docs/obs/api-ref/obs_04_0078.html
@@ -157,7 +157,7 @@ Content-Length: length
|
AccessForbidden
|
-CORSResponse: This CORS request is not allowed. This is usually because the evaluation of Origin, request method/Access-Control-Request-Method or Access-Control-Request-Headers are not whitelisted by the resource's CORS spec.
+ | CORSResponse: This CORS request is not allowed. This is usually because the evaluation of Origin, request method / Access-Control-Request-Method or Access-Control-Request-Headers are not whitelisted by the resource's CORS spec.
When CORS and OPTIONS are configured for a bucket, origin, method, and headers do not match any rule.
|
403 Forbidden
diff --git a/docs/obs/api-ref/obs_04_0080.html b/docs/obs/api-ref/obs_04_0080.html
index 228e442e9..d29f5866f 100644
--- a/docs/obs/api-ref/obs_04_0080.html
+++ b/docs/obs/api-ref/obs_04_0080.html
@@ -62,12 +62,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
Base64-encoded 128-bit MD5 digest of the message according to RFC 1864.
Example: n58IG6hfM7vqI4K0vnWpog==
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -79,11 +79,11 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
When creating an object, you can use this parameter to set a pre-defined ACL.
-Restrictions:
+Constraints:
Pre-defined policies must be displayed in character strings.
-Value range:
+Range:
- private
- public-read
- public-read-write
Default value:
@@ -96,12 +96,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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:
+Constraints:
Use commas (,) to separate multiple domains.
-Value range:
+Range:
The value must be a valid ID. For details, see Obtaining a Domain ID and a User ID.
Default value:
None
@@ -113,12 +113,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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:
+Constraints:
Use commas (,) to separate multiple domains.
-Value range:
+Range:
The value must be a valid ID. For details, see Obtaining a Domain ID and a User ID.
Default value:
None
@@ -130,12 +130,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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:
+Constraints:
Use commas (,) to separate multiple domains.
-Value range:
+Range:
The value must be a valid ID. For details, see Obtaining a Domain ID and a User ID.
Default value:
None
@@ -147,12 +147,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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:
+Constraints:
Use commas (,) to separate multiple domains.
-Value range:
+Range:
The value must be a valid ID. For details, see Obtaining a Domain ID and a User ID.
Default value:
None
@@ -164,13 +164,13 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
When creating an object, you can use this header to specify the storage class for the object. If you do not use this header, the object storage class is the default storage class of the bucket.
Example: x-obs-storage-class: STANDARD
-Restrictions:
+Constraints:
The value is case-sensitive.
-Value range:
-
+Range:
+- STANDARD: the Standard storage class
- WARM: the Infrequent Access storage class
- COLD: the Archive storage class
Default value:
By default, the storage class of the bucket is inherited.
|
@@ -181,12 +181,12 @@ 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. 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:
+ | Definition:
+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
+Constraints:
Both metadata keys and their values must conform to US-ASCII standards.
-Value range:
+Range:
None
Default value:
None
@@ -198,15 +198,15 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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/
-Restrictions:
+Constraints:
The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
-Value range:
+Range:
None
Default value:
None
@@ -216,15 +216,14 @@ Date: date
|
String
|
-No. This header is required when SSE-KMS is used.
+ | No
|
-Explanation:
-Indicates that SSE-KMS is used.
-Example: x-obs-server-side-encryption: kms
-Restrictions:
+ | Definition:
+The server-side encryption method. Example: x-obs-server-side-encryption: kms
+Constraints:
None
-Value range:
-kms, or AES256
+Range:
+- kms: SSE-KMS is used for encryption.
- AES256: SSE-OBS and the AES256 algorithm are used.
Default value:
None
|
@@ -235,9 +234,9 @@ Date: date
No
|
-Explanation:
+ | Definition:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Constraints:
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.
@@ -249,12 +248,12 @@ Date: date
|
No. This header is required when SSE-C is used.
|
-Explanation:
+ | Definition:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm: AES256
-Restrictions:
+Example: x-obs-server-side-encryption-customer-algorithm: AES256
+Constraints:
- 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:
+Range:
AES256
Default value:
None
@@ -266,12 +265,12 @@ Date: date
|
No. This header is required when SSE-C is used.
|
-Explanation:
+ | Definition:
The key used for encrypting an object.
-Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Constraints:
- 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:
+Range:
None
Default value:
None
@@ -283,12 +282,12 @@ Date: date
|
No. This header is required when SSE-C is used.
|
-Explanation:
+ | Definition:
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==
+Constraints:
- 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:
+Range:
MD5 value of the key.
Default value:
None
@@ -300,12 +299,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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.
+Constraints:
The value must be a valid URL, for example, http://domainname or https://domainname.
-Value range:
+Range:
URL
Default value:
None
@@ -317,13 +316,13 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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:
+Constraints:
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:
+Range:
The value is an integer greater than 0.
Default value:
None
@@ -335,12 +334,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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
-Restrictions:
+Constraints:
- 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:
+Range:
None
Default value:
None
@@ -352,12 +351,12 @@ Date: date
|
No, but required when x-obs-object-lock-retain-until-date is present
|
-Explanation:
+ | Definition:
WORM mode applied to the object.
Example: x-obs-object-lock-mode:COMPLIANCE
-Restrictions:
+Constraints:
- Only COMPLIANCE (compliance mode) is supported.
- This parameter must be used together with x-obs-object-lock-retain-until-date.
-Value range:
+Range:
COMPLIANCE
Default value:
None
@@ -367,19 +366,35 @@ 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:
+ | Definition:
When the WORM policy of the object expires.
Example: x-obs-object-lock-retain-until-date:2015-07-01T04:11:15Z
-Restrictions:
+Constraints:
- 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:
+Range:
The time must be later than the current time.
Default value:
None
|
+x-obs-request-payer
+ |
+String
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
@@ -409,11 +424,11 @@ Content-Type: type
String
|
- Explanation:
+ | Definition:
Version ID of the object. If versioning is enabled for the bucket, the object version ID will be returned.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -423,13 +438,12 @@ Content-Type: type
|
String
|
- Explanation:
-The encryption method used by the server.
-Example: x-obs-server-side-encryption:kms
-Restrictions:
-This header is included in a response if SSE-KMS is used.
-Value range:
-
+ | Definition:
+The server-side encryption method. Example: x-obs-server-side-encryption:kms
+Constraints:
+None
+Range:
+- kms: SSE-KMS is used for encryption.
- AES256: SSE-OBS and the AES256 algorithm are used.
Default value:
None
|
@@ -438,24 +452,34 @@ Content-Type: type
String
|
- Explanation:
+ | Definition:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Constraints:
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-sse-kms-key-project-id
+ |
+String
+ |
+Definition:
+If SSE-KMS encryption is used with a custom master key, the ID of the project (not enterprise project) to which the custom master key belongs is returned.
+Range:
+ID of the project (not enterprise project) to which the custom master key specified by x-obs-server-side-encryption-kms-key-id belongs
+ |
+
x-obs-server-side-encryption-customer-algorithm
|
String
|
-Explanation:
+ | Definition:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm: AES256
-Restrictions:
+Example: x-obs-server-side-encryption-customer-algorithm: AES256
+Constraints:
This header is included in a response if SSE-C is used for server-side encryption.
-Value range:
+Range:
AES256
Default value:
None
@@ -465,12 +489,12 @@ Content-Type: type
|
String
|
-Explanation:
+ | Definition:
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==
+Constraints:
This header is included in a response if SSE-C is used for server-side encryption.
-Value range:
+Range:
MD5 value of the key.
Default value:
None
@@ -480,16 +504,30 @@ Content-Type: type
|
String
|
-Explanation:
+ | Definition:
Storage class of an object
-Restrictions:
+Constraints:
This header is returned when the storage class of an object is not Standard.
-Value range:
+Range:
Default value:
None
|
+x-obs-request-payer
+ |
+String
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
diff --git a/docs/obs/api-ref/obs_04_0081.html b/docs/obs/api-ref/obs_04_0081.html
index 6f533e0a7..b55f5c569 100644
--- a/docs/obs/api-ref/obs_04_0081.html
+++ b/docs/obs/api-ref/obs_04_0081.html
@@ -135,48 +135,78 @@ Upload to OBS
Request ParametersThis request contains no parameters.
Request HeadersThis request uses common headers. For details, see Table 3.
- If you want to get CORS settings, use the headers in Table 1.
+ Request HeadersThis request uses common headers. For details, see Table 3. You can also use the header in Table 1.
+ If you want to get CORS settings, use the headers in Table 2.
- Table 1 Request headers for obtaining CORS configurationHeader
+Table 1 Additional request headerHeader
|
-Type
+ | Type
|
-Mandatory (Yes/No)
+ | Mandatory (Yes/No)
|
-Description
+ | Description
|
|---|
-Origin
+ | x-obs-request-payer
|
-String
+ | string
|
-Yes
+ | No
|
-Explanation:
+ | Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Table 2 Request headers for obtaining CORS configurationHeader
+ |
+Type
+ |
+Mandatory (Yes/No)
+ |
+Description
+ |
+
|---|
+
+Origin
+ |
+String
+ |
+Yes
+ |
+Definition:
Where a cross-domain request is from (usually a domain name), specified in a preflight request
-Restrictions:
+Constraints:
None
-Value range:
+Range:
An HTTP-compliant header value
Default value:
None
|
-Access-Control-Request-Headers
+ | Access-Control-Request-Headers
|
-String
+ | String
|
-No
+ | No
|
-Explanation:
+ | Definition:
HTTP headers in a request. Multiple headers can be included.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
An HTTP-compliant header value
-Default value:
+Default value:
None
|
@@ -184,9 +214,9 @@ Upload to OBS
-Request ElementsThis request uses form elements. Table 2 describes the form elements.
+ Request ElementsThis request uses form elements. Table 3 describes the form elements.
- Table 2 Form elementsElement
+Table 3 Form elementsElement
|
Type
|
@@ -202,13 +232,13 @@ 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.
-Restrictions:
+ | Definition:
+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.
+Constraints:
- 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:
+Range:
None
-Default value:
+Default value:
None
|
|---|
@@ -218,13 +248,13 @@ Upload to OBS
Yes
|
-Explanation:
+ | Definition:
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:
+Constraints:
None
-Value range:
+Range:
1 to 1,024 characters
-Default value:
+Default value:
None
|
@@ -234,13 +264,13 @@ Upload to OBS
Yes when the restrictions are met
|
-Explanation:
+ | Definition:
Access key ID (AK) of the requester.
-Restrictions:
+Constraints:
This parameter is mandatory if there is security policy parameter policy or signature in the request.
-Value range:
+Range:
AK of a user.
-Default value:
+Default value:
None
|
@@ -250,13 +280,13 @@ Upload to OBS
Yes when the restrictions are met
|
-Explanation:
+ | Definition:
A security policy
-Restrictions:
+Constraints:
This parameter is mandatory if AccessKeyId or signature is provided in the form.
-Value range:
+Range:
For the policy format, see Authenticating the Signature Carried in a Form Uploaded Through a Browser.
-Default value:
+Default value:
None
|
@@ -266,13 +296,13 @@ Upload to OBS
Yes when the restrictions are met
|
-Explanation:
+ | Definition:
A signature string calculated based on StringToSign.
-Restrictions:
+Constraints:
This parameter is mandatory if AccessKeyId or policy is provided in the form.
-Value range:
+Range:
None
-Default value:
+Default value:
None
|
@@ -282,16 +312,16 @@ Upload to OBS
No
|
-Explanation:
+ | Definition:
Specifies the access key, signature, and security policy of the requester all together.
-Restrictions:
+Constraints:
The priority of a token is higher than that of a separately specified AK, signature, or security policy.
Example:
For HTML:
<input type="text" name="token" value="ak:signature:policy" />
-Value range:
+Range:
The value must be in the ak:signature:policy format.
-Default value:
+Default value:
None
|
@@ -301,15 +331,15 @@ Upload to OBS
No
|
-Explanation:
+ | Definition:
Used to set a pre-defined ACL when creating an object
Examples:
In POLICY: {"acl": "public-read" }
For HTML:
<input type="text" name="acl" value="public-read" />
-Restrictions:
+Constraints:
None
-Value range:
+Range:
- private
- public-read
- public-read-write
- public-read-delivered
- public-read-write-delivered
Default value:
@@ -322,17 +352,17 @@ Upload to OBS
| No
|
-Explanation:
+ | Definition:
Used to — when creating an object — grant all users in a domain the permissions to read the object and obtain the object metadata
Examples:
In POLICY: {'grant-read': 'id=domainId1' },
For HTML:
<input type="text" name="grant-read" value="id=domainId1" />
-Restrictions:
+Constraints:
Use commas (,) to separate multiple domains.
-Value range:
+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
|
@@ -342,17 +372,17 @@ Upload to OBS
No
|
-Explanation:
+ | Definition:
Used to — when creating an object — grant all users in a domain the permission to obtain the object ACL.
Examples:
In POLICY: {"grant-read-acp": "id=domainId1" },
For HTML:
<input type="text" name="grant-read-acp" value="id=domainId1" />
-Restrictions:
+Constraints:
None
-Value range:
+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
|
@@ -362,17 +392,17 @@ Upload to OBS
No
|
-Explanation:
+ | Definition:
Used to — when creating an object — grant all users in a domain the permission to write the object ACL.
Examples:
In POLICY: {"grant-write-acp": "id=domainId1" },
For HTML:
<input type="text" name="grant-write-acp" value="id=domainId1" />
-Restrictions:
+Constraints:
None
-Value range:
+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
|
@@ -382,17 +412,17 @@ Upload to OBS
No
|
-Explanation:
+ | Definition:
When creating an object, you can use this header to grant all users in an account the permissions to read the object, obtain the object metadata and ACL, and write the object ACL.
Examples:
In POLICY: {"grant-full-control": "id=domainId1" },
For HTML:
<input type="text" name="grant-full-control" value="id=domainId1" />
-Restrictions:
+Constraints:
None
-Value range:
+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
|
@@ -402,15 +432,15 @@ Upload to OBS
No
|
-Explanation:
+ | Definition:
Used to — when creating an object — specify its storage class.
Examples:
In POLICY: {"storage-class": "STANDARD" },
For HTML:
<input type="text" name="x-obs-storage-class" value="STANDARD" />
-Restrictions:
+Constraints:
The value is case-sensitive.
-Value range:
+Range:
Default value:
If you do not use this header, the object storage class is the default storage class of the bucket.
@@ -422,13 +452,13 @@ Upload to OBS
| No
|
-Explanation:
+ | Definition:
Standard HTTP header, returned in the response if a user downloads the object or makes a Head Object request.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
See the HTTP requirements for the Cache-Control header.
-Default value:
+Default value:
None
|
@@ -438,17 +468,17 @@ Upload to OBS
No
|
-Explanation:
+ | Definition:
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/"],
For HTML:
<input type="text" name="content-type" value="text/plain" />
-Restrictions:
+Constraints:
None
-Value range:
-See the HTTP requirements for the Content-Type header.
-Default value:
+Range:
+For details about the common content types, see About Object Metadata Content-Type.
+Default value:
None
|
@@ -458,13 +488,13 @@ Upload to OBS
No
|
-Explanation:
+ | Definition:
Standard HTTP header, returned in the response if a user downloads the object or makes a Head Object request.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
See the HTTP requirements for the Content-Disposition header.
-Default value:
+Default value:
None
|
@@ -474,13 +504,13 @@ Upload to OBS
No
|
-Explanation:
+ | Definition:
Standard HTTP header, returned in the response if a user downloads the object or makes a Head Object request.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
See the HTTP requirements for the Content-Encoding header.
-Default value:
+Default value:
None
|
@@ -490,13 +520,13 @@ Upload to OBS
No
|
-Explanation:
+ | Definition:
Standard HTTP header, returned in the response if a user downloads the object or makes a Head Object request.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
See the HTTP requirements for the Expires header.
-Default value:
+Default value:
None
|
@@ -506,18 +536,18 @@ Upload to OBS
No
|
-Explanation:
+ | Definition:
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"},
For HTML:
<input type="text" name="success_action_redirect" value="http://123458.com" />
-Restrictions:
+Constraints:
The value must start with http or https.
-Value range:
+Range:
URL
-Default value:
+Default value:
None
|
@@ -527,17 +557,17 @@ Upload to OBS
No
|
-Explanation:
+ | Definition:
Used when creating an object to define metadata. The defined metadata is returned in the response when you obtain the object or query its metadata.
Examples:
In POLICY: {" x-obs-meta-test ": " test metadata " },
For HTML:
<input type="text" name=" x-obs-meta-test " value=" test metadata " />
-Restrictions:
+Constraints:
None
-Value range:
+Range:
For details, see Object Metadata.
-Default value:
+Default value:
None
|
@@ -547,16 +577,16 @@ Upload to OBS
No
|
-Explanation:
+ | Definition:
The status code returned for a successful request.
Examples:
In POLICY: ["starts-with", "$success_action_status", ""],
For 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.
-Value range:
-
+Constraints:
+- 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.
+Range:
+- 200: The request is processed successfully.
- 201: The request is successful and a new resource is created.
- 204: The request is successful, but no content is returned.
Default value:
None
|
@@ -567,13 +597,13 @@ Upload to OBS
No
|
-Explanation:
-If a bucket is configured with static website hosting, requests for one object in this bucket can be redirected to another object in the same bucket or to an external URL. OBS stores the value of this header in the object metadata.
-Restrictions:
-The value must start with a slash (/), http://, or https:// and cannot exceed 2K.
-Value range:
+ | Definition:
+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.
+Constraints:
+The value must start with a slash (/), http://, or https://. The length of the value cannot exceed 2 KB.
+Range:
None
-Default value:
+Default value:
None
|
@@ -583,14 +613,13 @@ Upload to OBS
No. This header is required when SSE-KMS is used.
|
-Explanation:
-Indicates that SSE-KMS is used for server-side encryption.
-Example: x-obs-server-side-encryption:kms
-Restrictions:
+ | Definition:
+The server-side encryption method. Example: x-obs-server-side-encryption:kms
+Constraints:
None
-Value range:
-
-Default value:
+Range:
+- kms: SSE-KMS is used for encryption.
- AES256: SSE-OBS and the AES256 algorithm are used.
+Default value:
None
|
@@ -600,11 +629,11 @@ Upload to OBS
No
|
-Explanation:
+ | Definition:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Constraints:
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.
|
@@ -614,14 +643,14 @@ Upload to OBS
No. This header is required when SSE-C is used.
|
-Explanation:
+ | Definition:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm:AES256
-Restrictions:
+Example: x-obs-server-side-encryption-customer-algorithm:AES256
+Constraints:
- 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:
+Range:
AES256
-Default value:
+Default value:
None
|
@@ -631,14 +660,14 @@ Upload to OBS
No. This header is required when SSE-C is used.
|
-Explanation:
+ | Definition:
The key used for encrypting an object.
-Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Constraints:
- 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:
+Range:
None
-Default value:
+Default value:
None
|
@@ -648,14 +677,14 @@ Upload to OBS
No. This header is required when SSE-C is used.
|
-Explanation:
+ | Definition:
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==
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Constraints:
- 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:
+Range:
MD5 value of the key.
-Default value:
+Default value:
None
|
@@ -665,15 +694,15 @@ Upload to OBS
No
|
-Explanation:
+ | Definition:
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
-Restrictions:
+Example: x-obs-expires:3
+Constraints:
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:
+Range:
The value is an integer greater than 0.
-Default value:
+Default value:
None
|
@@ -683,15 +712,15 @@ Upload to OBS
No, but required when x-obs-object-lock-retain-until-date is present.
|
-Explanation:
+ | Definition:
WORM mode applied to the object.
Example: x-obs-object-lock-mode:COMPLIANCE
-Restrictions:
+Constraints:
Currently, only COMPLIANCE (compliance mode) is supported.
This parameter must be used with x-obs-object-lock-retain-until-date.
-Value range:
+Range:
COMPLIANCE
-Default value:
+Default value:
None
|
@@ -701,15 +730,15 @@ Upload to OBS
No, but required when x-obs-object-lock-mode is present.
|
-Explanation:
+ | Definition:
When the WORM policy of the object expires.
-Example: x-obs-object-lock-retain-until-date:2015-07-01T04:11:15Z
-Restrictions:
+Example: x-obs-object-lock-retain-until-date:2015-07-01T04:11:15Z
+Constraints:
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:
+Range:
The time must be later than the current time.
-Default value:
+Default value:
None
|
@@ -730,13 +759,13 @@ ETag: etag
Response HeadersThe response to the request uses common headers. For details, see Table 1.
- In addition to the common response headers, the headers listed in Table 3 may be used.
+ In addition to the common response headers, the headers listed in Table 4 may be used.
- Table 3 Additional response headersHeader
+Table 4 Additional response headersHeader
|
Type
|
-Description
+ | Description
|
|---|
@@ -744,13 +773,13 @@ ETag: etag
String
|
-Explanation:
+ | Definition:
Object version ID.
-Restrictions:
+Constraints:
- 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:
+Range:
The value is automatically generated by the server.
-Default value:
+Default value:
None
|
@@ -758,13 +787,13 @@ ETag: etag
String
|
-Explanation:
+ | Definition:
Returned if the request origin meets the CORS configured on the server.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value that complies with the CORS
-Default value:
+Default value:
None
|
@@ -772,13 +801,13 @@ ETag: etag
String
|
-Explanation:
+ | Definition:
Returned if the request headers meet the CORS configured on the server.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value that complies with the CORS
-Default value:
+Default value:
None
|
@@ -786,13 +815,13 @@ ETag: etag
Integer
|
-Explanation:
+ | Definition:
Value of MaxAgeSeconds in the CORS configuration on the server when CORS is configured for buckets.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
An integer greater than or equal to 0, in seconds
-Default value:
+Default value:
3000
|
@@ -800,11 +829,11 @@ ETag: etag
String
|
-Explanation:
+ | Definition:
If a bucket has CORS configured, and Access-Control-Request-Method in the request meets the CORS configuration on the server, the specified methods in the rule are returned.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
Default value:
None
@@ -814,13 +843,13 @@ ETag: etag
|
String
|
-Explanation:
+ | Definition:
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:
+Constraints:
Spaces, asterisks (*), ampersands (&), colons (:), less-than signs (<), and full-width characters are not allowed.
-Value range:
+Range:
None
-Default value:
+Default value:
None
|
@@ -828,41 +857,50 @@ ETag: etag
String
|
-Explanation:
-The encryption method used by the server.
-Example: x-obs-server-side-encryption:kms
-Restrictions:
-This header is included in a response if SSE-KMS is used.
-Value range:
-
-Default value:
-None
+ | Definition:
+The server-side encryption method. Example: x-obs-server-side-encryption:kms
+Constraints:
+None
+Range:
+- kms: SSE-KMS is used for encryption.
- AES256: SSE-OBS and the AES256 algorithm are used.
+Default value:
+None
|
x-obs-server-side-encryption-kms-key-id
|
String
|
-Explanation:
+ | Definition:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Constraints:
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.
|
+x-obs-sse-kms-key-project-id
+ |
+String
+ |
+Definition:
+If SSE-KMS encryption is used with a custom master key, the ID of the project (not enterprise project) to which the custom master key belongs is returned.
+Range:
+ID of the project (not enterprise project) to which the custom master key specified by x-obs-server-side-encryption-kms-key-id belongs
+ |
+
x-obs-server-side-encryption-customer-algorithm
|
String
|
-Explanation:
+ | Definition:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm:AES256
-Restrictions:
+Example: x-obs-server-side-encryption-customer-algorithm:AES256
+Constraints:
Only for SSE-C server-side encryption.
-Value range:
+Range:
AES256
-Default value:
+Default value:
None
|
@@ -870,17 +908,31 @@ ETag: etag
String
|
-Explanation:
+ | Definition:
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==
+Constraints:
Only for SSE-C server-side encryption.
-Value range:
+Range:
MD5 value of the key.
-Default value:
+Default value:
None
|
+x-obs-request-payer
+ |
+String
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
Table 1 Request headersHeader
|
-Type
+ | Type
|
-Mandatory (Yes/No)
+ | Mandatory (Yes/No)
|
Description
|
@@ -69,12 +69,12 @@ Date: date
No
|
-Explanation:
+ | Definition:
When copying an object, you can use this parameter to set a pre-defined ACL.
Example: x-obs-acl: acl
-Restrictions:
+Constraints:
Use character strings.
-Value range:
+Range:
- private
- public-read
- public-read-write
Default value:
@@ -87,11 +87,11 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
When copying 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.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -103,11 +103,11 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
When copying an object, you can use this header to grant all users in a domain the permissions to obtain the object ACL.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -119,11 +119,11 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
When copying an object, you can use this header to grant all users in a domain the permissions to write the object ACL.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -135,12 +135,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
When copying an object, you can use this header to grant the following permissions to all users in a domain:
Permissions to read objects, obtain object metadata, obtain object ACLs, and write object ACLs.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -152,12 +152,12 @@ Date: date
|
Yes
|
-Explanation:
+ | Definition:
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
-Restrictions:
+Example: x-obs-copy-source: /source_bucket/sourceObject
+Constraints:
Full-width characters and percent signs (%) must be URL-encoded.
-Value range:
+Range:
None
Default value:
None
@@ -169,12 +169,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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
-Restrictions:
+Constraints:
Values other than COPY or REPLACE result in an immediate 400-based error response. If you need to modify the metadata (the same for both the source and target objects), this parameter must be set to REPLACE. Otherwise, the request is invalid and the server returns a 400 HTTP status code error. This parameter cannot 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:
+Range:
Default value:
COPY
@@ -186,12 +186,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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
-Restrictions:
+Example: x-obs-copy-source-if-match: etag
+Constraints:
This parameter can be used with x-obs-copy-source-if-unmodified-since but cannot with other conditional copy headers.
-Value range:
+Range:
None
Default value:
None
@@ -203,12 +203,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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
-Restrictions:
+Example: x-obs-copy-source-if-none-match: etag
+Constraints:
This parameter can be used with x-obs-copy-source-if-modified-since but cannot with other conditional copy headers.
-Value range:
+Range:
None
Default value:
None
@@ -220,14 +220,14 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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
+Constraints:
+- 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:
+Range:
None
Default value:
None
@@ -239,14 +239,14 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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
+Constraints:
+- 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
-Value range:
+Range:
None
Default value:
None
@@ -258,12 +258,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
When copying an object, you can use this header to specify the storage class for the object. If you do not use this header, the object storage class is the default storage class of the destination bucket where the object is copied to.
Example: x-obs-storage-class: STANDARD
-Restrictions:
+Constraints:
The value is case-sensitive.
-Value range:
+Range:
Default value:
By default, the storage class of the bucket is inherited.
@@ -275,11 +275,11 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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.
-Restrictions:
+Constraints:
The value must start with a slash (/), http://, or https:// and cannot exceed 2K.
-Value range:
+Range:
None
Default value:
None
@@ -291,13 +291,13 @@ Date: date
|
No. This header is required when SSE-KMS is used.
|
-Explanation:
+ | Definition:
Indicates that SSE-KMS is used for server-side encryption. Objects are encrypted using SSE-KMS.
Example: x-obs-server-side-encryption: kms
-Restrictions:
+Constraints:
None
-Value range:
-
+Range:
+- kms: SSE-KMS is used for encryption.
- AES256: SSE-OBS and the AES256 algorithm are used.
Default value:
None
|
@@ -308,11 +308,11 @@ Date: date
No
|
-Explanation:
+ | Definition:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Constraints:
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.
|
|---|
@@ -322,12 +322,12 @@ Date: date
No. This header is required when SSE-C is used.
|
-Explanation:
+ | Definition:
The algorithm used to encrypt a target object.
-Example: x-obs-server-side-encryption-customer-algorithm: AES256
-Restrictions:
+Example: x-obs-server-side-encryption-customer-algorithm: AES256
+Constraints:
- 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:
+Range:
AES256
Default value:
None
@@ -339,12 +339,12 @@ Date: date
|
No. This header is required when SSE-C is used.
|
-Explanation:
+ | Definition:
The key used to encrypt a target object.
-Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Constraints:
- 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:
+Range:
None
Default value:
None
@@ -356,12 +356,12 @@ Date: date
|
No. This header is required when SSE-C is used.
|
-Explanation:
+ | Definition:
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==
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Constraints:
- 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:
+Range:
MD5 value of the key.
Default value:
None
@@ -373,12 +373,12 @@ Date: date
|
No. This header is required when SSE-C is used to copy a source object.
|
-Explanation:
+ | Definition:
Indicates the algorithm used to decrypt a source object.
Example: x-obs-copy-source-server-side-encryption-customer-algorithm: AES256
-Restrictions:
+Constraints:
- This header is used only when SSE-C is used.
- This header must be used together with x-obs-copy-source-server-side-encryption-customer-key and x-obs-copy-source-server-side-encryption-customer-key-MD5.
-Value range:
+Range:
AES256
Default value:
None
@@ -390,12 +390,12 @@ Date: date
|
No. This header is required when SSE-C is used to copy a source object.
|
-Explanation:
+ | Definition:
Indicates the key used to decrypt a source object.
-Example: x-obs-copy-source-server-side-encryption-customer-key: K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
-Restrictions:
+Example: x-obs-copy-source-server-side-encryption-customer-key: K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Constraints:
- 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:
+Range:
None
Default value:
None
@@ -407,12 +407,12 @@ Date: date
|
No. This header is required when SSE-C is used to copy a source object.
|
-Explanation:
+ | Definition:
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==
-Restrictions:
+Example: x-obs-copy-source-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Constraints:
- 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:
+Range:
MD5 value of the key.
Default value:
None
@@ -424,12 +424,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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.
+Constraints:
The value must be a valid URL, for example, http://domainname or https://domainname.
-Value range:
+Range:
URL
Default value:
None
@@ -441,13 +441,13 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
Used to specify how object tags are copied. If this header is not contained, tags are not copied from source objects to destination ones.
Example: x-obs-tagging-directive:COPY
-Restrictions:
+Constraints:
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.
+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.
Default value:
REPLACE
|
@@ -458,12 +458,12 @@ Date: date
No, but required when x-obs-object-lock-retain-until-date is present
|
-Explanation:
+ | Definition:
WORM mode applied to the object.
-Example: x-obs-object-lock-mode:COMPLIANCE
-Restrictions:
+Example: x-obs-object-lock-mode:COMPLIANCE
+Constraints:
This parameter must be used together with x-obs-object-lock-retain-until-date.
-Value range:
+Range:
COMPLIANCE
Default value:
None
@@ -473,14 +473,14 @@ 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:
+ | Definition:
When the WORM policy of the object expires.
Example: x-obs-object-lock-retain-until-date:2015-07-01T04:11:15Z
-Restrictions:
+Constraints:
- 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:
+Range:
The time must be later than the current time.
Default value:
None
@@ -492,17 +492,33 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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
-Restrictions:
+Example: x-obs-tagging:TagA=A&TagB&TagC
+Constraints:
- 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:
+Range:
None
-Default value:
+Default value:
None
|
+x-obs-request-payer
+ |
+String
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
| String
|
-Explanation:
+ | Definition:
Version ID of the source object
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -561,11 +577,11 @@ Content-Length: length
|
String
|
-Explanation:
+ | Definition:
Version ID of the target object
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -575,13 +591,13 @@ Content-Length: length
|
String
|
-Explanation:
+ | Definition:
The encryption method used by the server.
-Example: x-obs-server-side-encryption: kms
-Restrictions:
+Example: x-obs-server-side-encryption: kms
+Constraints:
This header is included in a response if SSE-KMS is used.
-Value range:
-
+Range:
+- kms: SSE-KMS is used for encryption.
- AES256: SSE-OBS and the AES256 algorithm are used.
Default value:
None
|
@@ -590,25 +606,35 @@ Content-Length: length
String
|
-Explanation:
+ | Definition:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Constraints:
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.
|
|---|
+x-obs-sse-kms-key-project-id
+ |
+String
+ |
+Definition:
+If SSE-KMS encryption is used with a custom master key, the ID of the project (not enterprise project) to which the custom master key belongs is returned.
+Range:
+ID of the project (not enterprise project) to which the custom master key specified by x-obs-server-side-encryption-kms-key-id belongs
+ |
+
x-obs-server-side-encryption-customer-algorithm
|
String
|
-Explanation:
+ | Definition:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm: AES256
-Restrictions:
+Example: x-obs-server-side-encryption-customer-algorithm: AES256
+Constraints:
This header is included in a response if SSE-C is used for server-side encryption.
-Value range:
-AES256
+Range:
+AES256: The AES256 algorithm is used.
Default value:
None
|
@@ -617,12 +643,12 @@ Content-Length: length
String
|
-Explanation:
+ | Definition:
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==
+Constraints:
This header is included in a response if SSE-C is used for server-side encryption.
-Value range:
+Range:
Base64-encoded MD5 value of the key ID.
Default value:
None
@@ -632,16 +658,30 @@ Content-Length: length
|
String
|
-Explanation:
+ | Definition:
Storage class of an object.
-Restrictions:
+Constraints:
This header is returned when the storage class of an object is not Standard.
-Value range:
-
+Range:
+- WARM: the Infrequent Access storage class
- COLD: the Archive storage class
Default value:
Storage class of an object.
|
+x-obs-request-payer
+ |
+String
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
@@ -660,11 +700,11 @@ Content-Length: length
XML
|
- Explanation:
+ | Definition:
The copy results
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -674,12 +714,12 @@ Content-Length: length
|
String
|
- Explanation:
+ | Definition:
Time (UTC) when an object was last modified
-Restrictions:
+Constraints:
The date is in the ISO8601 format.
Example: 2018-01-01T00:00:00.000Z
-Value range:
+Range:
None
Default value:
None
@@ -689,11 +729,11 @@ 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.
-Restrictions:
+ | Definition:
+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.
+Constraints:
If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.
-Value range:
+Range:
The value must contain 32 characters.
Default value:
None
diff --git a/docs/obs/api-ref/obs_04_0083.html b/docs/obs/api-ref/obs_04_0083.html
index 8f12beb6a..d98a6f46a 100644
--- a/docs/obs/api-ref/obs_04_0083.html
+++ b/docs/obs/api-ref/obs_04_0083.html
@@ -45,11 +45,11 @@ Range:bytes=byte_range
|
No
|
- Explanation:
+ | Definition:
Content-Type is rewritten in the response.
-Restrictions:
-None
-Value range:
+Constraints:
+This parameter cannot be used by anonymous users. A signature must be included in the request. Otherwise, error 400 ForbidAnonReqOverwriteRespHead will be returned.
+Range:
See the Content-Type values defined in HTTP.
Default value:
None
@@ -61,11 +61,11 @@ Range:bytes=byte_range
|
No
|
- Explanation:
+ | Definition:
Content-Language is rewritten in the response.
-Restrictions:
-None
-Value range:
+Constraints:
+This parameter cannot be used by anonymous users. A signature must be included in the request. Otherwise, error 400 ForbidAnonReqOverwriteRespHead will be returned.
+Range:
See the Content-Language values defined in HTTP.
Default value:
None
@@ -77,11 +77,11 @@ Range:bytes=byte_range
|
No
|
- Explanation:
+ | Definition:
Expires is rewritten in the response.
-Restrictions:
-None
-Value range:
+Constraints:
+This parameter cannot be used by anonymous users. A signature must be included in the request. Otherwise, error 400 ForbidAnonReqOverwriteRespHead will be returned.
+Range:
See the Expires values defined in HTTP.
Default value:
None
@@ -93,11 +93,11 @@ Range:bytes=byte_range
|
No
|
- Explanation:
+ | Definition:
Cache-Control is rewritten in the response.
-Restrictions:
-None
-Value range:
+Constraints:
+This parameter cannot be used by anonymous users. A signature must be included in the request. Otherwise, error 400 ForbidAnonReqOverwriteRespHead will be returned.
+Range:
See the Cache-control values defined in HTTP.
Default value:
None
@@ -109,14 +109,14 @@ Range:bytes=byte_range
|
No
|
- Explanation:
+ | Definition:
Content-Disposition is rewritten in the response.
Example:
response-content-disposition=attachment; filename*=utf-8''name1
In this example, the downloaded object is renamed name1. If the new name contains any full-width characters, such characters must be URL-encoded.
-Restrictions:
-None
-Value range:
+Constraints:
+This parameter cannot be used by anonymous users. A signature must be included in the request. Otherwise, error 400 ForbidAnonReqOverwriteRespHead will be returned.
+Range:
None
Default value:
None
@@ -128,13 +128,13 @@ Range:bytes=byte_range
|
No
|
- Explanation:
+ | Definition:
Content-Encoding is rewritten in the response.
-Restrictions:
-None
-Value range:
+Constraints:
+This parameter cannot be used by anonymous users. A signature must be included in the request. Otherwise, error 400 ForbidAnonReqOverwriteRespHead will be returned.
+Range:
See the Content-Encoding values defined in HTTP.
-Default value:
+Default value:
None
|
@@ -144,11 +144,11 @@ Range:bytes=byte_range
No
|
- Explanation:
+ | Definition:
Indicates the version ID of the object to be obtained.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value must contain 32 characters.
Default value:
None. If this parameter is not configured, the latest version of the object is obtained.
@@ -160,16 +160,16 @@ Range:bytes=byte_range
|
No
|
- Explanation:
+ | Definition:
Content-Disposition is rewritten in the response.
Example:
attname=name1
This example renames the downloaded object as name1.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
-Default value:
+Default value:
None
|
@@ -195,17 +195,21 @@ 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.
-Restrictions:
-
-Value range:
-Range value starts from 0, and the maximum value equals the object length minus 1.
-Default value:
+ | Definition:
+Obtains the object content within the scope defined by Range.
+Constraints:
+- Range can be set to any of the following formats:
bytes=Start value-End value: The range starts from the start value and ends at the end value.
+bytes=Start value-: The range starts from the start value and ends at (object length – 1).
+bytes=-End value: The range starts from (object length – end value) and ends at (object length – 1).
+If Range is not set in any of these formats, the Range field is ignored and the entire object is returned.
+Example 1: bytes=0-4 (Downloads data from the first byte to the fifth byte.)
+Example 2: bytes=4- (Downloads data from the fifth byte to the end.)
+Example 3: bytes=-4 (Downloads data of the last four bytes.)
+Example 4: bytes=10-20,30-40 (indicating multiple ranges)
+ - After the Range header field is carried, the value of ETag in the response message is the ETag of the object instead of the ETag of the object in the Range field.
+Range:
+- The start value ranges from 0 to the object length minus 1. If the start value is less than 0, the Range field is ignored and the entire object is returned. If the start value is greater than the object length minus 1, an error is reported, with 416 (InvalidRange) returned.
- The end value must be greater than the start value. Otherwise, the Range field is ignored and the entire object is returned. If the end value is greater than the object length minus 1, the system automatically corrects the end value to the object length minus 1.
+Default value:
None
|
@@ -215,16 +219,16 @@ 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.
-Restrictions:
+ | Definition:
+Returns the object only if it has been modified since the time specified by this header. Otherwise, 304 Not Modified is returned.
+Constraints:
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:
+Range:
HTTP time string complying with the format specified at http://www.ietf.org/rfc/rfc2616.txt.
- 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
|
@@ -234,16 +238,16 @@ Range:bytes=byte_range
No
|
- Explanation:
+ | Definition:
If the object has not been modified since the time specified by this header, it is returned. Otherwise, 412 (precondition failed) is returned.
-Restrictions:
+Constraints:
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:
+Range:
HTTP time string complying with the format specified at http://www.ietf.org/rfc/rfc2616.txt.
- 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
|
@@ -253,14 +257,14 @@ 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.
+ | Definition:
+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:
+Constraints:
None
-Value range:
+Range:
Object ETag
-Default value:
+Default value:
None
|
@@ -270,14 +274,14 @@ 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.
+ | Definition:
+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:
+Constraints:
None
-Value range:
+Range:
Object ETag
-Default value:
+Default value:
None
|
@@ -287,14 +291,14 @@ Range:bytes=byte_range
No. This header is required when SSE-C is used.
|
- Explanation:
+ | Definition:
Indicates the encryption algorithm used when SSE-C is used.
-Example: x-obs-server-side-encryption-customer-algorithm:AES256
-Restrictions:
+Example: x-obs-server-side-encryption-customer-algorithm:AES256
+Constraints:
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:
+Range:
AES256
-Default value:
+Default value:
None
|
@@ -304,14 +308,14 @@ Range:bytes=byte_range
No. This header is required when SSE-C is used.
|
- Explanation:
+ | Definition:
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=
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Constraints:
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:
+Range:
None
-Default value:
+Default value:
None
|
@@ -321,17 +325,33 @@ Range:bytes=byte_range
No. This header is required when SSE-C is used.
|
- Explanation:
+ | Definition:
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==
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Constraints:
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:
+Range:
Base64-encoded MD5 value of the key ID.
-Default value:
+Default value:
None
|
+ x-obs-request-payer
+ |
+String
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
| String
|
-Explanation:
+ | Definition:
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.
-Value range:
+Constraints:
+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.
+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
|
|---|
@@ -386,16 +406,16 @@ Last-Modified: time
String
|
-Explanation:
+ | Definition:
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
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:
+Constraints:
- 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,9 +423,9 @@ Last-Modified: time
Boolean
|
-Explanation:
+ | Definition:
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:
+Range:
- true: The deleted object is a delete marker.
- false: The deleted object is not a delete marker.
Default value:
false
@@ -415,13 +435,13 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
Object version ID.
-Restrictions:
+Constraints:
If the object has no version number specified, the response does not contain this header.
-Value range:
+Range:
The value must contain 32 characters.
-Default value:
+Default value:
None
|
@@ -429,26 +449,25 @@ Last-Modified: time
String
|
-Explanation:
-The encryption method used by the server.
-Example: x-obs-server-side-encryption:kms
-Restrictions:
-This header is included in a response if SSE-KMS is used.
-Value range:
-
-Default value:
-None
+ | Definition:
+The server-side encryption method. Example: x-obs-server-side-encryption:kms
+Constraints:
+None
+Range:
+- kms: SSE-KMS is used for encryption.
- AES256: SSE-OBS and the AES256 algorithm are used.
+Default value:
+None
|
x-obs-server-side-encryption-kms-key-id
|
String
|
-Explanation:
+ | Definition:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Constraints:
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 +475,14 @@ Last-Modified: time
String
|
-Explanation:
+ | Definition:
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:
+Constraints:
None
-Value range:
+Range:
AES256
-Default value:
+Default value:
None
|
@@ -471,12 +490,12 @@ Last-Modified: time
String
|
-Explanation:
+ | Definition:
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==
-Value range:
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Range:
Base64-encoded MD5 value of the key ID.
-Default value:
+Default value:
None
|
@@ -484,13 +503,13 @@ Last-Modified: time
String
|
-Explanation:
+ | Definition:
Object type
-Restrictions:
+Constraints:
This header is returned when the object is not a Normal object.
-Value range:
-Appendable
-Default value:
+Range:
+- Appendable: objects generated by appending
+Default value:
None
|
@@ -498,11 +517,11 @@ Last-Modified: time
Integer
|
-Explanation:
+ | Definition:
Indicates the position that should be provided in the next request.
-Restrictions:
+Constraints:
This header field is returned when the object is an appendable object.
-Value range:
+Range:
None
Default value:
None
@@ -512,17 +531,31 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
Number of tags associated with an object.
Example: x-obs-tagging-count:1
-Restrictions:
+Constraints:
This parameter is returned only when the user has the permission to read tags.
-Value range:
+Range:
None
Default value:
None
|
+x-obs-request-payer
+ |
+String
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
diff --git a/docs/obs/api-ref/obs_04_0084.html b/docs/obs/api-ref/obs_04_0084.html
index 3a2e140b1..aba2f2c3a 100644
--- a/docs/obs/api-ref/obs_04_0084.html
+++ b/docs/obs/api-ref/obs_04_0084.html
@@ -34,11 +34,11 @@ Authorization: authorization
No
|
- Explanation:
+ | Definition:
Version ID of the object.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value must contain 32 characters.
Default value:
None
@@ -67,11 +67,11 @@ Authorization: authorization
|
No
|
- Explanation:
+ | Definition:
Origin specified in a preflight request that makes a cross-domain request, usually as a domain name.
-Restrictions:
+Constraints:
You can enter multiple origins, with one separated from another using a line break. Each origin can contain at most one wildcard character (*).
-Value range:
+Range:
The value that complies with the CORS
Default value:
None
@@ -83,11 +83,11 @@ Authorization: authorization
|
No
|
- Explanation:
+ | Definition:
Indicates the HTTP headers that are allowed in a request. The request can use multiple HTTP headers.
-Restrictions:
+Constraints:
You can enter multiple allowed headers, with one separated from another using a line break. Each header can contain at most one wildcard character (*). Spaces, ampersands (&), colons (:), less-than signs (<), and full-width characters are not allowed.
-Value range:
+Range:
The value that complies with the CORS
Default value:
None
@@ -99,12 +99,12 @@ Authorization: authorization
|
No. This header is required when SSE-C is used.
|
- Explanation:
+ | Definition:
Indicates the decryption algorithm used when SSE-C is used.
-Example: x-obs-server-side-encryption-customer-algorithm:AES256
-Restrictions:
+Example: x-obs-server-side-encryption-customer-algorithm:AES256
+Constraints:
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:
+Range:
AES256
Default value:
None
@@ -116,12 +116,12 @@ Authorization: authorization
|
No. This header is required when SSE-C is used.
|
- Explanation:
+ | Definition:
Indicates the decryption key used when SSE-C is used.
-Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Constraints:
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:
+Range:
None
Default value:
None
@@ -133,17 +133,33 @@ Authorization: authorization
|
No. This header is required when SSE-C is used.
|
- Explanation:
+ | Definition:
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==
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Constraints:
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:
+Range:
Base64-encoded MD5 value of the key ID.
Default value:
None
|
+ x-obs-request-payer
+ |
+String
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
| String
|
-Explanation:
+ | Definition:
Expiration details
-Restrictions:
+Constraints:
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.
+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.
Default value:
None
|
@@ -193,14 +209,14 @@ Last-Modified: time
String
|
-Explanation:
+ | Definition:
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
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:
+Constraints:
- 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
@@ -210,11 +226,11 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
Version ID of the object. If the object has no version number specified, the response does not contain this header.
-Restrictions:
+Constraints:
The value must contain 32 characters.
-Value range:
+Range:
None
Default value:
None
@@ -224,11 +240,11 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
Returned if the request origin meets the CORS configured on the server.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value that complies with the CORS
Default value:
None
@@ -238,11 +254,11 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
Returned if the request headers meet the CORS configured on the server.
-Restrictions:
+Constraints:
At most one asterisk (*) is allowed. Spaces, ampersands (&), colons (:), less-than signs (<), and full-width characters are not allowed.
-Value range:
+Range:
The value that complies with the CORS
Default value:
None
@@ -252,11 +268,11 @@ Last-Modified: time
|
Integer
|
-Explanation:
+ | Definition:
MaxAgeSeconds in the CORS rules of the bucket. It specifies the time your client can cache the response for a cross-origin request.
-Restrictions:
+Constraints:
Each CORS rule can contain at most one MaxAgeSeconds.
-Value range:
+Range:
An integer greater than or equal to 0, in seconds
Default value:
3000
@@ -266,9 +282,9 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
Indicates that methods in the rule are included in the response if Access-Control-Request-Method in the request meets the CORS configuration requirements when CORS is configured for buckets.
-Value range:
+Range:
|
|---|
@@ -276,11 +292,11 @@ Last-Modified: time
String
|
-Explanation:
+ | Definition:
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:
+Constraints:
Spaces, asterisks (*), ampersands (&), colons (:), less-than signs (<), and full-width characters are not allowed.
-Value range:
+Range:
None
Default value:
None
@@ -290,13 +306,13 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
The encryption method used by the server.
-Example: x-obs-server-side-encryption:kms
-Restrictions:
+Example: x-obs-server-side-encryption:kms
+Constraints:
This header is included in a response if SSE-KMS is used.
-Value range:
-
+Range:
+- kms: SSE-KMS is used for encryption.
- AES256: SSE-OBS and the AES256 algorithm are used.
Default value:
None
|
@@ -305,11 +321,11 @@ Last-Modified: time
String
|
-Explanation:
+ | Definition:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Constraints:
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.
|
@@ -317,13 +333,13 @@ Last-Modified: time
String
|
-Explanation:
+ | Definition:
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:
+Example: x-obs-server-side-encryption-customer-algorithm:AES256
+Constraints:
None
-Value range:
-AES256
+Range:
+AES256: The AES256 algorithm is used.
Default value:
None
|
@@ -332,12 +348,12 @@ Last-Modified: time
String
|
-Explanation:
+ | Definition:
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==
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Constraints:
Base64-encoded MD5 value of the key, for example, 4XvB3tbNTN+tIEVa0/fGaQ==.
-Value range:
+Range:
Base64-encoded MD5 value of the key ID.
Default value:
None
@@ -347,12 +363,12 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
Storage class of an object.
-Restrictions:
+Constraints:
This header is returned only when the storage class of an object is not Standard.
-Value range:
-
+Range:
+- WARM: the Infrequent Access storage class
- COLD: the Archive storage class
Default value:
None
|
@@ -361,12 +377,12 @@ Last-Modified: time
String
|
-Explanation:
+ | Definition:
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 Cold objects are being restored or has been restored.
-Value range:
+Constraints:
+- This header is returned only when Cold objects are being restored or has been restored.
+Range:
None
Default value:
None
@@ -376,12 +392,12 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
Object type
-Restrictions:
+Constraints:
This header is returned only when the object is not a Normal object.
-Value range:
-Appendable
+Range:
+- Appendable: objects generated by appending
Default value:
None
|
@@ -390,11 +406,11 @@ Last-Modified: time
Integer
|
-Explanation:
+ | Definition:
Indicates the position that should be provided in the next request.
-Restrictions:
+Constraints:
This header is returned only when the object is an Appendable object.
-Value range:
+Range:
None
Default value:
None
@@ -404,11 +420,11 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
Indicates the ID of a multipart task.
-Restrictions:
+Constraints:
This header is returned only when the object is created from a multipart upload.
-Value range:
+Range:
None
Default value:
None
@@ -418,12 +434,12 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
Number of tags associated with an object.
-Example: x-obs-tagging-count:1
-Restrictions:
+Example: x-obs-tagging-count:1
+Constraints:
This header is returned only when you have the permission to read tags.
-Value range:
+Range:
None
Default value:
None
@@ -433,12 +449,12 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
WORM mode applied to the object.
-Example: x-obs-object-lock-mode:COMPLIANCE
-Restrictions:
+Example: x-obs-object-lock-mode:COMPLIANCE
+Constraints:
- 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:
+Range:
Currently, only COMPLIANCE (compliance mode) is supported.
Default value:
None
@@ -448,17 +464,45 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
When an object lock expires.
-Example: x-obs-object-lock-retain-until-date:2015-07-01T04:11:15Z
-Restrictions:
+Example: x-obs-object-lock-retain-until-date:2015-07-01T04:11:15Z
+Constraints:
- 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:
+Range:
The value must be later than the current time.
Default value:
None
|
+x-obs-replication-status
+ |
+String
+ |
+Definition:
+Replication status of the object.
+Constraints:
+Only the latest replication status is recorded. The historical replication status of an object cannot be viewed.
+Value range:
+- FAILED: Status of the source object. It indicates that the replication task fails.
- COMPLETED: Status of the source object. It indicates that the replication task is successful.
- REPLICA: Status of the target object. It indicates that the object is a replica.
+Default value:
+None
+ |
+
+x-obs-request-payer
+ |
+String
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
diff --git a/docs/obs/api-ref/obs_04_0085.html b/docs/obs/api-ref/obs_04_0085.html
index ec24e3b51..ae4dba02b 100644
--- a/docs/obs/api-ref/obs_04_0085.html
+++ b/docs/obs/api-ref/obs_04_0085.html
@@ -33,12 +33,12 @@ Authorization: authorization
|
|---|
versionId
|
-Explanation:
+ | Definition:
Version ID of the object to be deleted.
Type: string
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value must contain 32 characters.
Default value:
None
@@ -51,6 +51,37 @@ Authorization: authorization
Request HeadersThis request uses common headers. For details, see Table 3.
+ In addition to the common request headers, the header listed in Table 2 may be used.
+
+ Table 2 Additional request headerHeader
+ |
+Type
+ |
+Mandatory (Yes/No)
+ |
+Description
+ |
+
|---|
+
+x-obs-request-payer
+ |
+String
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Request ElementsThis request involves no elements.
Response HeadersThe response to the request uses common headers. For details, see Table 1.
- If versioning is enabled for the bucket, the headers listed in Table 2 may also be used.
+ If versioning is enabled for the bucket, the headers listed in Table 3 may also be used.
- Table 2 Additional response headersHeader
+Table 3 Additional response headersHeader
|
Description
|
@@ -71,12 +102,12 @@ Date: date
|---|
x-obs-delete-marker
|
-Explanation:
+ | Definition:
Whether an object has a delete marker. If the object is not marked as deleted, the response does not contain this header.
Type: boolean
-Restrictions:
+Constraints:
None
-Value range:
+Range:
Default value:
false
@@ -84,17 +115,29 @@ Date: date
|
x-obs-version-id
|
-Explanation:
+ | Definition:
Object version ID. If the object has no version number specified, the response does not contain this header.
Type: string
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value must contain 32 characters.
Default value:
None
|
+x-obs-request-payer
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
Request ParametersThis request involves no parameters.
Request HeadersThis request uses common headers. For details, see Table 3.
- Request ElementsThis request uses elements to specify the list of objects to be deleted in a batch. Table 1 describes the elements.
+ In addition to the common request headers, the header listed in Table 1 may be used.
- Table 1 Request elementsElement
+Table 1 Additional request headerHeader
+ |
+Type
+ |
+Mandatory (Yes/No)
+ |
+Description
+ |
+
|---|
+
+x-obs-request-payer
+ |
+String
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Request ElementsThis request uses elements to specify the list of objects to be deleted in a batch. Table 2 describes the elements.
+
+ Table 2 Request elementsElement
|
Description
|
-Mandatory
+ | Mandatory (Yes/No)
|
|---|
@@ -138,10 +169,37 @@ Content-Length: length
Response HeadersThe response to the request uses common headers. For details, see Table 1.
- Response ElementsThis response uses elements to return results of deleted objects in a batch. Table 2 describes the elements.
+ In addition to the common response headers, the header listed in Table 3 may be used.
- Table 2 Response elementsElement
+Table 3 Additional response headerHeader
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+x-obs-request-payer
+ |
+string
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Response ElementsThis response uses elements to return results of deleted objects in a batch. Table 4 describes the elements.
+
+ Table 4 Response elementsElement
|
Description
|
diff --git a/docs/obs/api-ref/obs_04_0087.html b/docs/obs/api-ref/obs_04_0087.html
index 2e0c9c2d7..2e3a3a0a6 100644
--- a/docs/obs/api-ref/obs_04_0087.html
+++ b/docs/obs/api-ref/obs_04_0087.html
@@ -35,11 +35,11 @@ Content-MD5: MD5
No
|
-Explanation:
+ | Definition:
Version ID of the Cold object to be restored
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None. If this parameter is not configured, the latest version of the object is specified.
@@ -68,11 +68,11 @@ Content-MD5: MD5
|
Yes
|
-Explanation:
+ | Definition:
Container for the restore information
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -84,12 +84,12 @@ Content-MD5: MD5
|
Yes
|
-Explanation:
+ | Definition:
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:
+Constraints:
The retention period starts from the first 01:00 CET (02:00 CEST) after the object retrieval is initiated.
For example, if the retention period is one day and the retrieval is initiated any time between 01:00 CET on the 27th day and 01:00 CET on the 28th day, the expiration is always at 01:00 CET on the 29th day.
-Value range:
+Range:
The value ranges from 1 to 30, in days.
Default value:
None
@@ -101,11 +101,11 @@ Content-MD5: MD5
|
No
|
-Explanation:
+ | Definition:
Container for the restore options
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -117,9 +117,9 @@ Content-MD5: MD5
|
No
|
-Explanation:
+ | Definition:
Retrieval speed tier. You can select a tier that suits your retrieval needs.
-Value range:
+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.
Default value:
Standard
@@ -150,7 +150,7 @@ Date: date
|
|---|
RestoreAlreadyInProgress
|
-Explanation:
+ | Definition:
The object is being restored. The request conflicts with another.
ErrorMessage: Object restore is already in progress
|
@@ -159,7 +159,7 @@ Date: date
ObjectHasAlreadyRestored
|
-Explanation:
+ | Definition:
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
|
@@ -168,8 +168,8 @@ Date: date
MalformedXML
|
-Explanation:
-Invalid value for the Days field (supposed to be an integer)
+ | Definition:
+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
@@ -177,8 +177,8 @@ Date: date
|
InvalidArgument
|
-Explanation:
-Invalid value for the Days field (valid range: 1 to 30).
+ | Definition:
+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
@@ -186,8 +186,8 @@ Date: date
|
MalformedXML
|
-Explanation:
-Invalid value for the Tier field.
+ | Definition:
+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
@@ -195,7 +195,7 @@ Date: date
|
InvalidObjectState
|
-Explanation:
+ | Definition:
The restored object is not in the Cold storage.
ErrorMessage: Restore is not allowed, as object's storage class is not COLD
|
diff --git a/docs/obs/api-ref/obs_04_0089.html b/docs/obs/api-ref/obs_04_0089.html
index 1a45b942c..436153c4a 100644
--- a/docs/obs/api-ref/obs_04_0089.html
+++ b/docs/obs/api-ref/obs_04_0089.html
@@ -53,7 +53,7 @@ Authorization: authorization
Description
|
-Mandatory
+ | Mandatory (Yes/No)
|
|---|
@@ -70,20 +70,67 @@ Authorization: authorization
Request HeadersThis request uses common headers. For details, see Table 3.
- Request ElementsThe request message carries the ACL information of the object by using message elements. For the meanings of the elements, see Table 2.
+ In addition to the common request headers, the header listed in Table 2 may be used.
- Table 2 Request elementsElement
+Table 2 Additional request headerHeader
|
-Description
+ | Type
|
-Mandatory
+ | Mandatory (Yes/No)
+ |
+Description
|
|---|
-Owner
+ | x-obs-request-payer
|
-Bucket owner information, including the ID
+ | String
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Request ElementsThe request message carries the ACL information of the object by using message elements. For the meanings of the elements, see Table 3.
+
+ Table 3 Request elementsElement
+ |
+Description
+ |
+Mandatory (Yes/No)
+ |
+
|---|
+
+AccessControlPolicy
+ |
+Access control policy. AccessControlPolicy is a parent node of Owner, Delivered, and AccessControlList.
+Type: XML
+ |
+Yes
+ |
+
+AccessControlList
+ |
+Access control list. AccessControlList is the parent node of Grant.
+Type: XML
+ |
+Yes
+ |
+
+Owner
+ |
+Owner information of a bucket. Owner is a parent node of ID.
Type: XML
|
Yes
@@ -99,7 +146,7 @@ Authorization: authorization
|
Grant
|
-Container for the grantee and the granted permissions. A single object ACL can contain no more than 100 grants.
+ | Identifies the grantee and the permissions of the grantee. An ACL of an object can contain a maximum of 100 grants. Grant is the parent node of Grantee and Permission.
Type: XML
|
No
@@ -107,7 +154,7 @@ Authorization: authorization
|
Grantee
|
-Container for the details about the grantee.
+ | Used to record user information. Grantee is a parent node of ID.
Type: XML
|
No
@@ -116,7 +163,7 @@ Authorization: authorization
| Canned
|
Grants permissions to all users.
-Value range: Everyone
+Range: Everyone
Type: string
|
No
@@ -140,14 +187,6 @@ Authorization: authorization
| No
|
-AccessControlList
- |
-Indicates an ACL, which consists of three elements: Grant, Grantee, and Permission.
-Type: XML
- |
-Yes
- |
-
@@ -161,18 +200,38 @@ Content-Type: application/xml
Response HeadersThe response to the request uses common headers. For details, see Table 1.
- In addition to the common response headers, the headers listed in Table 3 may be used.
+ In addition to the common response headers, the headers listed in Table 4 may be used.
- Table 3 Additional response headersHeader
+Table 4 Additional response headersParameter
|
-Description
+ | Type
+ |
+Description
|
|---|
-x-obs-version-id
+ | x-obs-version-id
|
-Version number of the object whose ACL is to be modified.
-Type: string
+ | String
+ |
+Definition:
+Version ID of the object whose ACL is modified.
+Range:
+The value must contain 32 characters.
+ |
+
+x-obs-request-payer
+ |
+string
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
|
diff --git a/docs/obs/api-ref/obs_04_0090.html b/docs/obs/api-ref/obs_04_0090.html
index fccde1659..8a49d2f3b 100644
--- a/docs/obs/api-ref/obs_04_0090.html
+++ b/docs/obs/api-ref/obs_04_0090.html
@@ -15,13 +15,13 @@ Authorization: authorization
Request ParametersThe request parameter specifies the object ACL to be obtained. For details about the parameters, see Table 1.
+ Request ParametersThe request parameters required are described in Table 1.
Table 1 Request parametersParameter
|
Description
|
-Mandatory
+ | Mandatory (Yes/No)
|
|---|
@@ -38,6 +38,37 @@ Authorization: authorization
Request HeadersThis request uses common headers. For details, see Table 3.
+ In addition to the common request headers, the header listed in Table 2 may be used.
+
+ Table 2 Additional request headerHeader
+ |
+Type
+ |
+Mandatory (Yes/No)
+ |
+Description
+ |
+
|---|
+
+x-obs-request-payer
+ |
+String
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Request ElementsThis request involves no elements.
Response HeadersThe response to the request uses common headers. For details, see Table 1.
- In addition to the common response headers, the headers listed in Table 2 may be used.
+ In addition to the common response headers, the headers listed in Table 3 may be used.
- Table 2 Additional response headerHeader
+Table 3 Additional response headersParameter
|
-Description
+ | Type
+ |
+Description
|
|---|
-x-obs-version-id
+ | x-obs-version-id
|
-Version number of an object.
-Valid value: string
-Default value: none
+ | String
+ |
+Definition:
+Version number of an object.
+Range:
+The value must contain 32 characters.
+ |
+
+x-obs-request-payer
+ |
+string
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
|
Response ElementsThe response message of the request returns the ACL information of the object. Table 3 describes the elements.
+ Response ElementsThe response message of the request returns the ACL information of the object. Table 4 describes the elements.
- Table 3 Response elementsElement
+Table 4 Response elementsElement
|
Description
|
diff --git a/docs/obs/api-ref/obs_04_0091.html b/docs/obs/api-ref/obs_04_0091.html
index a35e9880a..20593c23f 100644
--- a/docs/obs/api-ref/obs_04_0091.html
+++ b/docs/obs/api-ref/obs_04_0091.html
@@ -38,11 +38,11 @@ Date: date
No
|
-Explanation:
+ | Definition:
Version ID of the object.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value must contain 32 characters.
Default value:
None
@@ -71,11 +71,11 @@ Date: date
|
Yes
|
-Explanation:
+ | Definition:
Metadata operation directive.
-Restrictions:
+Constraints:
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:
+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:
None
@@ -87,11 +87,11 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
It specifies the cache behavior of the web page when an object is downloaded.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
See the Cache-Control values defined in HTTP.
Default value:
None
@@ -103,11 +103,11 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
It specifies the name of an object when it is downloaded.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
See the Content-Disposition values defined in HTTP.
Default value:
None
@@ -119,11 +119,11 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
It specifies the content encoding format when an object is downloaded.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
See the Content-Encoding values defined in HTTP.
Default value:
None
@@ -135,11 +135,11 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
It specifies the content language format when an object is downloaded.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
See the Content-Language values defined in HTTP.
Default value:
None
@@ -151,14 +151,14 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
It specifies the file type of an object when it is downloaded.
-Restrictions:
-None
-Value range:
-See the Content-Type values defined in HTTP.
-Default value:
-None
+Constraints:
+None
+Range:
+For details about the common content types, see About Object Metadata Content-Type.
+Default value:
+None
|
|---|
Expires
@@ -167,13 +167,13 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
It specifies the expiration time of a cached web page when an object is downloaded.
CAUTION: This parameter is not used to set the object expiration time.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
See the Expires values defined in HTTP.
Default value:
None
@@ -185,15 +185,15 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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/
-Restrictions:
+Constraints:
The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
-Value range:
+Range:
None
Default value:
None
@@ -205,12 +205,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
Specifies the storage class of an object.
-Example: x-obs-storage-class: STANDARD
-Restrictions:
+Example: x-obs-storage-class: STANDARD
+Constraints:
The value is case-sensitive.
-Value range:
+Range:
Default value:
@@ -223,12 +223,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
Custom metadata of the object. You can add a header starting with x-obs-meta- in the request to define metadata. 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:
+Constraints:
- The total size of all custom metadata cannot exceed 8K. To measure the size, calculate the sum of bytes of all UTF-8 encoded keys and values.
- The custom metadata keys are case-insensitive, but are stored in lowercase by OBS. The key values are case-sensitive.
- Both custom metadata keys and their values must conform to US-ASCII standards. If non-ASCII or unrecognizable characters are required, they must be encoded and decoded in URL or Base64 on the client, because the server does not perform such operations.
-Value range:
+Range:
None
Default value:
None
@@ -240,12 +240,12 @@ Date: date
|
No
|
-Explanation:
+ | Definition:
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
-Restrictions:
+Example: x-obs-tagging:TagA=A&TagB&TagC
+Constraints:
- 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:
+Range:
None
Default value:
None
@@ -282,11 +282,11 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
Metadata operation directive.
-Value range:
+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
|
@@ -294,11 +294,11 @@ Last-Modified: time
String
|
-Explanation:
+ | Definition:
It specifies the cache behavior of the web page when an object is downloaded.
-Restrictions:
+Constraints:
If a request carries this header field, the response message must contain this header field.
-Value range:
+Range:
See the Cache-control values defined in HTTP.
Default value:
None
@@ -308,11 +308,11 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
It specifies the name of an object when it is downloaded.
-Restrictions:
+Constraints:
If a request carries this header field, the response message must contain this header field.
-Value range:
+Range:
See the Content-Disposition values defined in HTTP.
Default value:
None
@@ -322,11 +322,11 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
It specifies the content encoding format when an object is downloaded.
-Restrictions:
+Constraints:
If a request carries this header field, the response message must contain this header field.
-Value range:
+Range:
See the Content-Encoding values defined in HTTP.
Default value:
None
@@ -336,11 +336,11 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
It specifies the content language format when an object is downloaded.
-Restrictions:
+Constraints:
If a request carries this header field, the response message must contain this header field.
-Value range:
+Range:
See the Content-Language values defined in HTTP.
Default value:
None
@@ -350,11 +350,11 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
It specifies the expiration time of a cached web page when an object is downloaded.
-Restrictions:
+Constraints:
If a request carries this header field, the response message must contain this header field.
-Value range:
+Range:
See the Expires values defined in HTTP.
Default value:
None
@@ -364,15 +364,15 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
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/
-Restrictions:
+Constraints:
- If a request carries this header field, the response message must contain this header field.
- The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
-Value range:
+Range:
None
Default value:
None
@@ -382,11 +382,11 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
It specifies the storage class of an object.
-Restrictions:
+Constraints:
- If a request carries this header field, the response message must contain this header field.
- The value is case-sensitive.
-Value range:
+Range:
Default value:
@@ -397,11 +397,11 @@ Last-Modified: time
|
String
|
-Explanation:
+ | Definition:
Custom metadata of the object. You can add custom metadata headers that start with x-obs-meta- for easy object management. When you retrieve or query the metadata of the object, the added custom metadata headers will be returned in the response.
-Restrictions:
+Constraints:
- If a request carries this header field, the response message must contain this header field.
- The total size of all custom metadata cannot exceed 8K. To measure the size, calculate the sum of bytes of all UTF-8 encoded keys and values.
- The custom metadata keys are case-insensitive, but are stored in lowercase by OBS. The key values are case-sensitive.
- Both custom metadata keys and their values must conform to US-ASCII standards. If non-ASCII or unrecognizable characters are required, they must be encoded and decoded in URL or Base64 on the client, because the server does not perform such operations.
-Value range:
+Range:
None
Default value:
None
diff --git a/docs/obs/api-ref/obs_04_0098.html b/docs/obs/api-ref/obs_04_0098.html
index 21e1e8b96..cca23abf5 100644
--- a/docs/obs/api-ref/obs_04_0098.html
+++ b/docs/obs/api-ref/obs_04_0098.html
@@ -35,11 +35,11 @@ Authorization: authorization
|
Yes
|
-Explanation:
+ | Definition:
Indicates a multipart upload.
-Restrictions:
+Constraints:
- This parameter is an empty string.
- If this parameter is not included, the request is treated as an ordinary POST upload.
-Value range:
+Range:
An empty string.
Default value:
None
@@ -67,12 +67,12 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
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
+Constraints:
Use character strings.
-Value range:
+Range:
- private
- public-read
- public-read-write
Default value:
@@ -85,12 +85,12 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
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.
-Restrictions:
+Example: x-obs-grant-read: ID=domainID.
+Constraints:
Use commas (,) to separate multiple domains.
-Value range:
+Range:
None
Default value:
None
@@ -102,14 +102,14 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
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.
-Restrictions:
+Example: x-obs-grant-read-acp: ID=domainID.
+Constraints:
Use commas (,) to separate multiple domains.
-Value range:
+Range:
None
-Default value:
+Default value:
None
|
@@ -119,14 +119,14 @@ Authorization: authorization
No
|
-Explanation:
+ | Definition:
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:
+Constraints:
Use commas (,) to separate multiple domains.
-Value range:
+Range:
None
-Default value:
+Default value:
None
|
@@ -136,15 +136,15 @@ Authorization: authorization
No
|
-Explanation:
+ | Definition:
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.
-Restrictions:
+Example: x-obs-grant-full-control: ID=domainID.
+Constraints:
Use commas (,) to separate multiple domains.
-Value range:
+Range:
None
-Default value:
+Default value:
None
|
@@ -154,12 +154,12 @@ Authorization: authorization
No
|
-Explanation:
+ | Definition:
When initiating a multipart upload, you can add this header to specify the storage class for the object.
Example: x-obs-storage-class: STANDARD
-Restrictions:
+Constraints:
- If you do not use this header, the object storage class is the default storage class of the bucket.
- The value is case-sensitive.
-Value range:
+Range:
Default value:
@@ -172,14 +172,14 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
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:
+Constraints:
- 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
@@ -191,13 +191,13 @@ Authorization: authorization
|
No. This header is required when SSE-KMS is used.
|
-Explanation:
+ | Definition:
Indicates that SSE-KMS is used.
Example: x-obs-server-side-encryption: kms
-Restrictions:
+Constraints:
None
-Value range:
-
+Range:
+- kms: SSE-KMS is used for encryption.
- AES256: SSE-OBS and the AES256 algorithm are used.
Default value:
None
|
@@ -208,11 +208,11 @@ Authorization: authorization
No
|
-Explanation:
+ | Definition:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Constraints:
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.
|
@@ -222,12 +222,12 @@ Authorization: authorization
No. This header is required when SSE-C is used.
|
-Explanation:
+ | Definition:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm: AES256
-Restrictions:
+Example: x-obs-server-side-encryption-customer-algorithm: AES256
+Constraints:
- 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:
+Range:
AES256
Default value:
None
@@ -239,12 +239,12 @@ Authorization: authorization
|
No. This header is required when SSE-C is used.
|
-Explanation:
+ | Definition:
The key used for encrypting an object.
-Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Constraints:
- 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:
+Range:
None
Default value:
None
@@ -256,12 +256,12 @@ Authorization: authorization
|
No. This header is required when SSE-C is used.
|
-Explanation:
+ | Definition:
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==
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Constraints:
- 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:
+Range:
Base64-encoded MD5 value of the key ID.
Default value:
None
@@ -273,12 +273,12 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
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:
+Constraints:
This parameter can be configured only when uploading the object. It cannot be modified by calling a metadata modification API.
-Value range:
+Range:
An integer greater than or equal to 0, in days
Default value:
None
@@ -290,12 +290,12 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
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
-Restrictions:
+Example: x-obs-tagging:TagA=A&TagB&TagC
+Constraints:
- 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:
+Range:
None
Default value:
None
@@ -305,14 +305,14 @@ 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:
+ | Definition:
WORM mode to be applied to an object.
Example: x-obs-object-lock-mode:COMPLIANCE
-Restrictions:
+Constraints:
This parameter must be used together with x-obs-object-lock-retain-until-date.
-Value range:
+Range:
Only COMPLIANCE (compliance mode) is supported.
Default value:
None
@@ -322,14 +322,14 @@ 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:
+ | Definition:
When the WORM policy of the object expires.
Example: x-obs-object-lock-retain-until-date:2015-07-01T04:11:15Z
-Restrictions:
+Constraints:
- 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:
+Range:
The time must be later than the current time.
Default value:
None
@@ -341,17 +341,33 @@ Authorization: authorization
|
No
|
-Explanation:
+ | Definition:
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:
+Constraints:
This parameter can only be passed in HTTP request headers and cannot exceed 8 KB.
-Value range:
+Range:
None
-Default value:
+Default value:
None
|
+x-obs-request-payer
+ |
+String
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
| String
|
-Explanation:
+ | Definition:
The encryption method used by the server.
-Example: x-obs-server-side-encryption: kms
-Restrictions:
+Example: x-obs-server-side-encryption: kms
+Constraints:
This header is included in a response if SSE-KMS is used.
-Value range:
-
+Range:
+- kms: SSE-KMS is used for encryption.
- AES256: SSE-OBS and the AES256 algorithm are used.
Default value:
None
|
@@ -412,24 +428,34 @@ Connection: status
String
|
-Explanation:
+ | Definition:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Constraints:
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.
|
|---|
+x-obs-sse-kms-key-project-id
+ |
+String
+ |
+Definition:
+If SSE-KMS encryption is used with a custom master key, the ID of the project (not enterprise project) to which the custom master key belongs is returned.
+Range:
+ID of the project (not enterprise project) to which the custom master key specified by x-obs-server-side-encryption-kms-key-id belongs
+ |
+
x-obs-server-side-encryption-customer-algorithm
|
String
|
-Explanation:
+ | Definition:
The algorithm used for encryption.
Example: x-obs-server-side-encryption-customer-algorithm: AES256
-Restrictions:
+Constraints:
This header is included in a response if SSE-C is used for server-side encryption.
-Value range:
+Range:
AES256
Default value:
None
@@ -439,17 +465,31 @@ Connection: status
|
String
|
-Explanation:
+ | Definition:
The MD5 value of the encryption 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==
+Constraints:
This header is included in a response if SSE-C is used for server-side encryption.
-Value range:
+Range:
Base64-encoded MD5 value of the key ID.
Default value:
None
|
+x-obs-request-payer
+ |
+string
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
@@ -468,13 +508,13 @@ Connection: status
XML
|
- Explanation:
+ | Definition:
Container of a multipart upload task.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
-Default value:
+Default value:
None
|
|
|---|
@@ -482,12 +522,12 @@ Connection: status
String
|
-Explanation:
+ | Definition:
Indicates the bucket name in the multipart upload.
-Restrictions:
+Constraints:
- 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:
+Range:
None
Default value:
None
@@ -497,11 +537,11 @@ Connection: status
|
String
|
-Explanation:
+ | Definition:
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:
+Constraints:
None
-Value range:
+Range:
The value must contain 1 to 1,024 characters.
Default value:
None
@@ -511,11 +551,11 @@ Connection: status
|
String
|
-Explanation:
+ | Definition:
ID of the multipart upload, which is used to specify a multipart upload in uploading parts
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value must contain 1 to 32 characters.
Default value:
None
diff --git a/docs/obs/api-ref/obs_04_0099.html b/docs/obs/api-ref/obs_04_0099.html
index 96e1ca5c5..b93fc9c18 100644
--- a/docs/obs/api-ref/obs_04_0099.html
+++ b/docs/obs/api-ref/obs_04_0099.html
@@ -33,11 +33,11 @@ Content-MD5:md5
|
Yes
|
-Explanation:
+ | Definition:
Indicates the ID of a part to be uploaded.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
An integer ranging from 1 to 10000.
Default value:
None
@@ -49,11 +49,11 @@ Content-MD5:md5
|
Yes
|
-Explanation:
+ | Definition:
Indicates a multipart upload ID.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
Default value:
None
@@ -65,7 +65,7 @@ Content-MD5:md5
Request HeadersThis request uses common headers. For details, see Table 3.
- Table 2 Server-side encryption request headersHeader
+Table 2 Request headersHeader
|
Type
|
@@ -81,12 +81,12 @@ Content-MD5:md5
No. This header is required when SSE-C is used. The encryption algorithm must be the same as that used to initiate multipart upload tasks.
|
-Explanation:
+ | Definition:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm:AES256
-Restrictions:
+Example: x-obs-server-side-encryption-customer-algorithm:AES256
+Constraints:
- 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:
+Range:
AES256
Default value:
None
@@ -98,12 +98,12 @@ Content-MD5:md5
|
No. This header is required when SSE-C is used. The key must be the same as that used to initiate multipart upload tasks.
|
-Explanation:
+ | Definition:
The key used for encrypting an object.
-Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw=
+Constraints:
- 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:
+Range:
None
Default value:
None
@@ -115,18 +115,34 @@ Content-MD5:md5
|
No. This header is required when SSE-C is used. The MD5 value must be the same as that used to initiate multipart upload tasks.
|
-Explanation:
+ | Definition:
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==
-Restrictions:
+Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
+Constraints:
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.
-Value range:
+Range:
Base64-encoded MD5 value of the key ID.
Default value:
None
|
|---|
+x-obs-request-payer
+ |
+String
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
| String
|
-Explanation:
+ | Definition:
The encryption method used by the server.
-Example: x-obs-server-side-encryption:kms
-Restrictions:
+Example: x-obs-server-side-encryption:kms
+Constraints:
This header is included in a response if SSE-KMS is used.
-Value range:
-
+Range:
+- kms: SSE-KMS is used for encryption.
- AES256: SSE-OBS and the AES256 algorithm are used.
Default value:
None
|
@@ -172,24 +188,34 @@ Content-Length: length
String
|
-Explanation:
+ | Definition:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Constraints:
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.
|
|---|
+x-obs-sse-kms-key-project-id
+ |
+String
+ |
+Definition:
+If SSE-KMS encryption is used with a custom master key, the ID of the project (not enterprise project) to which the custom master key belongs is returned.
+Range:
+ID of the project (not enterprise project) to which the custom master key specified by x-obs-server-side-encryption-kms-key-id belongs
+ |
+
x-obs-server-side-encryption-customer-algorithm
|
String
|
-Explanation:
+ | Definition:
The algorithm used for encryption.
Example: x-obs-server-side-encryption-customer-algorithm:AES256
-Restrictions:
+Constraints:
This header is included in a response if SSE-C is used for server-side encryption.
-Value range:
+Range:
AES256
Default value:
None
@@ -199,17 +225,31 @@ Content-Length: length
|
String
|
-Explanation:
+ | Definition:
The MD5 value of the encryption 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==
+Constraints:
This header is included in a response if SSE-C is used for server-side encryption.
-Value range:
+Range:
Base64-encoded MD5 value of the key ID.
Default value:
None
|
+x-obs-request-payer
+ |
+string
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
diff --git a/docs/obs/api-ref/obs_04_0100.html b/docs/obs/api-ref/obs_04_0100.html
index 64e54f7e9..1f7e85907 100644
--- a/docs/obs/api-ref/obs_04_0100.html
+++ b/docs/obs/api-ref/obs_04_0100.html
@@ -49,7 +49,7 @@ Content-Length: length
|
Request HeadersIn addition to 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 headers.
Table 2 Request headersHeader
|
@@ -181,6 +181,20 @@ Content-Length: length
No
|
|---|
+x-obs-request-payer
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+No
+ |
+
@@ -213,9 +227,9 @@ Date: date
x-obs-server-side-encryption-kms-key-id
|
-Explanation:
-ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+ | Definition:
+If the SSE-KMS encryption is used with a specified key, the key ID is required.
+Constraints:
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.
@@ -235,6 +249,18 @@ Date: date
Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
|
+ x-obs-request-payer
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
diff --git a/docs/obs/api-ref/obs_04_0101.html b/docs/obs/api-ref/obs_04_0101.html
index 31edb31aa..5b4236841 100644
--- a/docs/obs/api-ref/obs_04_0101.html
+++ b/docs/obs/api-ref/obs_04_0101.html
@@ -51,6 +51,37 @@ Authorization: auth
Request HeadersThis request uses common headers. For details, see Table 3.
+ In addition to the common request headers, the header listed in Table 2 may be used.
+
+ Table 2 Additional request headerHeader
+ |
+Type
+ |
+Mandatory (Yes/No)
+ |
+Description
+ |
+
|---|
+
+x-obs-request-payer
+ |
+String
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Request ElementsThis request involves no elements.
Response HeadersThe response to the request uses common headers. For details, see Table 1.
- Response ElementsThis response uses elements to return information about uploaded parts. Table 2 describes the elements.
+ In addition to the common response headers, the header listed in Table 3 may be used.
- Table 2 Response elementsElement
+Table 3 Additional response headerHeader
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+x-obs-request-payer
+ |
+string
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Response ElementsThis response uses elements to return information about uploaded parts. Table 4 describes the elements.
+
+ Table 4 Response elementsElement
|
Description
|
diff --git a/docs/obs/api-ref/obs_04_0102.html b/docs/obs/api-ref/obs_04_0102.html
index c93f1dd10..695f680b4 100644
--- a/docs/obs/api-ref/obs_04_0102.html
+++ b/docs/obs/api-ref/obs_04_0102.html
@@ -72,9 +72,9 @@ Authorization: authorization
Yes
|
-Explanation:
+ | Definition:
Multipart upload ID.
-Value range:
+Range:
The value must contain 32 characters.
Default value:
None
@@ -85,10 +85,41 @@ Authorization: authorization
Request HeadersThis request uses common headers. For details, see Table 3.
- Request ElementsThis request uses elements to specify the list of parts to be assembled. Table 2 describes the elements.
+ In addition to the common request headers, the header listed in Table 2 may be used.
- Table 2 Request elementsElement
+Table 2 Additional request headerHeader
+ |
+Type
+ |
+Mandatory (Yes/No)
+ |
+Description
+ |
+
|---|
+
+x-obs-request-payer
+ |
+String
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Request ElementsThis request uses elements to specify the list of parts to be assembled. Table 3 describes the elements.
+
+ Table 3 Request elementsElement
|
Type
|
@@ -104,13 +135,13 @@ Authorization: authorization
Yes
|
-Explanation:
+ | Definition:
List of parts to be assembled
-Restrictions:
+Constraints:
None
-Value range:
+Range:
None
-Default value:
+Default value:
None
|
|---|
@@ -120,11 +151,11 @@ Authorization: authorization
Yes
|
-Explanation:
+ | Definition:
Part number
-Restrictions:
+Constraints:
None
-Value range:
+Range:
[1,10000]
Default value:
None
@@ -136,11 +167,11 @@ Authorization: authorization
|
Yes
|
-Explanation:
+ | Definition:
ETag value returned upon successful upload of a part. It is the unique identifier of the part content. This parameter is used to verify data consistency when parts are merged.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value must contain 32 characters.
Default value:
None
@@ -171,9 +202,9 @@ Date: date
Response HeadersThe response to the request uses common headers. For details, see Table 1.
- In addition to the common response headers, the message headers listed in Table 3 may be used.
+ In addition to the common response headers, the headers listed in Table 4 may be used.
- Table 3 Additional response headersHeader
+Table 4 Additional response headersHeader
|
Type
|
@@ -185,11 +216,11 @@ Date: date
String
|
-Explanation:
+ | Definition:
Version of the object after parts are assembled.
-Restrictions:
+Constraints:
None
-Value range:
+Range:
The value must contain 32 characters.
Default value:
None
@@ -199,13 +230,13 @@ Date: date
|
String
|
-Explanation:
+ | Definition:
The encryption method used by the server.
-Example: x-obs-server-side-encryption:kms
-Restrictions:
+Example: x-obs-server-side-encryption:kms
+Constraints:
This header is included in a response if SSE-KMS is used.
-Value range:
-
+Range:
+- kms: SSE-KMS is used for encryption.
- AES256: SSE-OBS and the AES256 algorithm are used.
Default value:
None
|
@@ -214,36 +245,60 @@ Date: date
String
|
-Explanation:
+ | Definition:
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.
+Constraints:
+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-sse-kms-key-project-id
+ |
+String
+ |
+Definition:
+If SSE-KMS encryption is used with a custom master key, the ID of the project (not enterprise project) to which the custom master key belongs is returned.
+Range:
+ID of the project (not enterprise project) to which the custom master key specified by x-obs-server-side-encryption-kms-key-id belongs
|
x-obs-server-side-encryption-customer-algorithm
|
String
|
-Explanation:
+ | Definition:
The algorithm used for encryption.
-Example: x-obs-server-side-encryption-customer-algorithm:AES256
-Restrictions:
+Example: x-obs-server-side-encryption-customer-algorithm:AES256
+Constraints:
This header is included in a response if SSE-C is used for server-side encryption.
-Value range:
+Range:
AES256
Default value:
None
|
+x-obs-request-payer
+ |
+String
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
Response ElementsThis response uses elements to return the result of assembling parts. Table 4 describes the elements.
+ Response ElementsThis response uses elements to return the result of assembling parts. Table 5 describes the elements.
- Table 4 Response elementsElement
+Table 5 Response elementsElement
|
Type
|
@@ -255,11 +310,11 @@ Date: date
String
|
-Explanation:
+ | Definition:
Path of the object after parts are assembled.
-Restrictions:
+Constraints:
Format: http://bucketName.obs.region.example.com/objectName
-Value range:
+Range:
None
Default value:
None
@@ -269,12 +324,12 @@ Date: date
|
String
|
-Explanation:
+ | Definition:
Bucket where parts are assembled
-Restrictions:
+Constraints:
- 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:
+Range:
None
Default value:
None
@@ -284,12 +339,12 @@ Date: date
|
String
|
-Explanation:
+ | Definition:
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:
+Constraints:
None
-Value range:
+Range:
The value must contain 1 to 1,024 characters.
Default value:
None
@@ -299,11 +354,11 @@ Date: date
|
String
|
-Explanation:
+ | Definition:
The ETag that uniquely identifies the object after its parts were assembled, calculated based on the ETag of each part.
-Restrictions:
+Constraints:
If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object.
-Value range:
+Range:
The value must contain 32 characters.
Default value:
None
diff --git a/docs/obs/api-ref/obs_04_0103.html b/docs/obs/api-ref/obs_04_0103.html
index 9611df2e8..555556045 100644
--- a/docs/obs/api-ref/obs_04_0103.html
+++ b/docs/obs/api-ref/obs_04_0103.html
@@ -13,7 +13,7 @@ Authorization: auth
|
|---|
Request ParametersThis request uses message parameters to specify the multipart upload task number of the segment task. Table 1 describes the parameters.
+ Request ParametersThis request uses message parameters to specify the multipart upload task number. Table 1 describes the parameters.
Table 1 Request parametersParameter
|
@@ -36,6 +36,37 @@ Authorization: auth
Request HeadersThis request uses common headers. For details, see Table 3.
+ In addition to the common request headers, the header listed in Table 2 may be used.
+
+ Table 2 Additional request headerHeader
+ |
+Type
+ |
+Mandatory (Yes/No)
+ |
+Description
+ |
+
|---|
+
+x-obs-request-payer
+ |
+String
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Request ElementsThis request involves no elements.
Response HeadersThe response to the request uses common headers. For details, see Table 1.
+ In addition to the common response headers, the header listed in Table 3 may be used.
+
+ Table 3 Additional response headerHeader
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+x-obs-request-payer
+ |
+string
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Response ElementsThis response contains no elements.
+SSE-OBS
+
SSE-C
API Operations Related to Server-Side Encryption
diff --git a/docs/obs/api-ref/obs_04_0106.html b/docs/obs/api-ref/obs_04_0106.html
index e58e8995c..9350a2f42 100644
--- a/docs/obs/api-ref/obs_04_0106.html
+++ b/docs/obs/api-ref/obs_04_0106.html
@@ -22,26 +22,26 @@
String
|
-Explanation:
-Indicates that SSE-KMS is used for server-side encryption.
-Example: x-obs-server-side-encryption:kms
-Restrictions:
-None
-Value range:
-
-Default value:
-kms
+ | Definition:
+Encryption mode.
+Example: x-obs-server-side-encryption:AES256
+Constraints:
+None
+Range:
+- kms: SSE-KMS is used.
- AES256: SSE-OBS is used and the AES256 algorithm is used.
+Default value:
+None
|
|---|
x-obs-server-side-encryption-kms-key-id
|
String
|
-Explanation:
+ | Definition:
ID of a specified key used for SSE-KMS encryption.
-Restrictions:
+Constraints:
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.
|
diff --git a/docs/obs/api-ref/obs_04_0107.html b/docs/obs/api-ref/obs_04_0107.html
index 7aebf7b5f..417f7bb5b 100644
--- a/docs/obs/api-ref/obs_04_0107.html
+++ b/docs/obs/api-ref/obs_04_0107.html
@@ -16,7 +16,7 @@
x-obs-server-side-encryption-customer-algorithm
|
Indicates the encryption algorithm for the object when SSE-C is used.
-Example: x-obs-server-side-encryption-customer-algorithm: AES256
+Example: x-obs-server-side-encryption-customer-algorithm: AES256
|
x-obs-server-side-encryption-customer-key
@@ -27,7 +27,7 @@
|
x-obs-server-side-encryption-customer-key-MD5
|
-Indicates the MD5 value of the key for encrypting objects when SSE-C is used. Its value is a Base64-encoded MD5 hash. The MD5 value is used to check whether any error occurs during the transmission of the key.
+ | Indicates the MD5 value of the key for encrypting objects when SSE-C is used. Its value is a Base64-encoded MD5 hash. The MD5 value is used to ensure data integrity during key transmission.
Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ==
|
@@ -59,7 +59,7 @@
x-obs-copy-source-server-side-encryption-customer-key-MD5
|
-Indicates the MD5 value of the key for decrypting the source object when SSE-C is used. The MD5 value is used to check whether any error occurs during the transmission of the key.
+ | Indicates the MD5 value of the key for decrypting the source object when SSE-C is used. The MD5 value is used to ensure data integrity during key transmission.
Example: x-obs-copy-source-server-side-encryption-customer-key:4XvB3tbNTN+tIEVa0/fGaQ==
|
diff --git a/docs/obs/api-ref/obs_04_0112.html b/docs/obs/api-ref/obs_04_0112.html
index a737c5a50..a17963181 100644
--- a/docs/obs/api-ref/obs_04_0112.html
+++ b/docs/obs/api-ref/obs_04_0112.html
@@ -12,13 +12,16 @@
-Uploading objects with PUT or POST, appending content to objects, initiating a multipart upload, and uploading, copying, and assembling parts
+ | Uploading objects using PUT or POST, appending objects, initiating multipart uploads, uploading parts, copying parts, assembling parts, modifying objects, truncating objects, renaming objects
|
Uploading an Object - PUT
Uploading an Object - POST
Initiating a Multipart Upload
Uploading Parts
Completing a Multipart Upload
+Modifying an Object
+Truncating an Object
+Renaming an Object
|
obs:object:PutObject
|
@@ -156,13 +159,14 @@
Supported
|
-Obtaining the object-level WORM retention configuration
+ | Obtaining the object-level WORM retention configuration
|
-Querying Object Metadata
+ | Querying Object Metadata
|
-obs:object:GetObject
+ | obs:object:GetObject
+obs:object:GetObjectRetention
|
-Supported
+ | Supported
|
Adding object tags
diff --git a/docs/obs/api-ref/obs_04_0115.html b/docs/obs/api-ref/obs_04_0115.html
index 9d8f3765e..ebc2d01a0 100644
--- a/docs/obs/api-ref/obs_04_0115.html
+++ b/docs/obs/api-ref/obs_04_0115.html
@@ -525,6 +525,15 @@ QUFBQUFBYmJiYmJiYmJD</HostId> Use an object bucket.
|
+400 Bad Request
+ |
+ForbidAnonReqOverwriteRespHead
+ |
+Anonymous users cannot overwrite response headers when calling the object download API.
+ |
+Delete the parameters for overwriting response headers, or include a signature to call the object download API.
+ |
+
403 Forbidden
|
AccessDenied
@@ -756,7 +765,7 @@ QUFBQUFBYmJiYmJiYmJD</HostId>
| FsNotSupport
|
-POSIX buckets do not support this API.
+ | The parallel file system does not support this API.
|
The method is not allowed.
|
diff --git a/docs/obs/api-ref/obs_04_0116.html b/docs/obs/api-ref/obs_04_0116.html
index da8f3ece3..925452776 100644
--- a/docs/obs/api-ref/obs_04_0116.html
+++ b/docs/obs/api-ref/obs_04_0116.html
@@ -2,7 +2,7 @@
Obtaining Access Keys (AK/SK)
When you call APIs, you need to use the AK and SK for authentication. To obtain the AK and SK, perform the following steps:
- - Log in to the console.
- Click the login username in the upper right corner and choose My Credentials from the drop-down list.
- Choose Access Keys.
- Click Create Access Key.
- Enter an access key description (optional) and click OK.
- Enter the verification code sent to your mobile phone, virtual MFA device, or email, and click OK.
This step is required only when you have enabled operation protection.
+ - Log in to the console.
- Click the login username in the upper right corner and choose My Credentials from the drop-down list.
- Choose Access Keys.
- Click Create Access Key.
- Enter an access key description (optional) and click OK.
- Enter the verification code sent to your mobile phone, virtual MFA device, or email, and click OK.
This step is required only when you have enabled operation protection.
- Click Download to obtain the access key file.
Keep AKs and SKs properly to prevent information leakage.
diff --git a/docs/obs/api-ref/obs_04_0160.html b/docs/obs/api-ref/obs_04_0160.html
index 46732b639..d7f25507a 100644
--- a/docs/obs/api-ref/obs_04_0160.html
+++ b/docs/obs/api-ref/obs_04_0160.html
@@ -89,6 +89,37 @@ Authorization: authorization
Request HeadersThis request uses common request headers. For details, see Table 3.
+ In addition to the common request headers, the header listed in Table 2 may be used.
+
+ Table 2 Additional request headerHeader
+ |
+Type
+ |
+Mandatory (Yes/No)
+ |
+Description
+ |
+
|---|
+
+x-obs-request-payer
+ |
+String
+ |
+No
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Request ElementsThis request contains no elements.
Response HeadersThe response to the request uses common headers. For details, see Table 1.
- Response ElementsThis response lists objects in XML format. Specific elements are described in Table 2.
+ In addition to the common response headers, the header listed in Table 3 may be used.
- Table 2 Response elementsElement
+Table 3 Additional response headerHeader
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+x-obs-request-payer
+ |
+string
+ |
+Definition:
+Indicates that the requester agrees to pay for the request and traffic.
+Constraints:
+If this header is not included in the request when the requester tries to access a requester-pays bucket, the authentication fails and error "403 Forbidden" is returned.
+Range:
+requester
+Default value:
+None
+ |
+
+
+
+ Response ElementsThis response lists objects in XML format. Specific elements are described in Table 4.
+
+ Table 4 Response elementsElement
|
Description
|
diff --git a/docs/obs/api-ref/obs_04_0164.html b/docs/obs/api-ref/obs_04_0164.html
index 1aad156fd..afbe1a054 100644
--- a/docs/obs/api-ref/obs_04_0164.html
+++ b/docs/obs/api-ref/obs_04_0164.html
@@ -153,7 +153,7 @@ Content-Length: 441
<TagSet>
<Tag>
<Key>TagName1</Key>
- <Value>TageSetVaule1</Value>
+ <Value>TagSetValue1</Value>
</Tag>
</TagSet>
</Tagging>
diff --git a/docs/obs/api-ref/obs_04_0166.html b/docs/obs/api-ref/obs_04_0166.html
index ab80fc539..ef5a038a7 100644
--- a/docs/obs/api-ref/obs_04_0166.html
+++ b/docs/obs/api-ref/obs_04_0166.html
@@ -2,7 +2,7 @@
Configuring WORM Retention for an Object
FunctionsThis operation configures or updates the retention period for objects uploaded to a bucket with WORM enabled.
- - When you upload an object, if you do not configure a protection period or apply the default bucket-level protection rule to the object, you can perform this operation to configure a protection period for the object.
- When you upload an object, if you configure a protection period or apply the default bucket-level protection rule to the object, you can perform this operation to prolong the protection period for the object.
- The protection period of an object can only be modified, but not deleted.
To configure or update the protection period of an object, you must have the PutObjectRetention permission.
+ - If you do not configure a retention period or apply the default bucket-level protection rule to the object when you upload an object, you can perform this operation to configure a retention period for the object.
- If you already configure a retention period or apply the default bucket-level protection rule to the object when you upload an object, you can perform this operation to prolong the retention period for the object.
- The retention period of an object can only be modified, but not deleted.
To configure or update the retention period of an object, you must have the PutObjectRetention permission.
@@ -20,13 +20,13 @@ Authorization: authorization
<RetainUntilDate>Timestamp</RetainUntilDate>
</Retention>
-Request ParametersTable 1 describes the parameters.
+ Request ParametersTable 1 describes the request parameters.
Table 1 Request parametersParameter
|
Description
|
-Mandatory
+ | Mandatory (Yes/No)
|
|---|
@@ -57,7 +57,7 @@ Authorization: authorization
Description
|
-Mandatory
+ | Mandatory (Yes/No)
|
@@ -81,12 +81,12 @@ Authorization: authorization
RetainUntilDate
|
Protection period for the object. The value can be a timestamp or in the ISO format.
-A timestamp must be accurate to milliseconds. For example, the timestamp for 13:20:35 on July 1, 2015 should be 1435728035000.
+A timestamp must be accurate to milliseconds. For example, the timestamp for 13:20:35 on July 1, 2015 should be 1435728035000.
A time zone is required in the ISO time format. For example, the ISO UTC time for 13:20:35 on July 1, 2015 should be 2015-07-01T13:20:35Z.
NOTE: The value of this field must be later than the current time and can be extended but not shortened.
Type: string
-Example: 1435728035000 (a timestamp) or 2015-07-01T13:20:35Z (in the ISO format)
+Example: 1435728035000 (a timestamp) or 2015-07-01T13:20:35Z (in the ISO format)
Remarks: timestamp value is accurate to milliseconds in Unix time.
|
Yes
@@ -106,7 +106,7 @@ Content-Length: length
Error ResponsesTable 2 describes possible special errors in this request.
- Table 2 Error Code
+Table 2 Error ResponsesError Code
|
Description
|
@@ -130,7 +130,7 @@ Content-Length: length
|---|
MalformedObjectLockError
|
-Invalid format of the Object Lock configuration.
+ | Invalid policy configuration format.
The XML you provided was not well-formed or did not validate against our published schema.
|
400
@@ -148,7 +148,7 @@ Content-Length: length
For other errors, see Table 2.
-Sample Request 1Configure the WORM protection (with the protection period specified as a timestamp) for an object.
+ Sample Request 1Configure WORM (with the retention period specified as a timestamp) for an object.
PUT /objectname?retention HTTP/1.1
Host: bucketname.obs.region.example.com
Date: WED, 01 Jul 2015 02:25:05 GMT
@@ -167,7 +167,7 @@ x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCT9W2tcvLmMJ+plfdopaD62S0npbaRUz
Date: WED, 01 Jul 2015 02:25:06 GMT
Content-Length: 0
- Sample Request 2Configure the WORM protection (with the protection period specified in the ISO format) for an object.
+ Sample Request 2Configure WORM (with the retention period specified in the ISO format) for an object.
PUT /objectname?retention HTTP/1.1
Host: bucketname.obs.region.example.com
WED, 01 Jul 2015 02:25:06 GMT
diff --git a/docs/obs/api-ref/obs_04_0167.html b/docs/obs/api-ref/obs_04_0167.html
index 5a678bc65..dfe4c4855 100644
--- a/docs/obs/api-ref/obs_04_0167.html
+++ b/docs/obs/api-ref/obs_04_0167.html
@@ -3,7 +3,7 @@
Configuring a Default WORM Policy for a Bucket
FunctionsThis API configures a default WORM policy and retention period for a bucket.
With the bucket's default WORM policy, if you do not specify a WORM policy or a retention period when you upload an object to the bucket, the default policy will be automatically applied to the newly uploaded object. An object-level WORM policy requires configuring a specific date, which indicates an object will be protected until that date. For a default bucket-level WORM policy, a retention period is required, and the protection for an object starts when the object is uploaded to the bucket.
- To perform this operation, you must have the PutBucketObjectLockConfiguration permission. The bucket owner can perform this operation by default and can grant this permission to others by using a bucket policy or a user policy.
+ To perform this operation, you must have the PutBucketObjectLockConfiguration 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.
- You can modify or even delete the default WORM policy of a bucket. The change applies only to the objects uploaded after the change, but not to those uploaded before.
- During a multipart upload, the object parts uploaded are not protected before they are assembled. After object parts are assembled, the new object is protected by the default bucket-level WORM policy. You can also configure an object-level WORM policy for the new object.
- You can also configure an object-level WORM policy when initializing a multipart upload or for an already assembled multipart object.
Other restrictions on the WORM retention configuration:
@@ -35,7 +35,7 @@ Content-Length: length
Description
|
- Mandatory
+ | Mandatory (Yes/No)
|
|
@@ -69,7 +69,7 @@ Content-Length: length
Container for the default WORM retention policy for the bucket.
Type: container
|
-Mandatory if the Rule container is included.
+ | Yes if Rule is specified
|
Mode
@@ -78,7 +78,7 @@ Content-Length: length
Type: string
Example: COMPLIANCE
|
-Mandatory if the DefaultRetention container is included.
+ | Yes if DefaultRetention is specified
|
Days
@@ -113,7 +113,7 @@ Content-Length: length
Error ResponsesTable 2 describes possible special errors in this request.
- Table 2 Error Code
+Table 2 Error ResponsesError Code
|
Description
|
@@ -130,7 +130,7 @@ Content-Length: length
|---|
MalformedXML
|
-Invalid format of the Object Lock configuration.
+ | Invalid policy configuration format.
The XML you provided was not well-formed or did not validate against our published schema.
|
400
diff --git a/docs/obs/api-ref/obs_04_0168.html b/docs/obs/api-ref/obs_04_0168.html
index a7e61b2d8..11943a362 100644
--- a/docs/obs/api-ref/obs_04_0168.html
+++ b/docs/obs/api-ref/obs_04_0168.html
@@ -2,7 +2,7 @@
Obtaining the Default WORM Policy of a Bucket
FunctionsThis operation returns the default WORM policy of a bucket.
- To perform this operation, you must have the GetBucketObjectLockConfiguration permission. The bucket owner can perform this operation by default and can grant this permission to others by using a bucket policy or a user policy.
+ To perform this operation, you must have the GetBucketObjectLockConfiguration 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.
If you have never configured the default bucket-level retention policy after you enable WORM for a bucket, you can still use this API to check whether WORM is enabled.
@@ -98,7 +98,7 @@ Content-Length: length
Error ResponsesTable 2 describes possible special errors in this request.
- Table 2 Error Code
+Table 2 Error ResponsesError Code
|
Description
|
diff --git a/docs/obs/api-ref/obs_04_0172.html b/docs/obs/api-ref/obs_04_0172.html
index da321b981..4ddacfc46 100644
--- a/docs/obs/api-ref/obs_04_0172.html
+++ b/docs/obs/api-ref/obs_04_0172.html
@@ -4,8 +4,8 @@
FunctionsThis operation adds or updates the tag information for an object. An object tag is a key-value pair.
If you do not specify a version ID in a request, make sure that you have the PutObjectTagging permission. If you do specify a version ID in a request, make sure that you have the PutObjectTagging and PutObjectVersionTagging permissions. By default, only the object owner can perform this operation. The object owner can grant this permission to others by using a bucket or user policy.
Tags are added to the current version of an object by default. You can use the versionId parameter to add tags to any other version. If the version you are adding tags to is a delete marker, OBS returns 404 Not Found.
- - Tags cannot be set for files in parallel file systems.
- An object can have up to 10 tags.
- Constraints on the tag key and value:
A tag key is case sensitive and must be unique. It cannot be left blank or exceed 128 characters. The following characters are not allowed: =*<>\,|/?!;
-A tag value is case sensitive and can be left blank. It cannot exceed 255 characters. The following characters are not allowed: =*<>\,|?!;
+ - Tags cannot be set for files in parallel file systems.
- An object can have up to 10 tags.
- Tag key constraints:
- If there are multiple tags specified for an object, each tag key must be unique.
- A tag key must contain 1 to 36 characters and be case sensitive.
- A tag key cannot start or end with a space or contain the following characters: ,/|<>=*\
+ - Tag value constraints:
- A tag value can contain 0 to 43 characters and must be case sensitive.
- A tag value cannot contain the following characters: ,/|<>=*\
@@ -119,6 +119,8 @@ Content-MD5: md5
Tag name
Type: string
Parent: Tag
+Tag key constraints:
+- If there are multiple tags specified for an object, each tag key must be unique.
- A tag key must contain 1 to 36 characters and be case sensitive.
- A tag key cannot start or end with a space or contain the following characters: ,/|<>=*\
|
Yes
|
@@ -128,6 +130,8 @@ Content-MD5: md5
Tag value
Type: string
Parent: Tag
+Tag value constraints:
+- A tag value can contain 0 to 43 characters and must be case sensitive.
- A tag value cannot contain the following characters: ,/|<>=*\
|
Yes
|
@@ -235,7 +239,7 @@ Content-Length: 182
<TagSet>
<Tag>
<Key>TagName1 </Key>
- <Value>TageSetVaule1 </Value>
+ <Value>TagSetValue1 </Value>
</Tag>
</TagSet>
</Tagging>
diff --git a/docs/obs/api-ref/obs_04_0173.html b/docs/obs/api-ref/obs_04_0173.html
new file mode 100644
index 000000000..39743ed01
--- /dev/null
+++ b/docs/obs/api-ref/obs_04_0173.html
@@ -0,0 +1,106 @@
+
+
+ SSE-OBS
+ FunctionsWith SSE-OBS, OBS uses the keys provided by itself for server-side encryption. Unlike SSE-KMS where KMS manages keys, in SSE-OBS, OBS manages keys.
+
+ Newly Added HeadersUse the headers listed in Table 1 to implement SSE-OBS.
+ You can also configure the default encryption for a bucket to encrypt objects you upload to the bucket. After the default encryption is configured for a bucket, if upload requests for that bucket do not contain encryption headers, the default encryption applies to the uploaded objects. For more information about configuring bucket encryption, see Configuring Bucket Encryption.
+
+ Table 1 Header used in SSE-OBSHeader
+ |
+Description
+ |
+
|---|
+
+x-obs-server-side-encryption
+ |
+Indicates that SSE-OBS is used for encrypting objects.
+Type: string
+Example: x-obs-server-side-encryption:AES256
+ |
+
+
+
+
+
+ APIs Where SSE-OBS Headers ApplyYou can configure headers about SSE-OBS in the APIs below:
+
+
+ You can configure a bucket policy to restrict the request headers for a specified bucket. For example, if you require that object upload requests do not contain header x-obs-server-side-encryption:"AES256", you can use the following bucket policy:
+ {
+ "Statement": [
+ {
+ "Sid": "DenyUnEncryptedObjectUploads",
+ "Effect": "Deny",
+ "Principal": "*",
+ "Action": "PutObject",
+ "Resource": "YourBucket/*",
+ "Condition": {
+ "StringNotEquals": {
+ "x-obs-server-side-encryption": "AES256"
+ }
+ }
+ }
+ ]
+}
+ Sample Request: Using the Default Key to Encrypt an ObjectPUT /encryp1 HTTP/1.1
+User-Agent: curl/7.29.0
+Host: examplebucket.obs.region.example.com
+Accept: */*
+Date: Wed, 06 Jun 2018 09:08:21 GMT
+Authorization: OBS H4IPJX0TQTHTHEBQQCEC:f3/7eS6MFbW3JO4+7I5AtyAQENU=
+x-obs-server-side-encryption:AES256
+Content-Length: 5242
+Expect: 100-continue
+
+[5242 Byte object contents]
+
+ Sample Response: Using the Default Key to Encrypt an ObjectHTTP/1.1 200 OK
+Server: OBS
+x-obs-request-id: 8DF400000163D45AA81D038B6AE4C482
+ETag: "d8bffdfbab5345d91ac05141789d2477"
+x-obs-server-side-encryption: AES256
+x-obs-id-2: 32AAAUJAIAABAAAQAAEAABAAAQAAEAABCTv7cHmAnGfBAGXUHeibUsiETTNqlCqC
+Date: Wed, 06 Jun 2018 09:08:21 GMT
+Content-Length: 0
+
+ Sample Request: Copying an Object as an Encrypted ObjectPUT /destobject HTTP/1.1
+User-Agent: curl/7.29.0
+Host: examplebucket.obs.region.example.com
+x-obs-server-side-encryption:AES256
+Accept: */*
+Date: Wed, 06 Jun 2018 09:10:29 GMT
+Authorization: OBS H4IPJX0TQTHTHEBQQCEC:SH3uTrElaGWarVI1uTq325kTVCI=
+x-obs-copy-source: /bucket/srcobject1
+
+ Sample Response: Copying an Object as an Encrypted ObjectHTTP/1.1 200 OK
+Server: OBS
+x-obs-request-id: BB78000001648480AF3900CED7F15155
+ETag: "d8bffdfbab5345d91ac05141789d2477"
+x-obs-server-side-encryption: AES256
+x-obs-id-2: oRAXhgwdaLc9wKVHqTLSmQB7I35D+32AAAUJAIAABAAAQAAEAABAAAQAAEAABCS
+Date: Wed, 06 Jun 2018 09:10:29 GMT
+Content-Length: 0
+
+ Sample Request: Uploading an Encrypted Object Using a Signed URLPUT /destobject?AccessKeyId=UI3SN1SRUQE14OYBKTZB&Expires=1534152518&x-obs-server-side-encryption=AES256&Signature=chvmG7%2FDA%2FDCQmTRJu3xngldJpg%3D HTTP/1.1
+User-Agent: curl/7.29.0
+Host: examplebucket.obs.region.example.com
+Accept: */*
+Date: Wed, 06 Jun 2018 09:10:29 GMT
+
+ Sample Response: Uploading an Encrypted Object Using a Signed URLHTTP/1.1 200 OK
+Server: OBS
+x-obs-request-id: BB78000001648480AF3900CED7F15155
+ETag: "d8bffdfbab5345d91ac05141789d2477"
+x-obs-server-side-encryption: AES256
+x-obs-id-2: oRAXhgwdaLc9wKVHqTLSmQB7I35D+32AAAUJAIAABAAAQAAEAABAAAQAAEAABCS
+Date: Wed, 06 Jun 2018 09:10:29 GMT
+Content-Length: 0
+
+
+
+
|---|
|
|---|
| |
|---|
| |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
| |
|
|---|
|
|---|
| |
|---|
|
|---|
|
|---|
|
|---|
|---|
|
|---|
|
|---|
|