华为云对象存储OBS设置桶日志规则(Java SDK)_云淘科技

华为云云存储

12 月 27, 2023

171 0

功能说明

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

开发过程中，您有任何问题可以在github上提交issue，或者在华为云对象存储服务论坛中发帖求助。

接口约束

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

方法定义

obsClient.setBucketLogging(final SetBucketLoggingRequest request)

请求参数说明

表1 请求参数列表
参数名称	参数类型	是否必选	描述
request	SetBucketLoggingRequest	必选	参数解释：设置桶日志请求参数，详见SetBucketLoggingRequest。

表2 SetBucketLoggingRequest
参数名称	参数类型	是否必选	描述
bucketName	String	必选	参数解释：产生日志的桶名称。约束限制：桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。默认取值：无
loggingConfiguration	BucketLoggingConfiguration	必选	参数解释：桶日志配置，详见BucketLoggingConfiguration。

表3 BucketLoggingConfiguration
参数名称	参数类型	是否必选	描述
agency	String	如果是设置桶日志配置则必选	参数解释：目标桶（存放日志文件的桶）的所有者通过统一身份认证服务（IAM）创建对OBS云服务委托的名称。可以选择账号下已有的IAM委托，也可以创建一个新的委托。创建委托参见创建IAM委托。约束限制：默认情况下，在为委托配置权限时只需设置日志存储桶的上传对象（PutObject）权限。如果日志存储桶开启了默认加密功能，还需要委托同时具有日志存储桶所在区域的KMS Administrator权限。默认取值：无
targetBucketName	String	可选	参数解释：日志存储桶的桶名，该桶用于存放日志文件。约束限制：需要和开启日志功能的桶在同一个region中。桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。禁止使用IP地址。禁止以“-”或“.”开头及结尾。禁止两个“.”相邻（如：“my..bucket”）。禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。默认取值：无
logfilePrefix	String	可选	参数解释：日志文件对象的对象名前缀，设置后日志文件对象将携带统一前缀存储在日志存储桶中。取值范围：长度大于0且不超过1024的字符串。默认取值：无
targetGrantsList	List	可选	参数解释：被授权用户的权限信息列表，定义哪些用户可以针对日志文件进行哪些访问操作，详见GrantAndPermission。

表4 GrantAndPermission
参数名称	参数类型	是否必选	描述
grantee	GranteeInterface	必选	参数解释：被授权用户或用户组，详见GranteeInterface。
permission	Permission	必选	参数解释：用户或用户组被授予的权限。取值范围：详见Permission。默认取值：无
delivered	boolean	可选	参数解释：桶的ACL是否向桶内对象传递，作用于桶内所有对象。取值范围： true：是，桶ACL向桶内对象传递。 false：否，桶ACL不向桶内对象传递，仅作用于桶。默认取值： false

表5 GranteeInterface
参数名称	参数类型	是否必选	描述
CanonicalGrantee	CanonicalGrantee	必选	参数解释：被授权用户的用户信息，详见CanonicalGrantee。
GroupGrantee	GroupGrantee	必选	参数解释：被授权用户组的用户组信息。取值范围：详见GroupGrantee。默认取值：无

表6 CanonicalGrantee
参数名称	参数类型	是否必选	描述
grantId	String	如果Type为用户类型则必选	参数解释：被授权用户的账号ID，即domain_id。取值范围：如何获取账号ID请参见如何获取账号ID和用户ID?。默认取值：无
displayName	String	可选	参数描述：被授权用户的账号名。取值范围：如何获取账号名请参见如何获取账号名?。默认取值：无

表7 GroupGrantee
常量名	说明
ALL_USERS	所有用户。
AUTHENTICATED_USERS	授权用户，已废弃。
LOG_DELIVERY	日志投递组，已废弃。

