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

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

功能说明

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

接口约束

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

方法定义

setBucketLogging(input: SetBucketLoggingInput): Response<BaseResponseOutput>

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

input

SetBucketLoggingInput

必选

参数解释：

设置桶的日志管理配置接口入参，详见SetBucketCustomDomainInput。
表2 SetBucketLoggingInput

参数名称

参数类型

是否必选

描述

Bucket

string

必选

参数解释：

桶名。

约束限制：

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

默认取值：

无

Agency

string

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

参数解释：

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

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

约束限制：

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

默认取值：

无

LoggingEnabled

LoggingEnabled

可选

参数解释：

日志配置信息，详见LoggingEnabled。
表3 LoggingEnabled

参数名称

参数类型

是否必选

描述

TargetBucket

string

设置logging时必选。

关闭logging时勿选。

参数解释：

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

约束限制：

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

默认取值：

无

TargetPrefix

string

设置logging时必选。

关闭logging时勿选。

参数解释：

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

取值范围：

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

默认取值：

无

TargetGrants

Grant

可选

参数解释：

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

参数名称

参数类型

是否必选

描述

Grantee

Grantee

作为请求参数时必选

参数解释：

被授权用户相关信息，详见Grantee。

Permission

PermissionType

作为请求参数时必选

参数解释：

被授予的权限。

取值范围：

权限取值范围：详见PermissionType。

默认取值：

无
表5 Grantee

参数名称

参数类型

是否必选

描述

Type

GranteeType

作为请求参数时必选

参数解释：

被授权用户的类型。

取值范围：

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

默认取值：

无

ID

string

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

参数解释：

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

取值范围：

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

默认取值：

无

Name

string

作为请求参数时可选

参数解释：

被授权用户的账号名。

约束限制：

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

默认取值：

无

URI

GroupUriType

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

参数解释：

被授权的用户组。

取值范围：

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

默认取值：

无
表6 GranteeType

常量名

原始值

说明

GROUP

Group

授权给用户组。

CANONICAL_USER

CanonicalUser

授权给单个用户。
表7 GroupUriType

常量名

原始值

说明

ALL_USERS

AllUsers

所有用户。

AUTHENTICATED_USERS

AuthenticatedUsers

授权用户，已废弃。

LOG_DELIVERY

LogDelivery

日志投递组，已废弃。
表8 PermissionType

常量名

原始值

说明

READ

READ

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

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

WRITE

WRITE

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

此权限在对象上不适用。

READ_ACP

READ_ACP

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

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

WRITE_ACP

WRITE_ACP

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

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

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

FULL_CONTROL

FULL_CONTROL

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

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

返回结果

表9 返回结果

参数类型

描述

Response

说明：

该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。

参数解释：

接口返回信息，详见Response。
表10 Response

参数名称

参数类型

描述

CommonMsg

ICommonMsg

参数解释：

接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。

InterfaceResult

BaseResponseOutput

参数解释：

操作成功后的结果数据，详见BaseResponseOutput。

约束限制：

当Status大于300时为空。
表11 ICommonMsg

参数名称

参数类型

描述

Status

number

参数解释：

OBS服务端返回的HTTP状态码。

取值范围：

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

Code

string

参数解释：

OBS服务端返回的错误码。

Message

string

参数解释：

OBS服务端返回的错误描述。

HostId

string

参数解释：

OBS服务端返回的请求服务端ID。

RequestId

string

参数解释：

OBS服务端返回的请求ID。

Id2

string

参数解释：

OBS服务端返回的请求ID2。

Indicator

string

参数解释：

OBS服务端返回的详细错误码。
表12 BaseResponseOutput

参数名称

参数类型

描述

RequestId

string

参数解释：

OBS服务端返回的请求ID。

代码示例

本示例用于设置名为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
43
44
45
46
47
48
49
50
51
52
53
54
55
 
// 引入依赖包
import ObsClient, { GranteeType, PermissionType, StorageClassType, SetBucketLoggingInput } from '@obs/esdk-obs-harmony';

// 创建ObsClient实例
const obsClient = new ObsClient({
  // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
  // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
  AccessKeyId: process.env.ACCESS_KEY_ID,
  SecretAccessKey: process.env.SECRET_ACCESS_KEY,
  // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入
  // SecurityToken: process.env.SECURITY_TOKEN,
  // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写
  Server: "https://obs.cn-north-4.myhuaweicloud.com",
});

async function setBucketLogging() {
    try {
        const params: SetBucketLoggingInput = {
            // 指定存储桶名称
            Bucket: "examplebucket",
            // 指定委托的名称，此处以 obs_test_agency 为例
            Agency: 'obs_test_agency',
            LoggingEnabled: {
                //  指定用于存放产生的日志文件的桶名，此处以 TargetBucketname 为例
                TargetBucket: 'TargetBucketname',
                // 指定用于生成的日志文件的名称前缀，此处以 TargetPrefixtest/ 为例
                TargetPrefix: 'TargetPrefixtest/',
                // 指定被授权用户权限信息列表
                TargetGrants: [
                    // 指定特定用户拥有公共写的权限，此处用户ID为0a03f5833900d3730f13c00f49d5exxx
                    { Grantee: { Type: GranteeType.CANONICAL_USER, ID: '0a03f5833900d3730f13c00f49d5exxx' }, Permission: PermissionType.WRITE },
                    // 指定所有用户拥有公共读的权限
                    { Grantee: { Type: GranteeType.GROUP, URI: GroupUriType.ALL_USERS }, Permission: PermissionType.READ }
                ]
            }
        };
        // 设置桶的访问日志配置
        const result = await obsClient.setBucketLogging(params);
        if (result.CommonMsg.Status <= 300) {
            console.log("Set bucket(%s)'s logging configuraion successful!", params.Bucket);
            console.log("RequestId: %s", result.CommonMsg.RequestId);
            return;
        }
        console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
        console.log("Status: %d", result.CommonMsg.Status);
        console.log("Code: %s", result.CommonMsg.Code);
        console.log("Message: %s", result.CommonMsg.Message);
        console.log("RequestId: %s", result.CommonMsg.RequestId);
    } catch (error) {
        console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.");
        console.log(error);
    }
}

setBucketLogging();

相关链接

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

相关文档