返回结果说明 类型 说明 GetResult 参数解释： SDK公共结果对象。 表6 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时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无

请求参数说明 参数名称 参数类型 是否必选 描述 bucketName str 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 logstatus Logging 可选 参数解释： 日志配置信息。详见Logging。 默认取值： 无 extensionHeaders dict 可选 参数解释： 接口的拓展头域。 取值范围： 参考自定义头域。 默认取值： 无 表1 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权限。 默认取值： 无 表2 Grant 参数名称 参数类型 是否必选 描述 grantee Grantee 必选 参数解释： 被授权用户信息详见Grantee。 permission str 必选 参数解释： 被授予的权限。 取值范围： 授权策略的取值范围详见权限。 默认取值： 无 delivered bool 可选 参数解释： 桶的ACL是否向桶内对象传递。作用于桶内所有对象。 取值范围： True：是，桶ACL向桶内对象传递。 False：否，桶ACL不向桶内对象传递，仅作用于桶。 默认取值： False 表3 Grantee 参数名称 参数类型 是否必选 描述 grantee_id str 如果group为空则必选。 参数解释： 被授权用户的账号ID，即domain_id。 取值范围： 如何获取账号ID请参见获取账号ID。 默认取值： 无 grantee_name str 可选 参数解释： 被授权的用户名。 约束限制： 不支持中文。 只能以字母开头。长度为6-32个字符。 只能包含英文字母、数字或特殊字符(-_)。 默认取值： 无 group str 如果grantee_id为空则必选。 参数解释： 被授权的用户组。 取值范围： 授权用户组取值范围详见用户组。 默认取值： 无 grantee_id与grantee_name配套使用，且与group互斥，即被授权用户可以是一个具体用户（通过grantee_id标识）或者是一个用户组。 表4 Permission 常量值 说明 READ 读权限。 如果有桶的读权限，则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 如果有对象的读权限，则可以获取该对象内容和元数据。 WRITE 写权限。 如果有桶的写权限，则可以上传、覆盖和删除该桶内任何对象和段。 此权限在对象上不适用。 READ_ACP 读取ACL配置的权限。 如果有读ACP的权限，则可以获取对应的桶或对象的权限控制列表（ACL）。 桶或对象的所有者永远拥有读对应桶或对象ACP的权限。 WRITE_ACP 修改ACL配置的权限。 如果有写ACP的权限，则可以更新对应桶或对象的权限控制列表（ACL）。 桶或对象的所有者永远拥有写对应桶或对象的ACP的权限。 拥有了写ACP的权限，由于可以更改ACL，实际上意味着拥有了完全访问的权限。 FULL_CONTROL 完全控制权限，包括对桶或对象的读写权限，以及对桶或对象ACL配置的读写权限。 如果有桶的完全控制权限意味着拥有READ、WRITE、READ_ACP和WRITE_ACP的权限。 如果有对象的完全控制权限意味着拥有READ、READ_ACP和WRITE_ACP的权限。 表5 Group 常量值 说明 ALL_USERS 所有用户。 AUTHENTICATED_USERS 授权用户，已废弃。 LOG _DELIVERY 日志投递组，已废弃。

功能说明 调用设置桶日志管理配置接口，您可以为指定桶打开桶日志功能，并配置日志存放的目标桶。创建桶时，默认是不生成桶的日志的，调用Python SDK的设置桶日志管理配置接口时，接口会自动为您打开桶日志配置。桶日志功能开启后，桶的每次操作将会产生一条日志，并将多条日志打包成一个日志文件。日志文件存放位置需要在开启桶日志功能时指定，可以存放到开启日志功能的桶中，也可以存放到其他您有权限的桶中，但需要和开启日志功能的桶在同一个region中。您还可以根据需要配置日志文件的访问权限，以及日志文件的文件名前缀。

接口约束 由于日志文件是OBS产生，并且由OBS上传到存放日志的桶中，因此OBS需要获得委托授权，用于上传生成的日志文件，所以在配置桶日志管理前，需要先到统一身份认证服务生成一个对OBS服务的委托，委托配置权限只需设置目标桶的上传对象权限。如何创建委托请参考创建云服务委托。 您必须是桶拥有者或拥有设置桶日志管理配置的权限，才能设置桶日志管理配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketLogging权限，如果使用桶策略则需授予PutBucketLogging权限。相关授权方式介绍可参见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时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无

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

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

返回结果说明 类型 说明 GetResult 参数解释： SDK公共结果对象。 表2 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时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无

接口约束 您必须是桶拥有者或拥有设置桶BPA配置的权限，才能设置桶桶BPA配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketPublicAccessBlock权限，如果使用桶策略则需授予PutBucketPublicAccessBlock权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。 如果开启阻止公开访问，则已有的公开访问权限会被忽略，并且不允许配置新的公开访问权限。如果关闭阻止公开访问，则已有的公开访问权限仍然生效，并且支持配置新的公开访问权限。 Posix桶新桶默认不开启BPA配置，对象桶新桶默认开启BPA配置。

请求参数说明 表1 请求参数列表 参数名称 参数类型 是否必选 描述 bucketName str 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 取值范围： 无 默认取值： 无 blockPublicAcls bool 可选 参数解释： 是否锁定公共ACL，当该参数为True时，上传对象，设置Public ACL时禁止对象上传，ACL修改API（修改桶ACL、对象ACL），设置Public ACL时禁止ACL修改。 约束限制： 无 取值范围： True：锁定公共ACL。 False：不锁定公共ACL。 默认取值： 无 ignorePublicAcls bool 可选 参数解释： 是否忽略公共ACL。当该参数为True时，OBS所有OpenAPI进行权限检查时，Public ACL不生效。 约束限制： 无 取值范围： True：忽略公共ACL。 False：不忽略公共ACL。 默认取值： 无 blockPublicPolicy bool 可选 参数解释： 是否锁定公共策略。当该参数为True时，桶策略修改API，设置Public Policy时禁止Policy修改。 约束限制： 无 取值范围： True：锁定公共策略。 False：不锁定公共策略 默认取值： 无 restrictPublicBuckets bool 可选 参数解释： 是否限制账号访问。当该参数为True时，OBS所有OpenAPI进行权限检查时，如果桶策略状态为公开，则只允许云服务账号和本账号访问 约束限制： 无 取值范围： True：限制账号访问。 False：不限制账号访问 默认取值： 无 extensionHeaders dict 可选 参数解释： 接口的拓展头域。 取值范围： 参考自定义头域。 默认取值： 无

接口约束 您必须是桶拥有者或拥有获取桶策略公开状态的权限，才能获取桶策略公开状态。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketPolicyPublicStatus权限，如果使用桶策略则需授予GetBucketPolicyPublicStatus权限。相关授权方式介绍可参见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时为空。该值根据调用接口的不同而不同，参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值： 无 GetResult.body类型 说明 object 参数解释： 桶的CORS规则列表，详见表2。 表2 BucketPolicyPublicStatus 参数名称 参数类型 描述 status bool 参数解释： 桶策略是否公开。 约束限制： 无 取值范围： True：公开。 False：非公开。 默认取值： 无

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

返回结果说明 类型 说明 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类型 说明 object 参数解释： 桶的CORS规则列表，详见表2。 表2 BucketPublicStatus 参数名称 参数类型 描述 status bool 参数解释： 桶是否公开。 约束限制： 无 取值范围： True：公开。 False：非公开。 默认取值： 无

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