控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

日志管理

最近更新时间:2021-12-14 17:02:05

简介

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

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

设置日志管理

功能说明

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

方法原型

func (s *BucketService) PutLogging(ctx context.Context, opt *BucketPutLoggingOptions) (*Response, error)

请求示例

package main

import (
    "context"
    "github.com/tencentyun/cos-go-sdk-v5"
    "net/http"
    "net/url"
    "os"
)

func main() {
    // 存储桶名称,由bucketname-appid 组成,appid必须填入,可以在COS控制台查看存储桶名称。 https://console.cloud.tencent.com/cos5/bucket
    // 替换为用户的 region,存储桶region可以在COS控制台“存储桶概览”查看 https://console.cloud.tencent.com/ ,关于地域的详情见 https://cloud.tencent.com/document/product/436/6224 。
    u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
    b := &cos.BaseURL{BucketURL: u}
    client := cos.NewClient(b, &http.Client{
        Transport: &cos.AuthorizationTransport{
            // 通过环境变量获取密钥
            // 环境变量 SECRETID 表示用户的 SecretId,登录访问管理控制台查看密钥,https://console.cloud.tencent.com/cam/capi
            SecretID: os.Getenv("SECRETID"),
            // 环境变量 SECRETKEY 表示用户的 SecretKey,登录访问管理控制台查看密钥,https://console.cloud.tencent.com/cam/capi
            SecretKey: os.Getenv("SECRETKEY"),
        },
    })
    opt := &cos.BucketPutLoggingOptions{
        LoggingEnabled: &cos.BucketLoggingEnabled{
            TargetBucket: "TargetBucket-1250000000",
        },
    }
    _, err := client.Bucket.PutLogging(context.Background(), opt)
    if err != nil {
        // ERROR
    }
}

参数说明

type BucketLoggingEnabled struct {
    TargetBucket string 
    TargetPrefix string 
}

// BucketPutLoggingOptions is the options of PutBucketLogging
type BucketPutLoggingOptions struct {
    XMLName        xml.Name             
    LoggingEnabled *BucketLoggingEnabled 
}

参数名称 描述 类型
BucketPutLoggingOptions 日志管理配置参数 Struct
LoggingEnabled 日志管理配置 Struct
TargetBucket 存放日志的目标存储桶,可以是同一个存储桶(但不推荐),或同一账户下、同一地域的存储桶 String
TargetPrefix 日志存放在目标存储桶的指定路径 String

查询日志管理

功能说明

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

方法原型

func (s *BucketService) GetLogging(ctx context.Context) (*BucketGetLoggingResult, *Response, error)

请求示例

package main

import (
    "context"
    "fmt"
    "github.com/tencentyun/cos-go-sdk-v5"
    "net/http"
    "net/url"
    "os"
)

func main() {
    // 存储桶名称,由bucketname-appid 组成,appid必须填入,可以在COS控制台查看存储桶名称。 https://console.cloud.tencent.com/cos5/bucket
    // 替换为用户的 region,存储桶region可以在COS控制台“存储桶概览”查看 https://console.cloud.tencent.com/ ,关于地域的详情见 https://cloud.tencent.com/document/product/436/6224 。
    u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
    b := &cos.BaseURL{BucketURL: u}
    client := cos.NewClient(b, &http.Client{
        Transport: &cos.AuthorizationTransport{
            // 通过环境变量获取密钥
            // 环境变量 SECRETID 表示用户的 SecretId,登录访问管理控制台查看密钥,https://console.cloud.tencent.com/cam/capi
            SecretID: os.Getenv("SECRETID"),
            // 环境变量 SECRETKEY 表示用户的 SecretKey,登录访问管理控制台查看密钥,https://console.cloud.tencent.com/cam/capi
            SecretKey: os.Getenv("SECRETKEY"),
        },
    })
    v, _, err := client.Bucket.GetLogging(context.Background())
    if err != nil {
        // ERROR
    }
    fmt.Println(v)
}

返回结果说明

type BucketGetLoggingResult BucketPutLoggingOptions

参数名称 描述 类型
BucketGetLoggingResult 日志管理配置参数 Struct
LoggingEnabled 日志管理配置 Struct
TargetBucket 存放日志的目标存储桶,可以是同一个存储桶(但不推荐),或同一账户下、同一地域的存储桶 String
TargetPrefix 日志存放在目标存储桶的指定路径 String
目录