对象存储服务 OBS-OBS客户端初始化(Python SDK):构造函数参数描述

时间:2024-05-22 15:05:44

构造函数参数描述

参数

描述

建议值

access_key_id

访问密钥中的AK。默认为空字符串表示匿名用户。

N/A

secret_access_key

访问密钥中的SK。默认为空字符串表示匿名用户。

N/A

security_token

临时访问密钥中的SecurityToken。

如何获取临时访问密钥和securitytoken请参见临时访问密钥AK/SK获取;

N/A

server

连接OBS的服务地址。可包含协议类型、域名、端口号。示例:https://your-endpoint:443。(出于安全性考虑,建议使用https协议)

N/A

max_retry_count

HTTP/HTTPS连接异常时的请求重试次数。默认为3次。

[1,5]

max_redirect_count

HTTP/HTTPS请求重定向的最大次数。默认为10次

[1, 10]

timeout

HTTP/HTTPS请求超时时间(单位:秒)。默认为60秒。

[10, 60]

ssl_verify

验证服务端证书参数,即验证服务端证书与客户端证书配置的证书是否一致。可能的取值:

  • 服务端pem格式根证书文件路径。
  • True:从操作系统根证书库中获取服务端证书列表并验证服务端证书(仅支持Windows操作系统)。
  • False:表示不验证服务端证书。

默认为False。

N/A

chunk_size

读写socket流时的块大小(单位:字节),您可以根据自身需求设置块大小。默认为65536字节。

默认

long_conn_mode

是否启用长连接模式。默认为False。

N/A

proxy_host

代理服务器的主机地址。默认为空。

说明:

请注意,代理服务器的主机地址不要指定http://或https://;

N/A

proxy_port

代理服务器的端口号。默认为空。

N/A

proxy_username

连接代理服务器时使用的用户名。默认为空。

N/A

proxy_password

连接代理服务器时使用的用户密码。默认为空。

N/A

is_cname

是否通过自定义域名访问OBS服务。默认为False。

更多关于自定义域名相关信息请参见自定义域名

N/A

security_providers

指定允许的访问密钥搜索方式,OBS客户端将使用该参数指定的搜索方式,搜索并获取访问密钥。默认为None。

说明:

security_providers参数必须采用列表形式,默认情况下security_providers为None,此时默认提供从环境变量中获取访问密钥,或从ECS服务器获取临时访问密钥两种方式作为security_providers的默认搜索方式。

当指定了security_providers参数时,则不会提供默认搜索方式,此时仅可以使用security_providers中提供的搜索方式。

N/A

security_provider_policy

指定访问密钥搜索策略。默认为None。

说明:
  • security_provider_policy参数用于设置搜索策略,默认为None,此时需要显示指定访问密钥;同时,在已经指定了访问密钥参数的情况下,security_provider_policy参数将被忽略。
  • security_provider_policy设置为OBS_DEFAULT时采用链式搜索方式获取访问密钥;
  • 设置security_provider_policy为预定义方式名(ENV,ECS)时采用对应方式获取访问密钥。

N/A

  • 建议值为N/A的表示需要根据实际情况进行设置。
  • 如网络状况不佳,建议增大timeout的值。
  • 如果设置的server不带协议类型,则默认使用HTTPS协议。
  • 如果启用了长连接模式,使用完OBS客户端后必须调用ObsClient.close方法显式关闭,回收连接资源。
  • 出于DNS解析性能和OBS服务可靠性的考虑,不允许将server设置为IP,必须使用域名访问OBS服务。
support.huaweicloud.com/sdk-python-devg-obs/obs_22_0601.html