# 获取桶日志管理配置-GetBucketLogging #### 功能介绍 开启了桶日志记录功能后，可以通过本接口查询当前桶的日志管理配置情况。了解更多有关桶日志信息，请参见[配置桶的日志记录](https://support.huaweicloud.com/usermanual-obs/obs_03_0329.html)。 #### 接口约束 - 日志可以存储在产生日志的源桶，也可以存储在其他桶，但日志存储桶和源桶必须属于同一账号下的相同区域。 将源桶产生的日志文件存储至日志存储桶，该操作本身也会生成新的日志，此时如果源桶和日志存储桶是同一个，则存储日志操作生成的日志会再次被存储，导致日志不断循环产生。因此，建议您将源桶和日志存储桶配置为不同的桶。 #### 授权信息 您必须是桶拥有者或拥有获取桶日志管理配置的权限，才能调用本接口，建议使用IAM或桶策略进行授权。了解更多OBS授权方式请参见[OBS不同权限控制方式的区别](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)。 - 如果使用**IAM授权** ，那么请在"角色与策略授权"、"身份策略授权"两种IAM授权方式中选择一种，并配置相应权限： - 如果使用**角色与策略授权** （旧版IAM，即IAM v3接口），需具备**obs:bucket:GetBucketLogging** 权限，授权操作请参见[创建IAM自定义策略](https://support.huaweicloud.com/usermanual-iam/iam_01_0605.html)。 - 如果使用**身份策略授权** （新版IAM，即IAM v5接口），如下表所示，需具备**obs:bucket:getBucketLogging** 权限，授权操作请参见[创建IAM自定义身份策略](https://support.huaweicloud.com/usermanual-iam5/iam_01_0917.html)。 | 授权项 Action | 访问级别 Access Level | 资源类型（\*为必须） Resource Type (\*: required) | [条件键](https://support.huaweicloud.com/api-obs/obs_04_0112.html#ZH-CN_TOPIC_0000002375307974__condition_table) Condition Key | [别名](https://support.huaweicloud.com/iam5_faq/iam_01_1103.html) Alias | 依赖的授权项 Dependencies | |:---|:---|:---|:---|:---|:---| | obs:bucket:getBucketLogging | Read | bucket \* | - [g:EnterpriseProjectId](https://support.huaweicloud.com/usermanual-iam5/iam_01_0934.html#section2) - [g:ResourceTag/\](https://support.huaweicloud.com/usermanual-iam5/iam_01_0934.html#section2) | - | - | | obs:bucket:getBucketLogging | Read | - | - obs:EpochTime - obs:SourceIp - obs:TlsVersion - obs:CustomDomain | - | - | - 如果使用**桶策略** 进行授权，需具备**obs:bucket:GetBucketLogging** 权限，具体操作请参见[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。 #### URI GET / #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-obs/obs_04_0006.html)。调用前需要先[计算API签名](https://support.huaweicloud.com/api-obs/obs_04_0009.html)，并将签名添加到请求中。 您还可以使用[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/OBS/doc?api=GetBucketLogging)在线调试接口。 #### 请求消息样式 以下为请求消息样例，请将示例中的*BucketName* 修改为您的桶名，*RegionID* 修改为桶所在的区域ID，可参考[支持区域](https://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)获取区域ID。 ``` GET /?logging HTTP/1.1 Host: BucketName.obs.RegionID.myhuaweicloud.com Date: GMT Date Authorization: SignatureValue ``` #### URI参数（URI Parameters） 表1URI参数 | **参数名称** | **参数类型** | **是否必选** | **描述** | |:---|:---|:---|:---| | logging | String | 否 | **参数解释**： 用于标识API接口与桶日志有关。 **约束限制**： 无。 **取值范围**： logging **默认取值**： 不涉及 | #### 请求头参数（Request headers） 该请求使用公共请求头，具体参见[表3](https://support.huaweicloud.com/api-obs/obs_04_0007.html#ZH-CN_TOPIC_0136436606__table25197309)。 #### 请求体参数（Request body） 该请求消息中不带请求体参数。 #### 响应消息样式 ``` HTTP/1.1 status_code Content-Type: application/xml Date: date Content-Length: length agency-name bucketName prefix id permission ``` #### 响应头 (Response Headers) 该请求的响应消息使用公共响应头，具体请参考[表1](https://support.huaweicloud.com/api-obs/obs_04_0013.html#ZH-CN_TOPIC_0173612084__d0e686)。 #### 响应体 (Response Body) 该请求的响应中以消息元素的形式返回桶的日志信息，元素的具体意义如[表2]所示。 表2响应体参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释：** 通过该元素指定一个前缀，所有生成的日志对象的对象名都以此元素的内容为前缀。 **取值范围：** 不超过254个字节。 | | TargetGrants | Container | **参数解释：** 授权信息的容器。 **取值范围：** 不涉及。 | #### 错误响应消息 无特殊错误，所有错误已包含在[错误码概述](https://support.huaweicloud.com/api-obs/obs_04_0115.html)中。 #### 请求示例 ``` 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= ``` #### 响应示例 ``` 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 agency-name log-bucket mybucket-access_log-/ b4bf1b36d9ca43d984fbcb9491b6fce9 READ ``` #### 使用SDK调用接口 建议您使用OBS SDK调用接口。SDK对API进行了封装以简化您的开发工作，直接调用SDK接口函数即可访问OBS，无需手动计算签名。 | [Java](https://support.huaweicloud.com/sdk-java-devg-obs/obs_21_1503.html) | [Python](https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_0817.html) | [C](https://support.huaweicloud.com/sdk-c-devg-obs/obs_20_1103.html) | [Go](https://support.huaweicloud.com/sdk-go-devg-obs/obs_33_0419.html) | [BrowserJS](https://support.huaweicloud.com/sdk-browserjs-devg-obs/obs_24_1103.html) | [.NET](https://support.huaweicloud.com/sdk-dotnet-devg-obs/obs_25_1103.html) | [Android](https://support.huaweicloud.com/sdk-android-devg-obs/obs_26_1103.html) | [iOS](https://support.huaweicloud.com/sdk-ios-devg-obs/obs_27_1103.html) | [PHP](https://support.huaweicloud.com/sdk-php-devg-obs/obs_28_1103.html) | [Node.js](https://support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1103.html) | [Harmony](https://support.huaweicloud.com/sdk-harmony-devg-obs/obs_34_0317.html) | |---|---|---|---|---|---|---|---|---|---|---| #### 相关文档 - 使用obsutil了解桶日志相关信息，请参见[日志文件](https://support.huaweicloud.com/utiltg-obs/obs_11_0056.html)。 - 了解更多有关桶日志信息，请参见[配置桶的日志记录](https://support.huaweicloud.com/usermanual-obs/obs_03_0329.html)。 - API操作涉及的计费项参见[计费项](https://support.huaweicloud.com/price-obs/obs_42_0002.html)。