华为云用户手册

接口约束 您必须是桶拥有者或拥有删除对象的权限，才能删除对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:DeleteObject权限，如果使用桶策略则需授予DeleteObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 桶没有开启多版本控制功能时，已删除的对象不可恢复，请谨慎操作。

返回结果 表2 返回结果 类型 说明 GetResult 参数解释： SDK公共结果对象。 表3 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无 表4 GetResult.body GetResult.body类型 说明 DeleteObjectResponse 参数解释： 删除对象响应结果。详见DeleteObjectResponse。 表5 DeleteObjectResponse 参数名称 参数类型 描述 deleteMarker bool 参数解释： 标识删除的对象是否是删除标记。 取值范围： true：是删除标记。 false：不是删除标记。 默认取值： false versionId str 参数解释： 对象的版本号，用于删除指定版本号的对象。例如：G001117FCE89978B0000401205D5DC9。 取值范围： 长度为32的字符串。 默认取值： 无，如果不设置则默认删除最新版本的对象。

接口约束 您必须是桶拥有者或拥有获取桶日志管理配置的权限，才能获取桶日志管理配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketLogging权限，如果使用桶策略则需授予GetBucketLogging权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

请求参数说明 参数名称 参数类型 是否必选 描述 bucketName str 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无

返回结果说明 类型 说明 GetResult 参数解释： SDK公共结果对象。 表1 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无 GetResult.body类型 说明 Logging 参数解释： 日志配置信息。 表2 Logging 参数名称 参数类型 是否必选 描述 targetBucket str 作为请求参数时可选 参数解释： 日志存储桶的桶名，该桶用于存放日志文件。 约束限制： 需要和开启日志功能的桶在同一个region中。 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 targetPrefix str 作为请求参数时可选 参数解释： 日志文件对象的对象名前缀，设置后日志文件对象将携带统一前缀存储在日志存储桶中。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 targetGrants list of Grant 作为请求参数时可选 参数解释： 被授权用户权限信息列表，定义哪些用户可以针对日志文件进行哪些访问操作，详情参考Grant 默认取值： 无 agency str 作为请求参数时如果是设置桶日志配置则必选 参数解释： 目标桶（存放日志文件的桶）的所有者通过统一身份认证服务（IAM）创建的对OBS云服务的委托的名称。 可以选择账号下已有的IAM委托，也可以创建一个新的委托。创建委托参见创建IAM委托。 约束限制： 默认情况下，在为委托配置权限时只需设置日志存储桶的上传对象（PutObject）权限。如果日志存储桶开启了默认加密功能，还需要委托同时具有日志存储桶所在区域的KMS Administrator权限。 默认取值： 无 表3 Grant 参数名称 参数类型 描述 grantee Grantee 参数解释： 被授权用户，包括用户类型，账号ID，账号名和被授权用户组，详情参考Grantee 默认取值： 无 permission str 参数解释： 被授予的权限。 取值范围： 授权策略的取详情参考权限。 默认取值： 无 delivered bool 参数解释： 桶的ACL是否向桶内对象传递，作用于桶内所有对象。 取值范围： True：是，桶ACL向桶内对象传递。 False：否，桶ACL不向桶内对象传递，仅作用于桶。 默认取值： False 表4 Grantee 参数名称 参数类型 描述 grantee_id str 参数解释： 被授权用户的账号ID，即domain_id。 取值范围： 如何获取账号ID请参见如何获取账号ID和用户ID?(Python SDK) 默认取值： 无 grantee_name str 参数解释： 被授权用户的账号名。 约束限制： 不支持中文。 只能以字母开头。长度为6-32个字符。 只能包含英文字母、数字或特殊字符(-_)。 默认取值： 无 group str 参数解释： 被授权的用户组，详见用户组。 默认取值： 无 grantee_id与grantee_name配套使用，且与group互斥，即被授权用户可以是一个具体用户（通过grantee_id标识）或者是一个用户组。

返回结果说明 类型 说明 GetResult 参数解释： SDK公共结果对象。 表8 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无

接口约束 尽量避免目标桶名中带有“.”，否则通过HTTPS访问时可能出现客户端校验证书出错。 设置桶的网络配置请求消息体的上限是10KB。 您必须是桶拥有者或拥有设置桶的网站配置的权限，才能设置桶的网站配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketWebsite权限，如果使用桶策略则需授予PutBucketWebsite权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

