更新时间:2026-10-30 GMT+08:00
分享

设置桶日志分析配置(Java SDK)

功能介绍

该接口用于为存储桶开启日志分析功能。开启后,对象存储服务会将访问日志实时推送到日志服务(LTS),用户可以在日志服务中进行日志查询和分析。

接口约束

  • 每个桶只能绑定一个日志流,并且归属是桶owner的日志服务。
  • 请求者必须是桶owner或桶owner下的子用户,并且需要给请求者授权LTS云日志服务lts:logStream:listLogStream的权限。
  • 您必须是桶拥有者或拥有设置桶日志分析配置的权限,才能设置桶日志分析配置。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:PutBucketRealTimeLog权限,如果使用桶策略则需授予PutBucketRealTimeLog权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
  • OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。

方法定义

ObsClient.setBucketRealTimeLog(SetBucketRealTimeLogRequest request)

请求参数说明

表1 SetBucketRealTimeLogRequest

参数名称

参数类型

是否必选

描述

bucketName

String

必选

参数解释:

桶名。

约束限制:

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

取值范围:

无

默认取值:

无

realTimeLogConfiguration

表2 BucketRealTimeLogConfiguration

可选

参数解释:

实时日志配置。

取值范围:

表2 BucketRealTimeLogConfiguration

默认取值:

无

表2 BucketRealTimeLogConfiguration

参数名称

参数类型

是否必选

描述

logGroupId

String

必选

参数解释:

日志组ID,用于指定日志推送的目标日志组。

约束限制:

需为有效的LTS日志组ID。

取值范围:

无

默认取值:

无

logStreamId

String

必选

参数解释:

日志流ID,用于指定日志推送的目标日志流。

约束限制:

需为有效的LTS日志流ID。

取值范围:

无

默认取值:

无

projectId

String

必选

参数解释:

项目ID,日志组和日志流归属的项目ID。

约束限制:

需为有效的项目ID。

取值范围:

无

默认取值:

无

返回结果说明

类型

说明

HeaderResponse

参数解释:

SDK公共结果对象。

表3 返回结果HeaderResponse(SDK公共响应结果)各项属性说明

参数名称

参数类型

描述

statusCode

int

参数解释:

HTTP状态码。

取值范围:

状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。

完整的状态码列表请参见状态码。

默认取值:

无

responseHeaders

Map<String, Object>

参数解释:

HTTP响应消息头列表,由多个元组构成。元组中String代表响应消息头的名称,Object代表响应消息头的值。

默认取值:

无

代码示例

本示例用于设置examplebucket桶的日志分析配置。

import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.realtimelog.BucketRealTimeLogConfiguration;
import com.obs.services.model.realtimelog.SetBucketRealTimeLogRequest;
public class SetBucketRealTimeLog001 {
    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 exampleBucket = "examplebucket";
            // 日志组ID,指定日志推送的目标日志组
            String logGroupId = "your_log_group_id";
            // 日志流ID,指定日志推送的目标日志流
            String logStreamId = "your_log_stream_id";
            // 项目ID,日志组和日志流所属的项目ID
            String projectId = "your_project_id";
            BucketRealTimeLogConfiguration config =
                new BucketRealTimeLogConfiguration(logGroupId, logStreamId, projectId);
            SetBucketRealTimeLogRequest request =
                new SetBucketRealTimeLogRequest(exampleBucket, config);
            obsClient.setBucketRealTimeLog(request);
            System.out.println("setBucketRealTimeLog successfully");
        } catch (ObsException e) {
            System.out.println("setBucketRealTimeLog 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("setBucketRealTimeLog failed");
            // 其他异常信息打印
            e.printStackTrace();
        }
    }
}

相关文档