设置桶日志管理配置SetBucketLogging_桶的高级配置

接口说明

创建桶时,默认是不生成桶的日志的,如果需要生成桶的日志,该桶需要打开日志配置管理的开关。桶日志功能开启后,桶的每次操作将会产生一条日志,并将多条日志打包成一个日志文件。日志文件存放位置需要在开启桶日志功能时指定,可以存放到开启日志功能的桶中,也可以存放到其他你有权限的桶中,但需要和开启日志功能的桶在同一个region中。

由于日志文件是OBS产生,并且由OBS上传到存放日志的桶中,因此OBS需要获得委托授权,用于上传生成的日志文件,所以在配置桶日志管理前,需要先到统一身份认证服务生成一个对OBS服务的委托,并将委托名作为参数配置到桶上,并且在xml文件中<LoggingEnabled>标签下配置相应的日志管理功能。在为委托配置权限时只需设置目标桶的上传对象权限。

委托权限示例

{
    "Version": "1.1",
    "Statement": [
        {
            "Action": [
                "obs:object:PutObject"
            ],
            "Resource": [
                "OBS:*:*:object:mybucketlogs/*"
            ],
            "Effect": "Allow"
        }
    ]
}

关闭桶日志功能的方法是上传一个带有空的BucketLoggingStatus标签的logging文件。默认存储类别为低频访问存储或归档存储的桶不能作为存放日志文件的桶。日志文件存放到桶中后,这些日志文件会占用空间,并按照用户存放数据同样的计费策略进行计费。

URL

PUT https://obs.af-south-1.myhuaweicloud.com/

请求参数

名称	类型	IN	必选	描述
Authorization	string	header	是	请求消息中可带的签名信息。
Date	string	header	否	请求发起端的日期和时间,例如:Wed, 27 Jun 2018 13:39:15 +0000。默认值:无。条件:如果消息头中带了x-obs-date字段,则可以不带该字段,其他情况下必选。
Content-HmacSHA256	string	header	否	按SHA安全加密标准计算出消息体的SHA256摘要字符串,即消息体256-bit SHA256值经过base64编码后得到的字符串
bucket_name	string	query	是	请求的桶名称。
logging	string	query	是	logging表示请求桶日志管理配置API。

Body参数

名称	类型	必选	描述
Agency	string	否	目标桶Owner通过统一身份认证服务创建的对OBS服务的委托的名称。设置logging时必选。关闭logging时勿选。
LoggingEnabled	LoggingEnabled object	否	该元素起到对日志配置管理的使能作用(呈现此元素则打开日志配置,否则关闭配置)。在此元素下,可加入具体的日志配置信息。设置logging时必选。关闭logging时勿选。

参数：

LoggingEnabled

名称	类型	必选	描述
TargetBucket	string	否	在生成日志时,配置日志桶的所有者可以指定一个桶用于存放产生的日志文件。需要保证配置日志文件的桶owner对存放日志文件的桶有FULL_CONTROL权限。支持多个桶生成的日志放在同一个目标桶中,如果这样做,就需要指定不同的TargetPrefix以达到为来自不同源桶的日志分类的目的。设置logging时必选。关闭logging时勿选。
TargetPrefix	string	否	通过该元素指定一个前缀,所有生成的日志对象的对象名都以此元素的内容为前缀。设置logging时必选。关闭logging时勿选。
TargetGrants	Array of TargetGrantsGrant objects	否	授权信息的容器。

参数：

LoggingEnabled.TargetGrants

名称	类型	必选	描述
Grantee	TargetGrantsGrantGrantee object	否	作为被授权logging权限用户的容器。
Permission	string	否	产生的日志文件对被授权者的具体权限。 FULL_CONTROL 完全控制权限。 READ 读权限。 WRITE 写权限。

名称

类型

必选

描述

Grantee

TargetGrantsGrantGrantee object

否

作为被授权logging权限用户的容器。

Permission

string

否

产生的日志文件对被授权者的具体权限。

FULL_CONTROL 完全控制权限。
READ 读权限。
WRITE 写权限。

参数：

LoggingEnabled.TargetGrants.Grantee

名称	类型	必选	描述
ID	string	否	被授权者的租户ID,全局唯一标识

返回参数

返回码: 200

请求成功响应消息。

名称	类型	必选	描述
Content-Length	string	否	响应消息体的字节长度。
Connection	string	否	指明与服务器的连接是长连接还是短连接。
Date	string	否	OBS系统响应的时间。
ETag	string	否	对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识,可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A,下载对象时ETag为B,则说明对象内容发生了变化。实际的ETag是对象的哈希值。ETag只反映变化的内容,而不是其元数据。上传的对象或拷贝操作创建的对象,通过MD5加密后都有唯一的ETag。如果通过多段上传对象,则无论加密方法如何,MD5会拆分ETag,此类情况ETag就不是MD5的摘要。
x-obs-id-2	string	否	帮助定位问题的特殊符号。
x-obs-request-id	string	否	由OBS创建来唯一确定本次请求的值,可以通过该值来定位问题。

返回码: 400

请求失败响应消息。

名称	类型	必选	描述
Code	string	否	错误响应消息体XML中错误响应对应的HTTP消息返回码,具体的错误码请参见错误码-表2。
Message	string	否	错误响应消息体XML中具体错误更全面、详细的英文解释,具体的错误消息请参见错误码-表2。
RequestId	string	否	本次错误请求的请求ID,用于错误定位。
HostId	string	否	返回该消息的服务端ID。
Resource	string	否	该错误相关的桶或对象资源。

请求示例

示例 1

"/?logging"

"PUT /?logging HTTP/1.1 \nHost: bucketname.obs.cn-north-4.myhuaweicloud.com \nDate: date\nAuthorization: signatureValue\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<BucketLoggingStatus>\n <Agency>agency-name</Agency>\n <LoggingEnabled>\n <TargetBucket>mybucketlogs</TargetBucket>\n <TargetPrefix>mybucket-access_log-/</TargetPrefix>\n <TargetGrants>\n <Grant>\n <Grantee>\n <ID>domainID</ID>\n </Grantee>\n <Permission>READ</Permission>\n </Grant>\n </TargetGrants>\n </LoggingEnabled>\n</BucketLoggingStatus>"

错误码

请参考错误码说明。

委托权限示例

最新文章