文档首页/ 对象存储服务 OBS/ API参考/ 桶API/ 桶日志/ 获取桶日志管理配置-GetBucketLogging
更新时间：2026-06-05 GMT+08:00
查看PDF
分享

获取桶日志管理配置-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权限，具体操作请参见自定义创建桶策略。

URI

GET /

调用方法

请参见如何调用API。调用前需要先计算API签名，并将签名添加到请求中。

您还可以使用API Explorer在线调试接口。

请求消息样式

以下为请求消息样例，请将示例中的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所示。

表1 响应体参数

参数

参数类型

描述

BucketLoggingStatus

Container

参数解释：

日志状态信息的容器。

取值范围：

不涉及。

Agency

String

参数解释：

目标桶Owner通过统一身份认证服务创建的对OBS服务的委托的名称。被委托方必须包含obs:bucket:PutBucketLogging权限。

取值范围：

不涉及。

LoggingEnabled

Container

参数解释：

该元素起到对日志配置管理的使能作用（呈现此元素则打开日志配置，否则关闭配置）。在此元素下，可加入具体的日志配置信息。

取值范围：

不涉及。

Grant

Container

参数解释：

是被授权者及其权限的容器。用于描述谁有什么权限来访问产生的日志文件。

取值范围：

不涉及。

Grantee

Container

参数解释：

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

取值范围：

不涉及。

ID

String

参数解释：

被授权者的租户ID，全局唯一标识。

取值范围：

不涉及。

Permission

String

参数解释：

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

取值范围：

  • READ：允许被授权者获取桶内对象列表和桶元数据。
  • WRITE：允许被授权者向桶中上传对象。对于桶中现有对象，允许授权者删除和覆盖这些对象。
  • FULL_CONTROL：允许被授予者拥有完全读取、写入、删除桶中对象。

TargetBucket

String

参数解释：

配置的日志桶的桶名。在生成日志时，配置日志桶的所有者可以指定一个桶用于存放产生的日志文件。

说明：
  • 请确保配置日志文件的桶owner对存放日志文件的桶有FULL_CONTROL权限。
  • 多个桶生成的日志放在同一个目标桶中时，需要指定不同的TargetPrefix以达到为来自不同源桶的日志分类的目的。

取值范围：

不涉及。

TargetPrefix

String

参数解释：

通过该元素指定一个前缀，所有生成的日志对象的对象名都以此元素的内容为前缀。

取值范围：

小于255个字节。

TargetSorting

String

参数解释：

配置桶日志归类时指定，按照指定的类型进行日志归类。

取值范围：

  • DAY：按天分类
  • HOUR：按小时分类

TargetGrants

Container

参数解释：

授权信息的容器。

取值范围：

不涉及。

错误响应消息

无特殊错误，所有错误已经包含在错误码概述中。

请求示例

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，无需手动计算签名。

Java

Python

C

Go

BrowserJS

.NET

Android

iOS

PHP

Node.js

Harmony

相关文档

父主题： 桶日志

相关文档