对象存储服务 OBS-获取桶日志管理配置(Python SDK):返回结果说明

时间:2025-05-08 15:06:32

返回结果说明

类型

说明

GetResult

参数解释:

SDK公共结果对象。

表1 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时为空。该值根据调用接口的不同而不同,参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值:

GetResult.body类型

说明

Logging

参数解释:

日志配置信息。

表2 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权限。

默认取值:

表3 Grant

参数名称

参数类型

描述

grantee

Grantee

参数解释:

被授权用户,包括用户类型,账号ID,账号名和被授权用户组,详情参考Grantee

默认取值:

permission

str

参数解释:

被授予的权限。

取值范围:

授权策略的取详情参考权限

默认取值:

delivered

bool

参数解释:

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

取值范围:

True:是,桶ACL向桶内对象传递。

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

默认取值:

False

表4 Grantee

参数名称

参数类型

描述

grantee_id

str

参数解释:

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

取值范围:

如何获取账号ID请参见如何获取账号ID和用户ID?(Python SDK)

默认取值:

grantee_name

str

参数解释:

被授权用户的账号名。

约束限制:

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

默认取值:

group

str

参数解释:

被授权的用户组,详见用户组

默认取值:

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

support.huaweicloud.com/sdk-python-devg-obs/obs_22_0817.html