表8 Permission
常量名	原始值	说明
PERMISSION_READ	READ	读权限。若有桶的读权限，则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。若有对象的读权限，则可以获取该对象内容和元数据。
PERMISSION_WRITE	WRITE	写权限。若有桶的写权限，则可以上传、覆盖和删除该桶内任何对象和段。此权限在对象上不适用。
PERMISSION_READ_ACP	READ_ACP	读取ACL配置的权限。若有读ACP的权限，则可以获取对应的桶或对象的权限控制列表（ACL）。桶或对象的所有者永远拥有读对应桶或对象ACP的权限。
PERMISSION_WRITE_ACP	WRITE_ACP	修改ACL配置的权限。若有写ACP的权限，则可以更新对应桶或对象的权限控制列表（ACL）。桶或对象的所有者永远拥有写对应桶或对象的ACP的权限。拥有了写ACP的权限，由于可以更改权限控制策略，实际上意味着拥有了完全访问的权限。
PERMISSION_FULL_CONTROL	FULL_CONTROL	完全控制权限，包括对桶或对象的读写权限，以及对桶或对象ACL配置的读写权限。若有桶的完全控制权限意味着拥有READ、WRITE、READ_ACP和WRITE_ACP的权限。若有对象的完全控制权限意味着拥有READ、READ_ACP和WRITE_ACP的权限。

返回结果说明

表9 返回结果HeaderResponse(SDK公共响应结果)各项属性说明
参数名称	参数类型	描述
statusCode	int	参数解释： HTTP状态码。取值范围：状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。默认取值：无
responseHeaders	Map	参数解释： HTTP响应消息头列表，由多个元组构成。元组中String代表响应消息头的名称，Object代表响应消息头的值。默认取值：无

代码示例：开启桶日志

本示例用于设置examplebucket桶的日志管理配置，委托名称为your agency，生成以targetprefix为前缀的日志文件，并将此日志存放在targetbucketname桶内。

import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.BucketLoggingConfiguration;
public class SetBucketLogging001 {
    public static void main(String[] args) {
        // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。
        // 您可以登录访问管理控制台获取访问密钥AK/SK
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。
        // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken，也可以使用其他外部引入方式传入。
        // String securityToken = System.getenv("SECURITY_TOKEN");
        // endpoint填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。
        String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
        // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。
        //String endPoint = System.getenv("ENDPOINT");
        
        // 创建ObsClient实例
        // 使用永久AK/SK初始化客户端
        ObsClient obsClient = new ObsClient(ak, sk,endPoint);
        // 使用临时AK/SK和SecurityToken初始化客户端
        // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);

        try {
            // 开启桶日志
            BucketLoggingConfiguration config = new BucketLoggingConfiguration();
            // 设置委托名字，需要到统一身份认证服务（IAM）创建委托
            config.setAgency("your agency");
            config.setTargetBucketName("targetbucketname");
            config.setLogfilePrefix("targetprefix");
            obsClient.setBucketLogging("examplebucket", config);
            System.out.println("setBucketLogging successfully");
        } catch (ObsException e) {
            System.out.println("setBucketLogging failed");
            // 请求失败,打印http状态码
            System.out.println("HTTP Code:" + e.getResponseCode());
            // 请求失败,打印服务端错误码
            System.out.println("Error Code:" + e.getErrorCode());
            // 请求失败,打印详细错误信息
            System.out.println("Error Message:" + e.getErrorMessage());
            // 请求失败,打印请求id
            System.out.println("Request ID:" + e.getErrorRequestId());
            System.out.println("Host ID:" + e.getErrorHostId());
            e.printStackTrace();
        } catch (Exception e) {
            System.out.println("setBucketLogging failed");
            // 其他异常信息打印
            e.printStackTrace();
        }
    }
}

代码示例：为日志对象设置读权限

本示例用于设置examplebucket桶的日志管理配置，委托名称为your agency，生成以prefix为前缀的日志文件，将此日志存放在targetbucketname桶内，并为所有用户设置日志对象的读权限。

