Python查询Endpoint信息

更新时间:2025-03-14 08:17:55

本文介绍如何使用Python SDK V2查询所有支持地域或者指定地域对应的Endpoint信息,包括外网访问(IPv4)Endpoint、内网访问(经典网络或VPC网络)Endpoint和传输加速域名(全地域上传下载加速)Endpoint。

注意事项

  • 查询所有支持地域或者指定地域对应的Endpoint信息与OSS的地域支持情况相关,与您在该地域是否创建Bucket无关。

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

查询所有支持地域对应的Endpoint信息

以下代码用于查询所有支持地域对应的Endpoint信息。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器,并描述脚本用途:示例展示如何查询OSS支持的地域信息
parser = argparse.ArgumentParser(description="describe regions sample")

# 添加命令行参数 --region,表示存储空间所在的地域,必需参数
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
# 添加命令行参数 --bucket,表示要操作的存储空间名称,必需参数
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
# 添加命令行参数 --endpoint,表示其他服务可用来访问OSS的域名,非必需参数
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
# 添加命令行参数 --regions,表示地域信息,非必需参数
parser.add_argument('--regions', help='Regional information.')

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

    # 从环境变量中加载访问OSS所需的认证信息,用于身份验证
    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.describe_regions(oss.DescribeRegionsRequest(
        regions=args.regions,
    ))

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

    # 遍历并打印每个地域的详细信息
    for rg in result.region_info:
        print(f'region: {rg.region},'
              f' internet endpoint: {rg.internet_endpoint},'
              f' internal endpoint: {rg.internal_endpoint},'
              f' accelerate endpoint: {rg.accelerate_endpoint}'
        )

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

查询指定地域对应的Endpoint信息

以下代码用于查询指定地域对应的Endpoint信息。

import argparse
import alibabacloud_oss_v2 as oss

# 创建命令行参数解析器,并描述脚本用途:示例展示如何查询OSS支持的地域信息
parser = argparse.ArgumentParser(description="describe regions sample")

# 添加命令行参数 --region,表示存储空间所在的地域,必需参数
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
# 添加命令行参数 --bucket,表示要操作的存储空间名称,必需参数
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
# 添加命令行参数 --endpoint,表示其他服务可用来访问OSS的域名,非必需参数
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
# 添加命令行参数 --regions,表示地域信息,非必需参数
parser.add_argument('--regions', help='Regional information.')

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

    # 从环境变量中加载访问OSS所需的认证信息,用于身份验证
    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.describe_regions(oss.DescribeRegionsRequest(
        regions=args.regions, # 以华东1(杭州)为例,填写为oss-cn-hangzhou。其它Region请按实际情况填写
    ))

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

    # 遍历并打印每个地域的详细信息
    for rg in result.region_info:
        print(f'region: {rg.region},'
              f' internet endpoint: {rg.internet_endpoint},'
              f' internal endpoint: {rg.internal_endpoint},'
              f' accelerate endpoint: {rg.accelerate_endpoint}'
        )

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

相关文档

  • 关于查询地域对应Endpoint信息的API接口描述,请参见DescribeRegions

  • 本页导读 (1)
  • 注意事项
  • 查询所有支持地域对应的Endpoint信息
  • 查询指定地域对应的Endpoint信息
  • 相关文档