Python访问跟踪

更新时间:2025-03-07 06:29:09

本文介绍如何使用Python SDK V2配置存储空间(Bucket)的访问跟踪功能。

注意事项

  • 本文示例代码以华东1(杭州)的地域IDcn-hangzhou为例,默认使用外网Endpoint,如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的RegionEndpoint的对应关系,请参见OSS地域和访问域名

方法定义

开启访问跟踪

put_bucket_access_monitor(request: PutBucketAccessMonitorRequest, **kwargs) → PutBucketAccessMonitorResult

查看访问跟踪状态

get_bucket_access_monitor(request: GetBucketAccessMonitorRequest, **kwargs) → GetBucketAccessMonitorResult

请求参数列表

参数名

类型

说明

参数名

类型

说明

request

PutBucketAccessMonitorRequest

设置请求参数,具体请参见PutBucketAccessMonitorRequest

GetBucketAccessMonitorRequest

设置请求参数,具体请参见GetBucketAccessMonitorRequest

返回值列表

类型

说明

类型

说明

PutBucketAccessMonitorResult

返回值,具体请参见PutBucketAccessMonitorResult

GetBucketAccessMonitorResult

返回值,具体请参见GetBucketAccessMonitorResult

关于开启访问跟踪的完整定义,请参见put_bucket_access_monitor

关于查看访问跟踪状态的完整定义,请参见get_bucket_access_monitor

示例代码

开启访问跟踪

以下代码用于为Bucket开启访问跟踪:

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器,并描述脚本用途:设置存储空间访问跟踪状态
parser = argparse.ArgumentParser(description="put bucket access monitor sample")

# 定义命令行参数,包括必需的区域、存储空间名称、endpoint以及访问跟踪状态
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--status', help='The access tracking status of the bucket. Valid values: Enabled, Disabled.', required=True)

def main():
    # 解析命令行参数,获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问凭证信息,用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK默认配置创建配置对象,并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 设置配置对象的区域属性,根据用户提供的命令行参数
    cfg.region = args.region

    # 如果提供了自定义endpoint,则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端,准备与OSS交互
    client = oss.Client(cfg)

    # 发送请求以配置指定存储空间的访问跟踪状态
    result = client.put_bucket_access_monitor(oss.PutBucketAccessMonitorRequest(
            bucket=args.bucket,  # 存储空间名
            access_monitor_configuration=oss.AccessMonitorConfiguration(
                status=args.status,  # 设置新的访问跟踪状态
            ),
    ))

    # 打印操作结果的状态码和请求ID,以便确认请求状态
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id}')

# 当此脚本被直接执行时,调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点,控制程序流程从这里开始

查看访问跟踪状态

以下代码用于查看Bucket的访问跟踪状态:

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器,并描述脚本用途:获取存储空间访问跟踪状态
parser = argparse.ArgumentParser(description="get bucket access monitor sample")

# 定义命令行参数,包括必需的区域、存储空间名称以及可选的endpoint
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')

def main():
    # 解析命令行参数,获取用户输入的值
    args = parser.parse_args()

    # 从环境变量中加载访问凭证信息,用于身份验证
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK默认配置创建配置对象,并设置认证提供者
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider

    # 设置配置对象的区域属性,根据用户提供的命令行参数
    cfg.region = args.region

    # 如果提供了自定义endpoint,则更新配置对象中的endpoint属性
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 使用上述配置初始化OSS客户端,准备与OSS交互
    client = oss.Client(cfg)

    # 执行请求以获取指定存储空间的访问跟踪状态
    result = client.get_bucket_access_monitor(oss.GetBucketAccessMonitorRequest(
            bucket=args.bucket,  # 存储空间名
    ))

    # 打印操作结果的状态码、请求ID和访问跟踪状态
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' status: {result.access_monitor_configuration.status},'
    )

# 当此脚本被直接执行时,调用main函数开始处理逻辑
if __name__ == "__main__":
    main()  # 脚本入口点,控制程序流程从这里开始

相关文档

  • 本页导读 (1)
  • 注意事项
  • 方法定义
  • 示例代码
  • 开启访问跟踪
  • 查看访问跟踪状态
  • 相关文档