文档首页/ 对象存储服务 OBS/ SDK参考/ Python/ 桶相关接口(Python SDK)/ 设置桶日志管理配置(Python SDK)
更新时间：2024-11-13 GMT+08:00
查看PDF
分享

设置桶日志管理配置(Python SDK)

功能说明

调用设置桶日志管理配置接口，您可以为指定桶打开桶日志功能，并配置日志存放的目标桶。创建桶时，默认是不生成桶的日志的，调用Python SDK的设置桶日志管理配置接口时，接口会自动为您打开桶日志配置。桶日志功能开启后，桶的每次操作将会产生一条日志，并将多条日志打包成一个日志文件。日志文件存放位置需要在开启桶日志功能时指定，可以存放到开启日志功能的桶中，也可以存放到其他您有权限的桶中，但需要和开启日志功能的桶在同一个region中。您还可以根据需要配置日志文件的访问权限，以及日志文件的文件名前缀。

接口约束

  • 由于日志文件是OBS产生，并且由OBS上传到存放日志的桶中，因此OBS需要获得委托授权，用于上传生成的日志文件，所以在配置桶日志管理前，需要先到统一身份认证服务生成一个对OBS服务的委托，委托配置权限只需设置目标桶的上传对象权限。如何创建委托请参考创建云服务委托。
  • 您必须是桶拥有者或拥有设置桶日志管理配置的权限，才能设置桶日志管理配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketLogging权限，如果使用桶策略则需授予PutBucketLogging权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。
  • OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

方法定义

ObsClient.setBucketLogging(bucketName, logstatus, extensionHeaders)

请求参数说明

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
  • 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

logstatus

Logging

可选

参数解释：

日志配置信息。详见Logging。

默认取值：

无

extensionHeaders

dict

可选

参数解释：

接口的拓展头域。

取值范围：

参考自定义头域。

默认取值：

无
表1 Logging

参数名称

参数类型

是否必选

描述

targetBucket

str

可选

参数解释：

日志存储桶的桶名，该桶用于存放日志文件。

约束限制：

  • 需要和开启日志功能的桶在同一个region中。
  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。
  • 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。

默认取值：

无

targetPrefix

str

可选

参数解释：

日志文件对象的对象名前缀，设置后日志文件对象将携带统一前缀存储在日志存储桶中。

取值范围：

长度大于0且不超过1024的字符串。

默认取值：

无

targetGrants

list of Grant

可选

参数解释：

被授权用户的权限信息列表，定义哪些用户可以针对日志文件进行哪些访问操作，详见Grant。

默认取值：

无

agency

str

如果是设置桶日志配置则必选

参数解释：

目标桶（存放日志文件的桶）的所有者通过统一身份认证服务（IAM）创建对OBS云服务委托的名称。

可以选择账号下已有的IAM委托，也可以创建一个新的委托。创建委托参见创建IAM委托。

约束限制：

默认情况下，在为委托配置权限时只需设置日志存储桶的上传对象（PutObject）权限。如果日志存储桶开启了默认加密功能，还需要委托同时具有日志存储桶所在区域的KMS Administrator权限。

默认取值：

无
表2 Grant

参数名称

参数类型

是否必选

描述

grantee

Grantee

必选

参数解释：

被授权用户信息详见Grantee。

permission

str

必选

参数解释：

被授予的权限。

取值范围：

授权策略的取值范围详见权限。

默认取值：

无

delivered

bool

可选

参数解释：

桶的ACL是否向桶内对象传递。作用于桶内所有对象。

取值范围：

True：是，桶ACL向桶内对象传递。

False：否，桶ACL不向桶内对象传递，仅作用于桶。

默认取值：

False
表3 Grantee

参数名称

参数类型

是否必选

描述

grantee_id

str

如果group为空则必选。

参数解释：

被授权用户的账号ID，即domain_id。

取值范围：

如何获取账号ID请参见获取账号ID。

默认取值：

无

grantee_name

str

可选

参数解释：

被授权的用户名。

约束限制：

  • 不支持中文。
  • 只能以字母开头。长度为6-32个字符。
  • 只能包含英文字母、数字或特殊字符(-_)。

默认取值：

无

group

str

如果grantee_id为空则必选。

参数解释：

被授权的用户组。

取值范围：

授权用户组取值范围详见用户组。

