tencent cloud

文档反馈

日志管理

最后更新时间:2024-01-22 11:23:32

    简介

    本文档提供关于日志管理的 API 概览以及 SDK 示例代码。
    API
    操作名
    操作描述
    设置日志管理
    为源存储桶开启日志记录
    查询日志管理
    查询源存储桶的日志配置信息

    设置日志管理

    功能说明

    PUT Bucket Logging 用于为源存储桶开启日志记录,将源存储桶的访问日志保存到指定的目标存储桶中。
    只有源存储桶拥有者才可进行该请求操作。

    请求示例

    示例1:设置将源存储桶sourcebucket-1250000000的日志信息投递到目标存储桶targetbucket-1250000000bucket-logging-prefix/路径下。
    cos.putBucketLogging({
    Bucket: 'sourcebucket-1250000000', /* 必须 */
    Region: 'ap-beijing', /* 必须 */
    BucketLoggingStatus: { /* 必须 */
    LoggingEnabled: {
    TargetBucket: 'targetbucket-1250000000',
    TargetPrefix: 'bucket-logging-prefix/'
    }
    }
    }, function(err, data) {
    console.log(err || data);
    });
    示例2:关闭目标存储桶sourcebucket-1250000000的日志投递。
    cos.putBucketLogging({
    Bucket: 'sourcebucket-1250000000', /* 必须 */
    Region: 'ap-beijing', /* 必须 */
    BucketLoggingStatus: {} /* 必须 */
    }, function(err, data) {
    console.log(err || data);
    });

    参数说明

    参数名称
    描述
    类型
    是否必填
    Bucket
    设置日志管理的存储桶,格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
    String
    Region
    存储桶所在地域,枚举值请参见 地域和访问域名
    String
    BucketLoggingStatus
    说明日志记录配置的状态,如果为空字符串则意为关闭日志记录
    Object
    - LoggingEnabled
    存储桶 logging 设置的具体信息,主要是目标存储桶
    Object
    - - TargetBucket
    存放日志的目标存储桶,可以是同一个存储桶(但不推荐),或同一账户下、同一地域的存储桶
    String
    - - TargetPrefix
    日志存放在目标存储桶的指定路径
    String

    回调函数说明

    function(err, data) { ... }
    参数名称
    描述
    类型
    err
    请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档
    Object
    - statusCode
    请求返回的 HTTP 状态码,例如200、403、404等
    Number
    - headers
    请求返回的头部信息
    Object
    data
    请求成功时返回的对象,如果请求发生错误,则为空
    Object
    - statusCode
    请求返回的 HTTP 状态码,例如200、403、404等
    Number
    - headers
    请求返回的头部信息
    Object

    查询日志管理

    功能说明

    GET Bucket logging 用于查询源存储桶的日志配置信息。
    只有源存储桶拥有者才可进行该请求操作。

    请求示例

    cos.getBucketLogging({
    Bucket: 'sourcebucket-1250000000', /* 必须 */
    Region: 'ap-beijing' /* 必须 */
    }, function(err, data) {
    console.log(err || data);
    });

    返回示例

    {
    "BucketLoggingStatus": {
    "LoggingEnabled": {
    "TargetBucket": "targetbucket-1250000000",
    "TargetPrefix": "bucket-logging-prefix/"
    }
    },
    "statusCode": 200,
    "headers": {}
    }

    参数说明

    参数名称
    描述
    类型
    是否必填
    Bucket
    查询日志管理的存储桶,格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
    String
    Region
    存储桶所在地域,枚举值请参见 地域和访问域名
    String

    回调函数说明

    function(err, data) { ... }
    参数名称
    描述
    类型
    err
    请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档
    Object
    - statusCode
    请求返回的 HTTP 状态码,例如200、403、404等
    Number
    - headers
    请求返回的头部信息
    Object
    data
    请求成功时返回的对象,如果请求发生错误则为空
    Object
    - statusCode
    请求返回的 HTTP 状态码,例如200、403、404等
    Number
    - headers
    请求返回的头部信息
    Object
    - BucketLoggingStatus
    说明日志记录配置的状态,如果为空字符串则意为关闭日志记录
    Object/String
    - - LoggingEnabled
    存储桶 logging 设置的具体信息,主要是目标存储桶
    Object
    - - - TargetBucket
    存放日志的目标存储桶,可以是同一个存储桶(但不推荐),或同一账户下、同一地域的存储桶
    String
    - - - TargetPrefix
    日志存放在目标存储桶的指定路径
    String
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持