import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.BucketLoggingConfiguration;
import com.obs.services.model.GrantAndPermission;
import com.obs.services.model.GroupGrantee;
import com.obs.services.model.Permission;
public class SetBucketLogging002
{
    public static void main(String[] args) {
        // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。
        // 您可以登录访问管理控制台获取访问密钥AK/SK
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。
        // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken，也可以使用其他外部引入方式传入。
        // String securityToken = System.getenv("SECURITY_TOKEN");
        // endpoint填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。
        String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
        // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。
        //String endPoint = System.getenv("ENDPOINT");
        
        // 创建ObsClient实例
        // 使用永久AK/SK初始化客户端
        ObsClient obsClient = new ObsClient(ak, sk,endPoint);
        // 使用临时AK/SK和SecurityToken初始化客户端
        // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);

        try {
            // 为日志对象设置权限
            String targetBucket = "targetbucketname";
            // 设置桶的日志配置
            BucketLoggingConfiguration config = new BucketLoggingConfiguration();
            // 设置委托名字，需要到统一身份认证服务（IAM）创建委托
            config.setAgency("your agency");
            config.setTargetBucketName(targetBucket);
            config.setLogfilePrefix("prefix");
            // 为所有用户设置对日志对象的读权限
            GrantAndPermission grant1 = new GrantAndPermission(GroupGrantee.ALL_USERS, Permission.PERMISSION_READ);
            config.setTargetGrants(new GrantAndPermission[]{grant1});
            obsClient.setBucketLogging("examplebucket", config);
            System.out.println("setBucketLogging successfully");
        } catch (ObsException e) {
            System.out.println("setBucketLogging failed");
            // 请求失败,打印http状态码
            System.out.println("HTTP Code:" + e.getResponseCode());
            // 请求失败,打印服务端错误码
            System.out.println("Error Code:" + e.getErrorCode());
            // 请求失败,打印详细错误信息
            System.out.println("Error Message:" + e.getErrorMessage());
            // 请求失败,打印请求id
            System.out.println("Request ID:" + e.getErrorRequestId());
            System.out.println("Host ID:" + e.getErrorHostId());
            e.printStackTrace();
        } catch (Exception e) {
            System.out.println("setBucketLogging failed");
            // 其他异常信息打印
            e.printStackTrace();
        }
    }
}

代码示例：关闭桶日志功能

关闭桶日志功能实际上就是调用ObsClient.setBucketLogging将examplebucket桶的日志配置清空，以下代码展示了如何关闭桶日志。

import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.BucketLoggingConfiguration;
public class SetBucketLogging003
{
    public static void main(String[] args) {
        // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。
        // 您可以登录访问管理控制台获取访问密钥AK/SK
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。
        // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken，也可以使用其他外部引入方式传入。
        // String securityToken = System.getenv("SECURITY_TOKEN");
        // endpoint填写桶所在的endpoint, 此处以华北-北京四为例，其他地区请按实际情况填写。
        String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
        // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。
        //String endPoint = System.getenv("ENDPOINT");
        
        // 创建ObsClient实例
        // 使用永久AK/SK初始化客户端
        ObsClient obsClient = new ObsClient(ak, sk,endPoint);
        // 使用临时AK/SK和SecurityToken初始化客户端
        // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);

        try {
            // 对桶设置空的日志配置来关闭桶日志
            obsClient.setBucketLogging("examplebucket", new BucketLoggingConfiguration());
            System.out.println("setBucketLogging successfully");
        } catch (ObsException e) {
            System.out.println("setBucketLogging failed");
            // 请求失败,打印http状态码
            System.out.println("HTTP Code:" + e.getResponseCode());
            // 请求失败,打印服务端错误码
            System.out.println("Error Code:" + e.getErrorCode());
            // 请求失败,打印详细错误信息
            System.out.println("Error Message:" + e.getErrorMessage());
            // 请求失败,打印请求id
            System.out.println("Request ID:" + e.getErrorRequestId());
            System.out.println("Host ID:" + e.getErrorHostId());
            e.printStackTrace();
        } catch (Exception e) {
            System.out.println("setBucketLogging failed");
            // 其他异常信息打印
            e.printStackTrace();
        }
    }
}