华为云对象存储OBS获取桶日志管理配置(Python SDK)_云淘科技
功能介绍
调用获取桶日志管理配置,可获取指定桶的日志配置。
接口约束
您必须是桶拥有者或拥有获取桶日志管理配置的权限,才能获取桶日志管理配置。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:GetBucketLogging权限,如果使用桶策略则需授予GetBucketLogging权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
方法定义
ObsClient.getBucketLogging(bucketName)
请求参数说明
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
bucketName |
str |
必选 |
参数解释: 桶名。 约束限制: 桶的名字需全局唯一,不能与已有的任何桶名称重复,包括其他用户创建的桶。 3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。 同一用户在同一个区域多次创建同名桶不会报错,创建的桶属性以第一次请求为准。 默认取值: 无 |
返回结果说明
类型 |
说明 |
---|---|
GetResult |
参数解释: SDK公共结果对象。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
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时为空。该值根据调用接口的不同而不同,参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值: 无 |
GetResult.body类型 |
说明 |
---|---|
Logging |
参数解释: 日志配置信息。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
targetBucket |
str |
作为请求参数时可选 |
参数解释: 日志存储桶的桶名,该桶用于存放日志文件。 约束限制: 需要和开启日志功能的桶在同一个region中。 3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。 同一用户在同一个区域多次创建同名桶不会报错,创建的桶属性以第一次请求为准。 默认取值: 无 |
targetPrefix |
str |
作为请求参数时可选 |
参数解释: 日志文件对象的对象名前缀,设置后日志文件对象将携带统一前缀存储在日志存储桶中。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
targetGrants |
list of Grant |
作为请求参数时可选 |
参数解释: 被授权用户权限信息列表,定义哪些用户可以针对日志文件进行哪些访问操作,详情参考Grant 默认取值: 无 |
agency |
str |
作为请求参数时如果是设置桶日志配置则必选 |
参数解释: 目标桶(存放日志文件的桶)的所有者通过统一身份认证服务(IAM)创建的对OBS云服务的委托的名称。 可以选择帐号下已有的IAM委托,也可以创建一个新的委托。创建委托参见创建IAM委托。 约束限制: 默认情况下,在为委托配置权限时只需设置日志存储桶的上传对象(PutObject)权限。如果日志存储桶开启了默认加密功能,还需要委托同时具有日志存储桶所在区域的KMS Administrator权限。 默认取值: 无 |
参数名称 |
参数类型 |
描述 |
---|---|---|
grantee |
Grantee |
参数解释: 被授权用户,包括用户类型,帐号ID,帐号名和被授权用户组,详情参考Grantee 默认取值: 无 |
permission |
str |
参数解释: 被授予的权限。 取值范围: 授权策略的取详情参考权限。 默认取值: 无 |
delivered |
bool |
参数解释: 桶的ACL是否向桶内对象传递,作用于桶内所有对象。 取值范围: True:是,桶ACL向桶内对象传递。 False:否,桶ACL不向桶内对象传递,仅作用于桶。 默认取值: False |
参数名称 |
参数类型 |
描述 |
---|---|---|
grantee_id |
str |
参数解释: 被授权用户的帐号ID,即domain_id。 取值范围: 如何获取帐号ID请参见如何获取帐号ID和用户ID? 默认取值: 无 |
grantee_name |
str |
参数解释: 被授权用户的帐号名。 约束限制: 不支持中文。 默认取值: 无 |
group |
str |
参数解释: 被授权的用户组,详见用户组。 默认取值: 无 |
grantee_id与grantee_name配套使用,且与group互斥,即被授权用户可以是一个具体用户(通过grantee_id标识)或者是一个用户组。
常量值 |
说明 |
---|---|
ALL_USERS |
所有用户。 |
AUTHENTICATED_USERS |
授权用户,已废弃。 |
LOG_DELIVERY |
日志投递组,已废弃。 |
常量值 |
说明 |
---|---|
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的权限。 |
代码样例
本示例用于获取名为examplebucket的桶日志管理。
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 |
from obs import ObsClient 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: bucketName="examplebucket" #获取桶日志 resp = obsClient.getBucketLogging(bucketName) # 返回码为2xx时,接口调用成功,否则接口调用失败 if resp.status < 300: print('Get Bucket Logging Succeeded') print('requestId:', resp.requestId) print('targetBucket:', resp.body.targetBucket) print('targetPrefix:', resp.body.targetPrefix) index = 1 for grant in resp.body.targetGrants: print('grant [' + str(index) + ']') print('grant_id:', grant.grantee.grantee_id) print('grant_name:', grant.grantee.grantee_name) print('group:', grant.grantee.group) print('permission:', grant.permission) index += 1 else: print('Get Bucket Logging Failed') print('requestId:', resp.requestId) print('errorCode:', resp.errorCode) print('errorMessage:', resp.errorMessage) except: print('Get Bucket Logging Failed') print(traceback.format_exc()) |
相关链接
关于获取桶日志管理配置的API说明,请参见获取桶日志管理配置。
更多关于获取桶日志管理配置的示例代码,请参见Github示例。
获取桶日志管理配置过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
父主题: 桶相关接口
同意关联代理商云淘科技,购买华为云产品更优惠(QQ 78315851)
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家