请求参数说明 参数名称 参数类型 是否必选 描述 bucketName str 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 website WebsiteConfiguration 必选 参数解释： 设置桶的网站配置请求参数，详见WebsiteConfiguration。 默认取值： 无 表1 WebsiteConfiguration 参数名称 参数类型 是否必选 描述 redirectAllRequestTo RedirectAllRequestTo 作为请求参数时可选 参数解释： 所有请求重定向规则，详见RedirectAllRequestTo。 默认取值： 无 indexDocument IndexDocument 作为请求参数时可选 参数解释： 默认页面配置，详见IndexDocument。 默认取值： 无 errorDocument ErrorDocument 作为请求参数时可选 参数解释： 错误页面配置，详见ErrorDocument。 默认取值： 无 routingRules list of RoutingRule 作为请求参数时可选 参数解释： 请求重定向规则列表，详见RoutingRule。 默认取值： 无 errorDocument、indexDocument和routingRules必须配套使用，且与redirectAllRequestsTo互斥。当设置了这三个字段时，不能设置redirectAllRequestsTo；反之，当设置了redirectAllRequestsTo时，不能设置errorDocument、indexDocument和routingRules。 当errorDocument、indexDocument和routingRules三个字段一起使用时，routingRules可为空。 errorDocument、indexDocument、routingRules与redirectAllRequestsTo不能全为空。 表2 RedirectAllRequestTo 参数名称 参数类型 是否必选 描述 hostName str 作为请求参数时必选 参数解释： 重定向时使用的域名。如 www.example.com。 约束限制： 域名需符合域名规范。 默认取值： 无 protocol str 作为请求参数时可选 参数解释： 重定向请求时使用的协议。 取值范围： http https 默认取值： 无 表3 IndexDocument 参数名称 参数类型 是否必选 描述 suffix str 作为请求参数时必选 参数解释： 该字段被追加在对文件夹的请求的末尾（例如：suffix参数设置为“index.html”，请求的是“samplebucket/images/”，返回的数据将是“samplebucket”桶内名为“images/index.html”的对象的内容）。 取值范围： 该字段不能为空或者包含“/”字符。 默认取值： 无 表4 ErrorDocument 参数名称 参数类型 是否必选 描述 key str 作为请求参数时可选 参数解释： 当4XX错误出现时使用的对象的名称。这个元素指定当错误出现时返回的页面。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 表5 RoutingRule 参数名称 参数类型 是否必选 描述 condition Condition 作为请求参数时可选 参数解释： 重定向规则生效需要满足的条件。 取值范围： 匹配条件选择范围详见Condition。 默认取值： 无 redirect Redirect 作为请求参数时必选 参数解释： 重定向请求时的具体信息，详见Redirect。 默认取值： 无 表6 Condition 参数名称 参数类型 是否必选 描述 keyPrefixEquals str 作为请求参数时可选 参数解释： 重定向生效时的对象名前缀。当向对象发送请求时，如果对象名前缀等于这个值，那么重定向生效。 例如：重定向ExamplePage.html对象的请求，KeyPrefixEquals设为ExamplePage.html。 约束限制： 与httpErrorCodeReturnedEquals参数不可同时使用，两者二选一。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 httpErrorCodeReturnedEquals int 作为请求参数时可选 参数解释： 重定向生效时的HTTP错误码。当发生错误时，如果错误码等于这个值，那么重定向生效。 例如：当返回的HTTP错误码为404时重定向到NotFound.html，可以将Condition中的HttpErrorCodeReturnedEquals设置为404，Redirect中的ReplaceKeyWith设置为NotFound.html。 约束限制： 与keyPrefixEquals参数不可同时使用，两者二选一。 取值范围： 取值范围可参见错误码。 默认取值： 无 表7 Redirect 参数名称 参数类型 是否必选 描述 protocol str 作为请求参数时可选 参数解释： 重定向请求时使用的协议。 取值范围： http https 默认取值： 无 hostName str 作为请求参数时可选 参数解释： 重定向请求时使用的域名。 默认取值： 无 replaceKeyPrefixWith str 作为请求参数时可选 参数解释： 重定向请求时使用的对象名前缀。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 replaceKeyWith str 作为请求参数时可选 参数解释： 重定向请求时使用的对象名。 约束限制： 不可与replaceKeyPrefixWith同时使用。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 httpRedirectCode int 作为请求参数时可选 参数解释： 重定向请求时响应中的HTTP状态码，详见状态码。 默认取值： 无

