更新时间:2024-01-02 GMT+08:00

获取桶日志管理配置

功能介绍

该接口的目的是查询当前桶的日志管理配置情况。其实现是通过使用http的get方法再加入logging子资源来返回当前桶的日志配置情况。

要使用该接口,使用者必须是桶的所有者或者是被桶策略授权GetBucketLogging权限的用户。

请求消息样式

1
2
3
4
GET /?logging HTTP/1.1 
Host: bucketname.obs.region.example.com
Date: date
Authorization: authorization

请求消息参数

该请求消息中不使用消息参数。

请求消息头

该请求使用公共消息头,具体参见表3

请求消息元素

该请求消息中不使用消息元素。

响应消息样式

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
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.region.example.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>

响应消息头

该请求的响应消息使用公共消息头,具体请参考表1

响应消息元素

该请求的响应中以消息元素的形式返回桶的日志信息,元素的具体意义如表1所示。

表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

TargetGrants

授权信息的容器。

类型:Container

错误响应消息

无特殊错误,所有错误已经包含在表2中。

请求示例

1
2
3
4
5
6
GET /?logging HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.region.example.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
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.example.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>