获取桶日志管理配置-GetBucketLogging
功能介绍
开启了桶日志记录功能后,可以通过本接口查询当前桶的日志管理配置情况。了解更多有关桶日志信息,请参见配置桶的日志记录。
接口约束
- 日志可以存储在产生日志的源桶,也可以存储在其他桶,但日志存储桶和源桶必须属于同一账号下的相同区域。
- 默认存储类别为低频访问存储或归档存储的桶不能作为存放日志文件的桶。日志文件存放到桶中后,这些日志文件会占用空间,并按照用户存放数据同样的计费策略进行计费。
授权信息
您必须是桶拥有者或拥有获取桶日志管理配置的权限,才能调用本接口,建议使用IAM或桶策略进行授权。了解更多OBS授权方式请参见OBS不同权限控制方式的区别。
- 如果使用IAM授权,那么请在“角色与策略授权”、“身份策略授权”两种IAM授权方式中选择一种,并配置相应权限:
- 如果使用角色与策略授权(旧版IAM,即IAM v3接口),需具备obs:bucket:GetBucketLogging权限,授权操作请参见创建IAM自定义策略。
- 如果使用身份策略授权(新版IAM,即IAM v5接口),如下表所示,需具备obs:bucket:getBucketLogging权限,授权操作请参见创建IAM自定义身份策略。
授权项
Action
访问级别
Access Level
资源类型(*为必须)
Resource Type (*: required)
Condition Key
Alias
依赖的授权项
Dependencies
obs:bucket:getBucketLogging
Read
bucket *
-
-
-
- obs:EpochTime
- obs:SourceIp
- obs:TlsVersion
- obs:CustomDomain
- 如果使用桶策略进行授权,需具备obs:bucket:GetBucketLogging权限,具体操作请参见自定义创建桶策略。
请求消息样式
以下为请求消息样例,请将示例中的BucketName修改为您的桶名,RegionID修改为桶所在的区域ID,可参考支持区域获取区域ID。
1 2 3 4 | GET /?logging HTTP/1.1 Host: BucketName.obs.RegionID.myhuaweicloud.com Date: GMT Date Authorization: SignatureValue |
URI参数(URI Parameters)
该请求消息中不使用消息参数。
请求头参数(Request headers)
该请求使用公共请求头,具体参见表3。
请求体参数(Request body)
该请求消息中不带请求体参数。
响应消息样式
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | HTTP/1.1 status_code Content-Type: application/xml Date: date Content-Length: length <?xml version="1.0" encoding="UTF-8"?> <BucketLoggingStatus xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/"> <Agency>agency-name</Agency> <LoggingEnabled> <TargetBucket>bucketName</TargetBucket> <TargetPrefix>prefix</TargetPrefix> <TargetGrants> <Grant> <Grantee> <ID>id</ID> </Grantee> <Permission>permission</Permission> </Grant> </TargetGrants> </LoggingEnabled> </BucketLoggingStatus> |
响应头 (Response Headers)
该请求的响应消息使用公共响应头,具体请参考表1。
响应体 (Response Body)
该请求的响应中以消息元素的形式返回桶的日志信息,元素的具体意义如表1所示。
| 名字 | 描述 |
|---|---|
| BucketLoggingStatus | logging状态信息的容器。 类型:Container |
| Agency | 产生logging日志桶Owner创建委托OBS上传logging日志的委托名。 类型:String |
| LoggingEnabled | 用于logging信息的容器。并且该元素起到对logging配置管理的使能作用(呈现此元素则打开logging配置,否则关闭)。 类型:Container |
| Grant | 是被授权者及其权限的容器。 类型:Container |
| Grantee | 作为被授权logging权限用户的容器。 类型:Container |
| ID | 被授权用户的Domain Id,全局唯一标识。 类型:String |
| Permission | 对于一个桶的logging权限来说,owner在创建桶时将自动获得对源桶的FULL_CONTROL权限。不同的权限决定了对不同日志的访问限制。 类型:String 权限有效值:FULL_CONTROL | READ | WRITE |
| TargetBucket | 在生成日志时,源桶的owner可以指定一个目标桶,将生成的所有日志放到该桶中。在OBS系统中,支持多个源桶生成的日志放在同一个目标桶中,如果这样做,就需要指定不同的TargetPrefix以达到为来自不同源桶的日志分类的目的。 类型:String |
| TargetPrefix | 通过该元素可以指定一个前缀给一类日志生成的对象。 类型:String |
| TargetSorting | 配置桶日志归类时指定,按照指定的类型进行日志归类。 类型:String 有效值:DAY|HOUR 否 |
| TargetGrants | 授权信息的容器。 类型:Container |
错误响应消息
无特殊错误,所有错误已经包含在表2中。
请求示例
1 2 3 4 5 6 | GET /?logging HTTP/1.1 User-Agent: curl/7.29.0 Host: examplebucket.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: WED, 01 Jul 2015 02:42:46 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:hUk+jTnR07hcKwJh4ousF2E1U3E= |
响应示例
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | HTTP/1.1 200 OK Server: OBS x-obs-request-id: BF260000016436B8EEE7FBA2AA3335E3 x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCShuQJoWFpS77C8bOv1mqURv0UY+0ejx Content-Type: application/xml Date: WED, 01 Jul 2015 02:42:46 GMT Content-Length: 429 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <BucketLoggingStatus xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/"> <Agency>agency-name</Agency> <LoggingEnabled> <TargetBucket>log-bucket</TargetBucket> <TargetPrefix>mybucket-access_log-/</TargetPrefix> <TargetGrants> <Grant> <Grantee> <ID>b4bf1b36d9ca43d984fbcb9491b6fce9</ID> </Grantee> <Permission>READ</Permission> </Grant> </TargetGrants> </LoggingEnabled> </BucketLoggingStatus> |
使用SDK调用接口
建议您使用OBS SDK调用接口。SDK对API进行了封装以简化您的开发工作,直接调用SDK接口函数即可访问OBS,无需手动计算签名。