返回结果 表3 返回结果 类型 说明 GetResult 参数解释： SDK公共结果对象。 如果GetResult.status为202表示正在恢复对象；如果GetResult.status为200表示对象已恢复。 表4 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 bucketName str 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 objectKey str 必选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 days int 必选 参数解释： 恢复对象后，会生成一个对象的标准存储副本，此参数指定恢复有效期，即标准存储副本的保存时间。 取值范围： [1, 30]，单位：天。 默认取值： 无 tier str 可选 参数解释： 恢复选项，用户可根据需求选择恢复选项，不同的恢复选项恢复耗时不同。 取值范围： 恢复选项可选值详见恢复选项。 默认取值： 标准恢复 versionId str 可选 参数解释： 待恢复归档存储对象的版本号。 默认取值： 无，如果不设置则默认指定最新版本的对象。 表2 RestoreTier 常量值 说明 EXPEDITED 快速恢复，恢复耗时1~5分钟。 STANDARD 标准恢复，恢复耗时3~5小时。

功能说明 归档要先将对象恢复，然后再执行下载数据的操作。对象恢复后，会产生一个标准存储类型的对象副本，也就是说会同时存在标准存储类型的对象副本和归档存储对象，在恢复对象的保存时间到期后标准存储类型的对象副本会自动删除。 该接口可以恢复指定桶中的归档存储对象。 重复恢复归档存储数据时在延长恢复有效期的同时，也将会对恢复时产生的恢复费用进行重复收取。产生的标准存储类别的对象副本有效期将会延长，并且收取延长时间段产生的标准存储副本费用。

接口约束 您必须是桶拥有者或拥有恢复归档存储对象的权限，才能恢复归档存储对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:RestoreObject权限，如果使用桶策略则需授予RestoreObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 重复恢复归档存储数据时在延长恢复有效期的同时，也将会对恢复时产生的恢复费用进行重复收取。产生的标准存储类别的对象副本有效期将会延长，并且收取延长时间段产生的标准存储副本费用。

返回结果说明 表2 返回结果 类型 说明 GetResult 参数解释： SDK公共结果对象。 表3 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无 表4 GetResult.body GetResult.body类型 说明 LocationResponse 参数解释： 桶区域位置响应结果。 表5 LocationResponse 参数名称 参数类型 描述 location str 参数解释： 桶所在的区域。 约束限制： 该参数定义了桶将会被创建在哪个区域，如果使用的终端节点是obs.myhuaweicloud.com，可以不携带此参数；如果使用的终端节点不是obs.myhuaweicloud.com，则必须携带此参数。 取值范围： 当前有效的OBS区域和终端节点的更多信息，请参考地区和终端节点。终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以向企业管理员获取区域和终端节点信息。 默认取值： 终端节点为obs.myhuaweicloud.com且用户未设定区域时，默认为华北-北京一（cn-north-1）。

请求参数说明 表1 请求参数列表 参数名称 参数类型 是否必选 描述 bucketName str 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无

接口约束 您必须是桶拥有者或拥有获取桶区域位置的权限，才能获取桶区域位置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketLocation权限，如果使用桶策略则需授予GetBucketLocation权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

代码样例 # 引入模块 from obs import ObsClient # 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。 # 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。 ak = os.getenv("AccessKeyID") sk = os.getenv("SecretAccessKey") # 【可选】如果使用临时AKSK和SecurityToken访问OBS，则同样推荐通过环境变量获取 security_token = os.getenv("SecurityToken") # server填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写。 server = "https://obs.cn-north-4.myhuaweicloud.com" # 创建obsClient实例 # 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过security_token参数指定securityToken值 obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server) # 引入日志模块 from obs import LogConf # 指定日志配置文件路径，初始化ObsClient日志 obsClient.initLog(LogConf('./log.conf'), '*** Your Log Name ***') # 使用ObsClient访问OBS服务 # 关闭ObsClient日志 obsClient.close()

