通用配置

了解如何配置 SDK,如日志、重试、服务访问端点(公有云、专有云)等。

配置项清单

配置 类型 描述
region str (必填)服务所在地域,可参考 地域和可用区列表
project_id str (选填)项目的唯一标识,用于组织资源,大多数资源都需要 ProjectId,如果是主账号或财务账号,默认值为默认 ProjectId,如果是子账号非财务账号,则该字段必须填写。
base_url str (选填) API 服务的访问端点,默认是 https://api.ucloud.cn
user_agent str (选填)UserAgent 是 SDK 客户端特有的属性,用于区分使用 SDK 的版本。User-Agent 的定义请参考 MDN。用户自定义的 UserAgent 将追加到 SDK 版本号的末尾。例如, “MyAPP/0.10.1” → “Python/3.7.0 Python-SDK/0.1.0 MyAPP/0.10.1”
timeout int (选填)请求超时时间,默认 30s
max_retries int (选填)最大重试次数. 默认重试 3 次。设置该值大于 0 将对网络和服务可用性问题进行自动重试,使用指数退避的重试间隔,并自动跳过资源创建类的接口。
log_level int (选填)日志级别,可参考标准库 logging 的级别定义,默认是 INFO

进阶配置选项

修改默认日志

关闭日志:

snippet.python
import logging
 
logger = logging.getLogger("ucloud")
 
# 直接禁用 logger
logger.disabled = True
 
# 或者提高日志打印级别,仅打印 WARNING 及以上的日志
logger.setLevel(logging.WARN)

访问专有云/渠道云或其它网关

snippet.python
from ucloud.client import Client
 
client = Client(
    {
        "region": "专有云地域", # 替换成专有地域
        "base_url": "foo.api.ucloud.cn", # 替换成专有云网关
        "project_id": "...",
        "public_key": "...",
        "private_key": "...",
    }
)