Uploading an Object - PUT
Functions
After creating a bucket in OBS, you can use this operation to upload an object to the bucket. This operation uploads an object to a bucket. To use this operation, you must have the write permission for the bucket.
The name of each object in a bucket must be unique.
With versioning not enabled, if an object to be uploaded has the same name as an existing object in the bucket, the newly uploaded object will overwrite the existing one. To protect data from being corrupted during transmission, you can add the Content-MD5 header in the request. After receiving the uploaded object, OBS compares the provided MD5 value to the MD5 value it calculates. If the two values do not match, OBS reports an error.
You can also specify the value of the x-obs-acl parameter to configure an access control policy for the object. If the x-obs-acl parameter is not specified when an anonymous user uploads an object, the object can be accessed by all OBS users by default.
This operation supports server-side encryption.
For a single upload, the size of the object to be uploaded ranges [0, 5 GB]. To upload a file greater than 5 GB, see Operations on Multipart Upload.
OBS does not have real folders. To facilitate data management, OBS provides a method to simulate a folder by adding a slash (/) to the object name, for example, test/123.jpg. You can simulate test as a folder and 123.jpg as the name of a file under the test folder. However, the object key remains test/123.jpg. Objects named in this format appear as folders on the console. When you upload an object larger than 0 in size using this format, an empty folder will be displayed on the console, but the occupied storage capacity is the actual object size.
Differences Between PUT and POST Methods
Parameters are passed through the request header if the PUT method is used to upload objects; if the POST method is used to upload objects, parameters are passed through the form field in the message body.
With the PUT method, you need to specify the object name in the URL, but object name is not required with the POST method, which uses the bucket domain name as the URL. Request lines of these two methods are given as follows:
PUT /ObjectName HTTP/1.1
POST / HTTP/1.1
In a PUT request, if you write the message body in POST format, the object uploaded to OBS will be displayed in a form.
For details about POST upload, see Uploading an Object - POST.
Versioning
If versioning is enabled for a bucket, the system automatically generates a unique version ID for the requested object in this bucket and returns the version ID in response header x-obs-version-id. If versioning is suspended for the bucket, the object version ID is null. For details about the versioning statuses of a bucket, see Configuring Versioning for a Bucket.
WORM
If a bucket has WORM enabled, you can configure retention policies for objects in the bucket. You can specify the x-obs-object-lock-mode and x-obs-object-lock-retain-until-date headers to configure a retention policy when you upload an object. If you do not specify these two headers but have configured a default bucket-level WORM policy, this default policy automatically applies to the object newly uploaded. You can also configure or update a WORM retention policy for an existing object.
When you enable WORM for a bucket, OBS automatically enables versioning for the bucket. WORM protects objects based on the object version IDs. Only object versions with any WORM retention policy configured will be protected. Assume that object test.txt 001 is protected by WORM. If another file with the same name is uploaded, a new object version test.txt 002 with no WORM policy configured will be generated. In such case, test.txt 002 is not protected and can be deleted. When you download an object without specifying a version ID, the current object version (test.txt 002) will be downloaded.
Request Syntax
PUT /ObjectName HTTP/1.1Host: bucketname.obs.region.example.comContent-Type: application/xmlContent-Length: lengthAuthorization: authorizationDate: date<Optional Additional Header><object Content>
Request Parameters
This request contains no parameters.
Request Headers
This request uses common headers. For details, see Table 3. The request can use additional headers shown in Table 1.
OBS supports the six HTTP request headers: Cache-Control, Expires, Content-Encoding, Content-Disposition, Content-Type, and Content-Language. If these headers are carried in an object upload request, their values are saved. You can also call the metadata modification API, provided by OBS, to change the values of the six headers. When the object is downloaded or queried, the saved values are set for corresponding HTTP headers and returned to the client.
Header | Type | Mandatory (Yes/No) | Description |
---|---|---|---|
Content-MD5 | String | No | Explanation: Base64-encoded 128-bit MD5 digest of the message according to RFC 1864. Example: n58IG6hfM7vqI4K0vnWpog== Restrictions: None Value range: None Default value: None |
x-obs-acl | String | No | Explanation: When creating an object, you can use this parameter to set a pre-defined ACL. Restrictions: Pre-defined policies must be displayed in character strings. Value range:
Default value: private |
x-obs-grant-read | String | No | Explanation: 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: Use commas (,) to separate multiple domains. Value range: The value must be a valid ID. For details, see Obtaining a Domain ID and a User ID. Default value: None |
x-obs-grant-read-acp | String | No | Explanation: 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: Use commas (,) to separate multiple domains. Value range: The value must be a valid ID. For details, see Obtaining a Domain ID and a User ID. Default value: None |
x-obs-grant-write-acp | String | No | Explanation: 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: Use commas (,) to separate multiple domains. Value range: The value must be a valid ID. For details, see Obtaining a Domain ID and a User ID. Default value: None |
x-obs-grant-full-control | String | No | Explanation: 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: Use commas (,) to separate multiple domains. Value range: The value must be a valid ID. For details, see Obtaining a Domain ID and a User ID. Default value: None |
x-obs-storage-class | String | No | Explanation: 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: The value is case-sensitive. Value range:
Default value: By default, the storage class of the bucket is inherited. |
x-obs-meta-* | String | 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: Both metadata keys and their values must conform to US-ASCII standards. Value range: None Default value: None |
x-obs-website-redirect-location | String | No | Explanation: If a bucket is configured with the static website hosting function, it will redirect requests for this object to another object in the same bucket or to an external URL. OBS stores the value of this header in the object metadata. In the following example, the request header sets the redirection to an object (anotherPage.html) in the same bucket: 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: The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB. Value range: None Default value: None |
x-obs-server-side-encryption | String | No. This header is required when SSE-KMS is used. | Explanation: Indicates that SSE-KMS is used. Example: x-obs-server-side-encryption: kms Restrictions: None Value range: kms, or AES256 Default value: None |
x-obs-server-side-encryption-kms-key-id | String | No | Explanation: ID of a specified key used for SSE-KMS encryption. Restrictions: This header can only be used when you specify kms for the x-obs-server-side-encryption header. Default value: If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it. |
x-obs-server-side-encryption-customer-algorithm | String | No. This header is required when SSE-C is used. | Explanation: The algorithm used for encryption. Example: x-obs-server-side-encryption-customer-algorithm: AES256 Restrictions:
Value range: AES256 Default value: None |
x-obs-server-side-encryption-customer-key | String | No. This header is required when SSE-C is used. | Explanation: The key used for encrypting an object. Example: x-obs-server-side-encryption-customer-key:K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw= Restrictions:
Value range: None Default value: None |
x-obs-server-side-encryption-customer-key-MD5 | String | No. This header is required when SSE-C is used. | Explanation: The MD5 value of the key used for encryption. The MD5 value is used to check whether any error occurs during the transmission of the key. Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ== Restrictions:
Value range: MD5 value of the key. Default value: None |
success-action-redirect | String | No | Explanation: The redirection address used when requests were successfully responded to.
Restrictions: The value must be a valid URL, for example, http://domainname or https://domainname. Value range: URL Default value: None |
x-obs-expires | Integer | No | Explanation: 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: The value must be greater than the number of days that have passed since the object was created. For example, if the object was uploaded 10 days ago, you must specify a value greater than 10. Value range: The value is an integer greater than 0. Default value: None |
x-obs-object-lock-mode | String | No, but required when x-obs-object-lock-retain-until-date is present | Explanation: WORM mode applied to the object. Example: x-obs-object-lock-mode:COMPLIANCE Restrictions:
Value range: COMPLIANCE Default value: None |
x-obs-object-lock-retain-until-date | String | No, but required when x-obs-object-lock-mode is present. | Explanation: When the WORM policy of the object expires. Example: x-obs-object-lock-retain-until-date:2015-07-01T04:11:15Z Restrictions:
Value range: The time must be later than the current time. Default value: None |
Request Elements
This request contains no elements. Its body contains only the content of the requested object.
Response Syntax
HTTP/1.1 status_codeContent-Length: lengthContent-Type: type
Response Headers
The response to the request uses common headers. For details, see Table 1.
In addition to the common response headers, the headers listed in Table 2 might also be needed.
Header | Type | Description |
---|---|---|
x-obs-version-id | String | Explanation: Version ID of the object. If versioning is enabled for the bucket, the object version ID will be returned. Restrictions: None Value range: None Default value: None |
x-obs-server-side-encryption | 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 |
x-obs-server-side-encryption-kms-key-id | String | Explanation: ID of a specified key used for SSE-KMS encryption. Restrictions: This header can only be used when you specify kms for the x-obs-server-side-encryption header. Default value: If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it. |
x-obs-server-side-encryption-customer-algorithm | String | Explanation: The algorithm used for encryption. Example: x-obs-server-side-encryption-customer-algorithm: AES256 Restrictions: This header is included in a response if SSE-C is used for server-side encryption. Value range: AES256 Default value: None |
x-obs-server-side-encryption-customer-key-MD5 | String | Explanation: The MD5 value of the key used for encryption. Example: x-obs-server-side-encryption-customer-key-MD5:4XvB3tbNTN+tIEVa0/fGaQ== Restrictions: This header is included in a response if SSE-C is used for server-side encryption. Value range: MD5 value of the key. Default value: None |
x-obs-storage-class | String | Explanation: Storage class of an object Restrictions: This header is returned when the storage class of an object is not Standard. Value range:
Default value: None |
Response Elements
This response contains no elements.
Error Responses
No special error responses are returned. For details about error responses, see Table 2.
Sample Request: Uploading an Object
PUT /object01 HTTP/1.1User-Agent: curl/7.29.0Host: examplebucket.obs.region.example.comAccept: */*Date: WED, 01 Jul 2015 04:11:15 GMTAuthorization: OBS H4IPJX0TQTHTHEBQQCEC:gYqplLq30dEX7GMi2qFWyjdFsyw=Content-Length: 10240Expect: 100-continue[1024 Byte data content]
Sample Response: Uploading an Object
HTTP/1.1 200 OKServer: OBSx-obs-request-id: BF2600000164364C10805D385E1E3C67ETag: "d41d8cd98f00b204e9800998ecf8427e"x-obs-id-2: 32AAAWJAMAABAAAQAAEAABAAAQAAEAABCTzu4Jp2lquWuXsjnLyPPiT3cfGhqPoYDate: WED, 01 Jul 2015 04:11:15 GMTContent-Length: 0
Sample Request: Uploading an Object (with the ACL Configured)
PUT /object01 HTTP/1.1User-Agent: curl/7.29.0Host: examplebucket.obs.region.example.comAccept: */*Date: WED, 01 Jul 2015 04:13:55 GMTx-obs-grant-read:id=52f24s3593as5730ea4f722483579ai7,id=a93fcas852f24s3596ea8366794f7224Authorization: OBS H4IPJX0TQTHTHEBQQCEC:gYqplLq30dEX7GMi2qFWyjdFsyw=Content-Length: 10240Expect: 100-continue[1024 Byte data content]
Sample Response: Uploading an Object (with the ACL Configured)
HTTP/1.1 200 OKServer: OBSx-obs-request-id: BB7800000164845759E4F3B39ABEE55EETag: "d41d8cd98f00b204e9800998ecf8427e"x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSReVRNuas0knI+Y96iXrZA7BLUgj06ZDate: WED, 01 Jul 2015 04:13:55 GMTContent-Length: 0
Sample Request: Uploading an Object to a Versioned Bucket
PUT /object01 HTTP/1.1User-Agent: curl/7.29.0Host: examplebucket.obs.region.example.comAccept: */*Date: WED, 01 Jul 2015 04:17:12 GMTx-obs-storage-class: WARMAuthorization: OBS H4IPJX0TQTHTHEBQQCEC:uFVJhp/dJqj/CJIVLrSZ0gpw3ng=Content-Length: 10240Expect: 100-continue[1024 Byte data content]
Sample Response: Uploading an Object to a Versioned Bucket
HTTP/1.1 200 OKServer: OBSx-obs-request-id: DCD2FC9CAB78000001439A51DB2B2577ETag: "d41d8cd98f00b204e9800998ecf8427e"X-OBS-ID-2: GcVgfeOJHx8JZHTHrRqkPsbKdB583fYbr3RBbHT6mMrBstReVILBZbMAdLiBYy1lDate: WED, 01 Jul 2015 04:17:12 GMTx-obs-version-id: AAABQ4q2M9_c0vycq3gAAAAAVURTRkhaContent-Length: 0
Sample Request: Uploading an Object (with Its MD5 Specified)
PUT /object01 HTTP/1.1User-Agent: curl/7.29.0Host: examplebucket.obs.region.example.comAccept: */*Date: WED, 01 Jul 2015 04:17:50 GMTAuthorization: OBS H4IPJX0TQTHTHEBQQCEC:uFVJhp/dJqj/CJIVLrSZ0gpw3ng=Content-Length: 10Content-MD5: 6Afx/PgtEy+bsBjKZzihnw==Expect: 100-continue1234567890
Sample Response: Uploading an Object (with Its MD5 Specified)
HTTP/1.1 200 OKServer: OBSx-obs-request-id: BB7800000164B165971F91D82217D105X-OBS-ID-2: 32AAAUJAIAABAAAQAAEAABAAAQAAEAABCSEKhBpS4BB3dSMNqMtuNxQDD9XvOw5hETag: "1072e1b96b47d7ec859710068aa70d57"Date: WED, 01 Jul 2015 04:17:50 GMTContent-Length: 0
Sample Request: Uploading an Object (with Website Hosting Configured)
If static website hosting has been configured for a bucket, you can configure parameters as follows when you upload an object. Then, users will be redirected when they download the object.
PUT /object01 HTTP/1.1User-Agent: curl/7.29.0Host: examplebucket.obs.region.example.comAccept: */*Date: WED, 01 Jul 2015 04:17:12 GMTx-obs-website-redirect-location: http://www.example.com/Authorization: OBS H4IPJX0TQTHTHEBQQCEC:uFVJhp/dJqj/CJIVLrSZ0gpw3ng=Content-Length: 10240Expect: 100-continue[1024 Byte data content]
Sample Response: Uploading an Object (with Website Hosting Configured)
HTTP/1.1 200 OKServer: OBSx-obs-request-id: DCD2FC9CAB78000001439A51DB2B2577x-obs-id-2: 32AAAUJAIAABAAAQAAEAABAAAQAAEAABCTmxB5ufMj/7/GzP8TFwTbp33u0xhn2ZETag: "1072e1b96b47d7ec859710068aa70d57"Date: WED, 01 Jul 2015 04:17:12 GMTx-obs-version-id: AAABQ4q2M9_c0vycq3gAAAAAVURTRkhaContent-Length: 0
Sample Request: Uploading an Object Using a Signed URL
PUT /object02?AccessKeyId=H4IPJX0TQTHTHEBQQCEC&Expires=1532688887&Signature=EQmDuOhaLUrzrzRNZxwS72CXeXM%3D HTTP/1.1User-Agent: curl/7.29.0Host: examplebucket.obs.region.example.comAccept: */*Content-Length: 1024[1024 Byte data content]
Sample Response: Uploading an Object Using a Signed URL
HTTP/1.1 200 OKServer: OBSx-obs-request-id: DCD2FC9CAB78000001439A51DB2B2577x-obs-id-2: 32AAAUJAIAABAAAQAAEAABAAAQAAEAABCTmxB5ufMj/7/GzP8TFwTbp33u0xhn2ZETag: "1072e1b96b47d7ec859710068aa70d57"Date: Fri, 27 Jul 2018 10:52:31 GMTx-obs-version-id: AAABQ4q2M9_c0vycq3gAAAAAVURTRkhaContent-Length: 0
Sample Request: Uploading an Object (with a Storage Class Specified)
PUT /object01 HTTP/1.1User-Agent: curl/7.29.0Host: examplebucket.obs.region.example.comAccept: */*Date: WED, 01 Jul 2015 04:15:07 GMTx-obs-storage-class: WARMAuthorization: OBS H4IPJX0TQTHTHEBQQCEC:uFVJhp/dJqj/CJIVLrSZ0gpw3ng=Content-Length: 10240Expect: 100-continue[1024 Byte data content]
Sample Response: Uploading an Object (with a Storage Class Specified)
HTTP/1.1 200 OKServer: OBSx-obs-request-id: BB7800000164846A2112F98BF970AA7EETag: "d41d8cd98f00b204e9800998ecf8427e"x-obs-id-2: a39E0UgAIAABAAAQAAEAABAAAQAAEAABCTPOUJu5XlNyU32fvKjM/92MQZK2gtoBDate: WED, 01 Jul 2015 04:15:07 GMTContent-Length: 0
Sample Request: Uploading an Object (with a WORM Retention Policy Configured)
PUT /object01 HTTP/1.1User-Agent: curl/7.29.0Host: examplebucket.obs.region.example.comAccept: */*Date: WED, 01 Jul 2015 04:11:15 GMTAuthorization: OBS H4IPJX0TQTHTHEBQQCEC:gYqplLq30dEX7GMi2qFWyjdFsyw=Content-Length: 10240x-obs-object-lock-mode:COMPLIANCEx-obs-object-lock-retain-until-date:2022-09-24T16:10:25ZExpect: 100-continue[1024 Byte data content]
Sample Response: Uploading an Object (with a WORM Retention Policy Configured)
HTTP/1.1 200 OKServer: OBSx-obs-request-id: BF2600000164364C10805D385E1E3C67ETag: "d41d8cd98f00b204e9800998ecf8427e"x-obs-id-2: 32AAAWJAMAABAAAQAAEAABAAAQAAEAABCTzu4Jp2lquWuXsjnLyPPiT3cfGhqPoYDate: WED, 01 Jul 2015 04:11:15 GMTContent-Length: 0
- Functions
- Differences Between PUT and POST Methods
- Versioning
- WORM
- Request Syntax
- Request Parameters
- Request Headers
- Request Elements
- Response Syntax
- Response Headers
- Response Elements
- Error Responses
- Sample Request: Uploading an Object
- Sample Response: Uploading an Object
- Sample Request: Uploading an Object (with the ACL Configured)
- Sample Response: Uploading an Object (with the ACL Configured)
- Sample Request: Uploading an Object to a Versioned Bucket
- Sample Response: Uploading an Object to a Versioned Bucket
- Sample Request: Uploading an Object (with Its MD5 Specified)
- Sample Response: Uploading an Object (with Its MD5 Specified)
- Sample Request: Uploading an Object (with Website Hosting Configured)
- Sample Response: Uploading an Object (with Website Hosting Configured)
- Sample Request: Uploading an Object Using a Signed URL
- Sample Response: Uploading an Object Using a Signed URL
- Sample Request: Uploading an Object (with a Storage Class Specified)
- Sample Response: Uploading an Object (with a Storage Class Specified)
- Sample Request: Uploading an Object (with a WORM Retention Policy Configured)
- Sample Response: Uploading an Object (with a WORM Retention Policy Configured)