对象存储服务 OBS-设置桶日志管理配置(Python SDK):请求参数说明

时间:2024-06-20 16:12:17

请求参数说明

参数名称

参数类型

是否必选

描述

bucketName

str

必选

参数解释

桶名。

约束限制:

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

默认取值:

logstatus

Logging

可选

参数解释:

日志配置信息。详见Logging

默认取值:

表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

日志投递组,已废弃。

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