Configuring an Object ACL¶
Functions¶
OBS supports the control of access permission for objects. By default, only the object creator has the read and write permissions for the object. However, the creator can set a public access policy to assign the read permission to all other users.
You can set an access control policy when uploading an object or make a call of an API operation to modify or obtain the object ACL. An object ACL supports a maximum of 100 grants.
This section explains how to modify an object ACL and change access permission on an object.
Versioning¶
By default, this operation modifies the ACL of the latest version of an object. To specify a specified version, the request can carry the versionId parameter.
Request Syntax¶
PUT /ObjectName?acl HTTP/1.1
Host: bucketname.obs.region.example.com
Date: date
Authorization: authorization
<AccessControlPolicy>
<Owner>
<ID>ID</ID>
</Owner>
<Delivered>true</Delivered>
<AccessControlList>
<Grant>
<Grantee>
<ID>ID</ID>
</Grantee>
<Permission>permission</Permission>
</Grant>
</AccessControlList>
</AccessControlPolicy>
Request Parameters¶
Table 1 describes the request parameters.
Parameter | Description | Mandatory |
|---|---|---|
versionId | Object version ID. The ACL of the specified object version is to be changed. Type: string | No |
Request Headers¶
This request uses common headers. For details, see Table 3.
Request Elements¶
The request message carries the ACL information of the object by using message elements. For the meanings of the elements, see Table 2.
Element | Description | Mandatory |
|---|---|---|
Owner | Bucket owner information, including the ID Type: XML | Yes |
ID | Domain ID of a user. Type: string | Yes |
Grant | Container for the grantee and the granted permissions. A single object ACL can contain no more than 100 grants. Type: XML | No |
Grantee | Container for the details about the grantee. Type: XML | No |
Canned | Grants permissions to all users. Value range: Everyone Type: string | No |
Delivered | Indicates whether an object ACL inherits the ACL of a bucket. Type: boolean Default value: true | No |
Permission | Authorized permission. Value options: READ, READ_ACP, WRITE_ACP, FULL_CONTROL Type: string | No |
AccessControlList | Indicates an ACL, which consists of three elements: Grant, Grantee, and Permission. Type: XML | Yes |
Response Syntax¶
HTTP/1.1 status_code
Content-Length: length
Content-Type: application/xml
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 3 may be used.
Header | Description |
|---|---|
x-obs-version-id | Version number of the object whose ACL is to be modified. Type: string |
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¶
PUT /obj2?acl HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.region.example.com
Accept: */*
Date: WED, 01 Jul 2015 04:42:34 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:8xAODun1ofjkwHm8YhtN0QEcy9M=
Content-Length: 727
<AccessControlPolicy xmlns="http://obs.example.com/doc/2015-06-30/">
<Owner>
<ID>b4bf1b36d9ca43d984fbcb9491b6fce9</ID>
</Owner>
<Delivered>false</Delivered>
<AccessControlList>
<Grant>
<Grantee>
<ID>b4bf1b36d9ca43d984fbcb9491b6fce9</ID>
</Grantee>
<Permission>FULL_CONTROL</Permission>
</Grant>
<Grant>
<Grantee>
<ID>783fc6652cf246c096ea836694f71855</ID>
</Grantee>
<Permission>READ</Permission>
</Grant>
<Grant>
<Grantee>
<Canned>Everyone</Canned>
</Grantee>
<Permission>READ</Permission>
</Grant>
</AccessControlList>
</AccessControlPolicy>
Sample Response¶
HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: 8DF400000163D3F0FD2A03D2D30B0542
x-obs-id-2: 32AAAUgAIAABAAAQAAEAABAAAQAAEAABCTjCqTmsA1XRpIrmrJdvcEWvZyjbztdd
Date: WED, 01 Jul 2015 04:42:34 GMT
Content-Length: 0