功能说明 通过开启SDK日志功能，可将接口调用过程中产生的日志信息记录到日志文件，用于后续的数据分析或问题定位。具体步骤如下： 找到OBS Python SDK开发包(github获取)中的log.conf文件。其内容格式如下： [LOGCONF] #Configure log file dir LogFileDir = ./logs #Configure log file name LogFileName = eSDK-OBS-PYTHON.log #Configure log file size, unit:MB LogFileSize = 30 #Configure max log file numbers LogFileNumber = 5 #Configure log level for log file (DEBUG | INFO | WARNING | ERROR) LogFileLevel = INFO #Configure whether to print log to console (Yes:1 No:0) PrintLogToConsole = 0 #Configure log level for console (DEBUG | INFO | WARNING | ERROR) PrintLogLevel = WARNING 根据实际情况修改log.conf中的配置参数。 调用ObsClient.initLog开启日志功能。 日志功能默认是关闭的，需要主动开启。 您可以从日志分析章节获取更多关于SDK日志的信息。 您可以根据实际需要在系统中修改日志文件的权限。 OBS Python SDK的日志模块是线程安全非进程安全的，如果在多进程场景下使用ObsClient请务必为每个ObsClient配置独立的日志路径，防止多个进程并发写日志时发生冲突。

请求参数说明 表1 请求参数列表 参数名称 参数类型 是否必选 描述 bucketName str 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无

接口约束 桶配额值必须为非负整数，单位为字节，支持的最大值为263-1。 桶的拥有者的状态是欠费冻结状态时不可以查询桶配额信息。 您必须是桶拥有者或拥有获取桶配额的权限，才能获取桶配额。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketQuota权限，如果使用桶策略则需授予GetBucketQuota权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

返回结果说明 表2 返回结果 类型 说明 GetResult 参数解释： SDK公共结果对象。 表3 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无 表4 GetResult.body GetResult.body类型 说明 GetBucketQuotaResponse 参数解释： 桶配额响应结果。 表5 GetBucketQuotaResponse 参数名称 参数类型 描述 quota int 参数解释： 桶的配额值。 取值范围： 大于等于0的整型数，单位：字节。 默认取值： 0，表示没有限制桶配额。

返回结果说明 表2 返回结果 类型 说明 GetResult 参数解释： SDK公共结果对象。 表3 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无

