PUT Bucket logging

Description

This PUT operation uses the 'logging' resource to set the log parameters of user space and specify the users who are allowed to view and change the log parameters.

The user using this interface needs to be the owner of this space.

The space owner is granted 'FULL_CONTROL 'permission for all logs by default. Users can authorize other users through the 'Grantee' request parameter. The request parameter 'Permissions' can set the specific content of permissions. (this type of authorization is not supported temporarily) To enable logging, users need to set 'loggingEnabled' and its child tags.

To close the log, the user needs to set the 'BucketLoggingStatus' request parameter to null.

<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />

Request

Grammar

PUT /?logging HTTP/1.1
Host: {BucketName}.{endpoint}
Date: {date}
Authorization: {SignatureValue}

Request elements vary depending on what you're setting.

Note:

• Corresponding relationship between Endpoint and Region
• SignatureValue signature algorithm

Request parameters

The interface does not use request parameters.

Request header

This interface only uses common request headers. For more information, please click Public request headers.

Request content

Ways to grant permissions

Users can grant a user permission to log in the following ways. Through user ID

<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID>{ID}</ID><DisplayName>{GranteesEmail}</DisplayName>
</Grantee>

Through URI

<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI>http://acs.ksyun.com/groups/global/AllUsers</URI></Grantee>

Note: currently only http://acs.ksyun.com/groups/global/allusers is supported, indicating all users, including anonymous users.

Response

Response header

This interface can use all common response headers. For more information, please click Public response headers。

Response content

The interface does not return the corresponding content.

Special errors

The interface does not return any special errors.

Example

Request example

PUT /?logging HTTP/1.1
Host: ks3-example.ks3-cn-beijing.ksyuncs.com
Content-Length: 214
Date: Fri, 26 Dec 2014 06:38:43 GMT
Authorization: authorization string

<?xml version="1.0" encoding="UTF-8"?>
<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01">
  <LoggingEnabled>
    <TargetBucket>ks3-example</TargetBucket>
    <TargetPrefix>mybucket-access_log-/</TargetPrefix>
    <TargetGrants>
    </TargetGrants>
  </LoggingEnabled>
</BucketLoggingStatus>

Response example

HTTP/1.1 200 OK
Date: Fri, 26 Dec 2014 06:38:43 GMT
Server: Tengine

Example of a request to close a log

PUT /?logging HTTP/1.1
Host: ks3-example.ks3-cn-beijing.ksyuncs.com
Content-Length: 214
Date: Fri, 26 Dec 2014 06:38:43 GMT
Authorization: authorization string

<?xml version="1.0" encoding="UTF-8"?>
<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />

Example of a response to close a log

HTTP/1.1 200 OK
Date: Fri, 26 Dec 2014 06:38:43 GMT
Server: Tengine

Interface details

• This interface can enable the bucket log function. KS3 will upload the daily request log of the bucket to the bucket specified by the user.
• The source bucket and the target bucket must be two or one bucket belonging to the same user and the same region. It is recommended to use two different bucket, and the target bucket is specially used to store logs.
• Only the bucket owner has permission to use the interface.