默认取值：

无

grantee_id与grantee_name配套使用，且与group互斥，即被授权用户可以是一个具体用户（通过grantee_id标识）或者是一个用户组。

表4 Permission

常量值

说明

READ

读权限。

如果有桶的读权限，则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。

如果有对象的读权限，则可以获取该对象内容和元数据。

WRITE

写权限。

如果有桶的写权限，则可以上传、覆盖和删除该桶内任何对象和段。

此权限在对象上不适用。

READ_ACP

读取ACL配置的权限。

如果有读ACP的权限，则可以获取对应的桶或对象的权限控制列表（ACL）。

桶或对象的所有者永远拥有读对应桶或对象ACP的权限。

WRITE_ACP

修改ACL配置的权限。

如果有写ACP的权限，则可以更新对应桶或对象的权限控制列表（ACL）。

桶或对象的所有者永远拥有写对应桶或对象的ACP的权限。

拥有了写ACP的权限，由于可以更改权限控制策略，实际上意味着拥有了完全访问的权限。

FULL_CONTROL

完全控制权限，包括对桶或对象的读写权限，以及对桶或对象ACL配置的读写权限。

如果有桶的完全控制权限意味着拥有READ、WRITE、READ_ACP和WRITE_ACP的权限。

如果有对象的完全控制权限意味着拥有READ、READ_ACP和WRITE_ACP的权限。

表5 Group

常量值

说明

ALL_USERS

所有用户。

AUTHENTICATED_USERS

授权用户，已废弃。

LOG_DELIVERY

日志投递组，已废弃。

返回结果说明

类型

说明

GetResult

参数解释：

SDK公共结果对象。
表6 GetResult

参数名称

参数类型

描述

status

int

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。

默认取值：

无

reason

str

参数解释：

HTTP文本描述。

默认取值：

无

errorCode

str

参数解释：

OBS服务端错误码，当status参数小于300时为空。

默认取值：

无

errorMessage

str

参数解释：

OBS服务端错误描述，当status参数小于300时为空。

默认取值：

无

requestId

str

参数解释：

OBS服务端返回的请求ID。

默认取值：

无

indicator

str

参数解释：

OBS服务端返回的错误定位码。

默认取值：

无

hostId

str

参数解释：

请求的服务端ID，当status参数小于300时为空。

默认取值：

无

resource

str

参数解释：

发生错误时相关的桶或对象，当status参数小于300时为空。

默认取值：

无

header

list

参数解释：

响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。

默认取值：

无

body

object

参数解释：

操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值：

无

代码样例

本示例用于设置名为examplebucket的桶日志，并将日志存放于桶名为targetbucket中。

 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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
from obs import ObsClient
from obs import Grantee
from obs import Grant
from obs import Logging
from obs import Permission
import os
import traceback

# 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
# 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# 【可选】如果使用临时AKSK和SecurityToken访问OBS，则同样推荐通过环境变量获取
# security_token = os.getenv("SecurityToken")
# server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写
server = "https://obs.cn-north-4.myhuaweicloud.com"
# 创建obsClient实例
# 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    # 指定桶日志权限，指定用户（userid）拥有读权限
    grantee1 = Grantee(grantee_id='userid')
    grant1 = Grant(grantee=grantee1, permission=Permission.READ)
    grantList = [grant1]
    # 指定日志存放的桶名
    targetBucket = "targetBucket"
    # 指定对象前缀，即日志存放路径
    targetPrefix = 'test/'
    # 指定委托名
    agency = 'your agency'
    # 日志配置信息
    logstatus = Logging(targetBucket, targetPrefix, grantList, agency)
    bucketName = "examplebucket"
    # 设置桶的日志管理
    resp = obsClient.setBucketLogging(bucketName, logstatus)

    # 返回码为2xx时，接口调用成功，否则接口调用失败
    if resp.status < 300:
        print('Set Bucket Logging Succeeded')
        print('requestId:', resp.requestId)
    else:
        print('Set Bucket Logging Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except:
    print('Set Bucket Logging Failed')
    print(traceback.format_exc())

相关链接

  • 关于设置桶日志管理配置的API说明，请参见设置桶日志管理配置。
  • 更多关于设置桶日志管理配置的示例代码，请参见Github示例。
  • 设置桶日志管理配置过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。

相关文档