返回结果 表9 返回结果 类型 说明 GetResult 参数解释： SDK公共结果对象。 表10 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无 表11 GetResult.body GetResult.body类型 说明 PutContentResponse 参数解释： 上传对象响应结果，参考PutContentResponse。 表12 PutContentResponse 参数名称 参数类型 描述 storageClass str 参数解释： 对象的存储类型。 取值范围： 当对象存储类型是标准存储时，该值为空。 可选择的存储类型参见StorageClass。 默认取值： 无 versionId str 参数解释： 对象的版本号。如果桶的多版本状态为开启，则会返回对象的版本号。 取值范围： 长度为32的字符串。 默认取值： 无 etag str 参数解释： 对象的etag值，即base64编码的128位MD5摘要。etag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时etag为A，下载对象时etag为B，则说明对象内容发生了变化。etag只反映变化的内容，而不是其元数据。上传的对象或拷贝操作创建的对象，都有唯一的etag。 约束限制： 当对象是服务端加密的对象时，etag值不是对象的MD5值。 取值范围： 长度为32的字符串。 默认取值： 无 sseKms str 参数解释： SSE-KMS方式的算法。 取值范围： kms，即以SSE-KMS方式加密对象。 默认取值： 无 sseKmsKey str 参数解释： SSE-KMS加密方式下使用的KMS主密钥的ID值。 取值范围： 有效值支持两种格式： regionID:domainID(账号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属账号的账号ID，获取方法参见如何获取账号ID和用户ID?(Python SDK)； key_id是从数据加密服务创建的密钥ID，获取方法请参见查看密钥。 默认取值： 如果用户没有提供该头域，那么默认的主密钥将会被使用。 如果默认主密钥不存在，将默认创建并使用。 sseC str 参数解释： SSE-C方式的算法。 取值范围： AES256。 默认取值： 无 sseCKeyMd5 str 参数解释： SSE-C方式下加密使用密钥的MD5值，该值用于验证密钥传输过程中是否出错。 约束限制： 由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ== 默认取值： 无 objectUrl str 参数解释： 对象的全路径。 默认取值： 无

接口约束 您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 单次上传对象大小范围是[0, 5GB]。 如果需要上传超过5GB的大文件，需要通过多段操作来分段上传。

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 bucketName str 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 objectKey str 必选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 content str 或 readable object 可选 参数解释： 待上传对象的内容。 取值范围： 须知： 使用流式上传时，CONTENT参数必须是包含“READ”属性的可读对象。 上传文件流时，必须以二进制模式（“RB”模式或“RB+”模式）打开文件。 默认取值： 无 metadata dict 可选 参数解释： 待上传对象的自定义元数据。OBS支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据，以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时，加入的自定义元数据将会在返回的消息头中出现。 约束限制： 所有自定义元数据大小的总和不超过8K。单个自定义元数据大小的计算方式为：每个键和值的UTF-8 编码中的字节总数。 自定义元数据的key值不区分大小写，OBS统一转为小写进行存储。value值区分大小写。 自定义元数据key-value对都必须符合US-ASCII。如果一定要使用非ASCII码或不可识别字符，需要客户端自行做编解码处理，可以采用URL编码或者Base64编码，服务端不会做解码处理。例如x-obs-meta-中文：中文 经URL编码后发送，“中文”的URL编码为：%E4%B8%AD%E6%96%87，则响应为x-obs-meta-%E4%B8%AD%E6%96%87: %E4%B8%AD%E6%96%87 默认取值： 无 headers PutObjectHeader 可选 参数解释： 上传对象的头域，用于设置对象的基本信息，包括存储类别、冗余策略等。 取值范围： 参考PutObjectHeader。 默认取值： 无 progressCallback callable 可选 参数解释： 获取上传进度的回调函数。 默认取值： 无 说明： 该回调函数依次包含三个参数：已上传的字节数、总字节数、已使用的时间（单位：秒），示例代码参考上传对象-获取上传进度。 上传进度回调功能仅支持流式上传、文件上传、上传段、追加上传和断点续传上传。 autoClose bool 可选 参数解释： 上传完成后，自动关闭数据流。 取值范围： True：自动关闭数据流。 False：不开启自动关闭数据流。 默认取值： 默认为True。

返回结果说明 类型 说明 GetResult 参数解释： SDK公共结果对象。 表1 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无

功能介绍 跨域资源共享（Cross Origin Resource Sharing，CORS）是由W3C标准化组织提出的一种网络浏览器的规范机制，定义了一个域中加载的客户端Web应用程序与另一个域中的资源交互的方式。而在通常的网页请求中，由于同源安全策略（Same Origin Policy，SOP）的存在，不同域之间的网站脚本和内容是无法进行交互的。OBS支持CORS规范，允许跨域请求访问OBS中的资源。 调用删除桶的CORS配置接口，您可删除指定桶的跨域资源共享规则。

请求参数说明 参数名称 参数类型 是否必选 描述 bucketName str 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无

接口约束 您必须是桶拥有者或拥有删除桶的CORS配置的权限，才能删除桶的CORS配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketCORS权限，如果使用桶策略则需授予PutBucketCORS权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

接口约束 您必须是桶拥有者或拥有删除桶的网站配置的权限，才能删除桶的网站配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:DeleteBucketWebsite权限，如果使用桶策略则需授予DeleteBucketWebsite权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

返回结果说明 类型 说明 GetResult 参数解释： SDK公共结果对象。 表1 GetResult 参数名称 参数类型 描述 status int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 reason str 参数解释： HTTP文本描述。 默认取值： 无 errorCode str 参数解释： OBS服务端错误码，当status参数小于300时为空。 默认取值： 无 errorMessage str 参数解释： OBS服务端错误描述，当status参数小于300时为空。 默认取值： 无 requestId str 参数解释： OBS服务端返回的请求ID。 默认取值： 无 indicator str 参数解释： OBS服务端返回的错误定位码。 默认取值： 无 hostId str 参数解释： 请求的服务端ID，当status参数小于300时为空。 默认取值： 无 resource str 参数解释： 发生错误时相关的桶或对象，当status参数小于300时为空。 默认取值： 无 header list 参数解释： 响应消息头列表，由多个元组构成。每个元组均包含两个元素，代表响应头的键值对。 默认取值： 无 body object 参数解释： 操作成功后的结果数据，当status大于300时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无