控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

日志管理

最近更新时间:2020-12-03 10:04:21

简介

本文档提供关于日志管理的 API 概览以及 SDK 示例代码。

API 操作名 操作描述
PUT Bucket logging 设置日志管理 为源存储桶开启日志记录
GET Bucket logging 查询日志管理 查询源存储桶的日志配置信息

设置日志管理

功能说明

PUT Bucket logging 用于为源存储桶开启日志记录,将源存储桶的访问日志保存到指定的目标存储桶中。

方法原型

public void setBucketLoggingConfiguration(SetBucketLoggingConfigurationRequest setBucketLoggingConfigurationRequest);

请求示例

String bucketName = "examplebucket-1250000000";
BucketLoggingConfiguration bucketLoggingConfiguration = new BucketLoggingConfiguration();
bucketLoggingConfiguration.setDestinationBucketName(bucketName);
bucketLoggingConfiguration.setLogFilePrefix("logs");
SetBucketLoggingConfigurationRequest setBucketLoggingConfigurationRequest = new SetBucketLoggingConfigurationRequest(bucketName, bucketLoggingConfiguration);
cosClient.setBucketLoggingConfiguration(setBucketLoggingConfigurationRequest);

参数说明

参数名称 描述 类型
setBucketLoggingConfigurationRequest 开启日志功能请求 SetBucketLoggingConfigurationRequest

Request 成员说明 :

Request 成员 设置方法 描述 类型
bucketName 构造函数或 set 方法 开启日志功能的源存储桶名称,命名格式为 BucketName-APPID ,详情请参见 命名规范 String
loggingConfiguration 构造函数或 set 方法 存储桶的日志功能配置 BucketLoggingConfiguration

BucketLoggingConfiguration 成员说明:

参数名称 描述 类型
destinationBucketName 存放日志的目标存储桶名称,命名格式为 BucketName-APPID ,详情请参见 命名规范 String
logFilePrefix 日志存放在目标存储桶的指定路径 String

返回结果说明

  • 成功:无返回值。
  • 失败:发生错误(如身份认证失败),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

查询日志管理

功能说明

GET Bucket logging 用于查询指定存储桶的日志配置信息。

方法原型

public BucketLoggingConfiguration getBucketLoggingConfiguration(String bucketName);

请求示例

String bucketName = "examplebucket-1250000000";
BucketLoggingConfiguration bucketLoggingConfiguration = cosClient.getBucketLoggingConfiguration(bucketName);

参数说明

参数名称 描述 类型
bucketName 存放日志的目标存储桶,格式为 BucketName-APPID ,详情请参见 命名规范 String

返回结果说明

  • 成功:返回 BucketLoggingConfiguration,包含存放日志的目标存储桶名称、日志存放在目标存储桶的指定路径。
  • 失败:发生错误(如身份认证失败),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理
目录