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

时间:2025-02-12 15:14:02

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

Bucket

string

必选

参数解释

桶名。

约束限制:

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

取值范围:

长度为3~63个字符。

默认取值

Agency

string

作为请求参数时如果是设置桶日志配置则必选

参数解释:

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

约束限制:

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

取值范围:

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

默认取值:

LoggingEnabled

LoggingEnabled

设置logging时必选。

关闭logging时勿选。

参数解释:

日志配置信息。不配置时默认关闭桶日志。

约束限制:

取值范围:

详见LoggingEnabled

默认取值:

表2 LoggingEnabled

参数名称

参数类型

是否必选

描述

TargetBucket

string

设置logging时必选。

关闭logging时勿选。

参数解释:

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

约束限制:

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

取值范围:

长度为3~63个字符。

默认取值:

TargetPrefix

string

设置logging时必选。

关闭logging时勿选。

参数解释:

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

约束限制:

取值范围:

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

默认取值:

TargetGrants

Grant

可选

参数解释:

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

约束限制:

取值范围:

详见Grant

默认取值:

表3 Grant

参数名称

参数类型

是否必选

描述

Grantee

Grantee

必选

参数解释:

被授权用户相关信息。

约束限制:

取值范围:

详见Grantee

默认取值:

Permission

PermissionType

必选

参数解释:

被授予的权限。

约束限制:

取值范围:

详见PermissionType

默认取值:

表4 Grantee

参数名称

参数类型

是否必选

描述

Type

GranteeType

作为请求参数时必选

参数解释:

被授权用户的类型。

约束限制:

取值范围:

被授权用户类型的取值范围详见GranteeType

默认取值:

ID

string

作为请求参数时,如果Type为用户类型则必选。

参数解释:

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

约束限制:

取值范围:

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

默认取值:

Name

string

作为请求参数时可选

参数解释:

被授权用户的账号名。

约束限制:

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

取值范围:

默认取值:

URI

GroupUriType

作为请求参数时,如果Type为用户组类型则必选。

参数解释:

被授权的用户组。

约束限制:

取值范围:

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

默认取值:

表5 GranteeType

常量名

原始值

说明

GranteeGroup

Group

授权给用户组。

GranteeUser

CanonicalUser

授权给单个用户。

表6 GroupUriType

常量名

原始值

说明

GroupAllUsers

AllUsers

所有用户。

GroupAuthenticatedUsers

AuthenticatedUsers

授权用户,已废弃。

GroupLogDelivery

LogDelivery

日志投递组,已废弃。

表7 PermissionType

常量名

原始值

说明

ObsClient.enums.PermissionRead

READ

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

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

ObsClient.enums.PermissionWrite

WRITE

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

此权限在对象上不适用。

ObsClient.enums.PermissionReadAcp

READ_ACP

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

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

ObsClient.enums.PermissionWriteAcp

WRITE_ACP

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

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

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

ObsClient.enums.PermissionFullControl

FULL_CONTROL

如果有桶的完全控制权限意味着拥有PermissionRead、PermissionWrite、PermissionReadAcp和PermissionWriteAcp的权限。

如果有对象的完全控制权限意味着拥有PermissionRead、PermissionReadAcp和PermissionWriteAcp的权限。

support.huaweicloud.com/sdk-nodejs-devg-obs/obs_29_1102.html