华为云用户手册

返回结果说明 表4 返回结果 参数类型 描述 Response 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见Response。 表5 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult ListBucketsOutput 参数解释： 操作成功后的结果数据，详见ListBucketsOutput。 约束限制： 当Status大于300时为空。 表6 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表7 ListBucketsOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 默认取值： 无 Owner Owner 参数解释： 桶的所有者。 取值范围： 桶所有者取值参见Owner。 Buckets Bucket[] 参数解释： 桶信息列表。 取值范围： 桶信息取值参见Bucket。 表8 Owner 参数名称 参数类型 是否必选 描述 ID string 作为请求参数时必选 参数解释： 所有者的账号ID，即domain_id。 取值范围： 如何获取账号ID请参见如何获取账号ID和用户ID？(Harmony SDK) 默认取值： 无 DisplayName string 可选 参数解释： 所有者的账号用户名。 默认取值： 无 表9 Bucket 参数名称 参数类型 描述 Name string 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用类IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 默认取值： 无 CreationDate string 参数解释： 桶的创建时间。 默认取值： 无 Location string 参数解释： 桶所在的区域。 约束限制： 该参数定义了桶将会被创建在哪个区域，如果使用的终端节点是obs.myhuaweicloud.com，可以不携带此参数；如果使用的终端节点不是obs.myhuaweicloud.com，则必须携带此参数。 取值范围： 当前有效的OBS区域和终端节点的更多信息，请参考地区和终端节点。终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以向企业管理员获取区域和终端节点信息。 默认取值： 终端节点为obs.myhuaweicloud.com且用户未设定区域时，默认为华北-北京一（cn-north-1）。 BucketType string 参数解释： 桶类型。 取值范围： 对象桶：OBJECT。 并行文件系统：POSIX。 默认取值： 无

返回结果 表3 返回结果 参数类型 描述 Response 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见Response。 表4 Response 参数名称 参数类型 描述 CommonMsg Response 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult BaseResponseOutput 参数解释： 操作成功后的结果数据，详见BaseResponseOutput。 约束限制： 当Status大于300时为空。 表5 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表6 BaseResponseOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。

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

接口约束 您必须是桶拥有者或拥有删除桶的权限，才能删除桶。建议使用 IAM 或桶策略进行授权，如果使用IAM则需授予obs:bucket:DeleteBucket权限，如果使用桶策略则需授予DeleteBucket权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 待删除的桶必须为空，桶为空包含两方面含义： 桶内没有任何对象，没有对象的任何历史版本，没有对象的删除标记（删除标记也视作一个历史版本）。 桶内没有任何未合并的多段上传任务，即桶内不存在碎片

参数描述 表1 LogConfig 参数名称 参数类型 是否必选 描述 level LogLevel 必选 参数解释： 日志级别。 表2 LogLevel 常量名 原始值 说明 OFF off 关闭级别，如果设置为这个级别，日志打印功能将被关闭。 ERROR error 错误级别，如果设置为这个级别，仅打印发生异常时的错误信息。 WARN warn 告警级别，如果设置为这个级别，除了打印错误级别的信息外，还将打印一些关键事件的信息。 INFO info 信息级别，如果设置为这个级别，除了打印告警级别的信息外，还将打印HTTP/HTTPS请求的耗时时间，ObsClient接口的耗时时间等。 DEBUG debug 调试级别，如果设置为这个级别，除了打印INFO级别的信息外，还将打印每次HTTP/HTTPS请求和响应的头信息、鉴权算法计算出的stringToSign信息等。

参数描述 表1 返回结果 参数类型 描述 Response 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见Response。 表2 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，详见ICommonMsg。 InterfaceResult T 说明： T表示泛型，请参见具体接口章节的详细描述。 参数解释： 操作成功后的结果数据，详见T。 约束限制： 当Status大于300时为空。 表3 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input ListVersionsInput 必选 参数解释： 列举桶内多版本对象接口入参，详见ListVersionsInput。 表2 ListVersionsInput 参数名称 参数类型 是否必选 描述 Bucket string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 KeyMarker string 可选 参数解释： 列举多版本对象的起始位置，返回的对象列表将是对象名按照字典序排序后该参数以后的所有对象。 约束限制： 该字段仅用于多版本列举。 取值范围： 上次请求返回体的NextKeyMarker值。 默认取值： 无 VersionIdMarker string 可选 参数解释： 与KeyMarker配合使用。返回的对象列表将是对象名和版本号按照字典序排序后该参数以后的所有对象。KeyMarker指定对象名，VersionIdMarker指定该对象的具体版本号，两者共同确定对象版本 约束限制： 该字段只适用于多版本列举场景。 如果VersionIdMarker指定的版本号不属于KeyMarker指定对象的版本，则该参数无效。 取值范围： 对象的版本号，即上次请求返回体的NextVersionIdMarker值。 默认取值： 无 Prefix string 可选 参数解释： 限定返回的对象名必须带有指定前缀。 例如，假设您拥有以下对象：logs/day1、logs/day2、logs/day3和ExampleObject.jpg。如果您将logs/指定为前缀，将返回以字符串“logs/”开头的三个对象。如果您指定空的前缀且请求中没有其他过滤条件，将返回桶中的所有对象。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 MaxKeys number 可选 参数解释： 列举对象的最大数目，返回的对象列表将是按照字典顺序的最多前MaxKeys个对象。 取值范围： 1~1000，当超出范围时，按照默认的1000进行处理。 默认取值： 1000 Delimiter string 可选 参数解释： 对象名按照此标识符进行分组。通常与prefix参数搭配使用，如果指定了prefix，从prefix到第一次出现delimiter间具有相同字符串的对象名会被分成一组，形成一条CommonPrefixes；如果没有指定prefix，从对象名的首字符到第一次出现delimiter间具有相同字符串的对象名会被分成一组，形成一条CommonPrefixes。 例如，桶中有3个对象，分别为abcd、abcde、bbcde。如果指定delimiter为d，prefix为a，abcd、abcde会被分成一组，形成一条前缀为abcd的CommonPrefixes；如果只指定delimiter为d，abcd、abcde会被分成一组，形成一条前缀为abcd的CommonPrefixes，而bbcde会被单独分成一组，形成一条前缀为bbcd的CommonPrefixes。 对于并行文件系统，不携带此参数时默认列举是递归列举此目录下所有内容，会列举子目录。在大数据场景下（目录层级深、目录下文件多）的列举，建议设置[delimiter=/]，只列举当前目录下的内容，不列举子目录，提高列举效率。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 EncodingType string 可选 参数解释： 对响应中的部分元素进行指定类型的编码。如果Delimiter、KeyMarker、Prefix、CommonPrefixes、NextKeyMarker和Key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的Delimiter、KeyMarker、Prefix、CommonPrefixes、NextKeyMarker和Key进行编码。 取值范围： 可选值为url。 默认取值： 无，不设置则不编码。

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

返回结果 表3 返回结果 参数类型 描述 Response 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见Response。 表4 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult BaseResponseOutput 参数解释： 操作成功后的结果数据，详见BaseResponseOutput。 约束限制： 当Status大于300时为空。 表5 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表6 BaseResponseOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。

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

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

返回结果 表3 返回结果 参数类型 描述 Response 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见Response。 表4 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult GetBucketQuotaOutput 参数解释： 操作成功后的结果数据，详见GetBucketQuotaOutput。 约束限制： 当Status大于300时为空。 表5 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表6 GetBucketQuotaOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 默认取值： 无 StorageQuota number 参数解释： 桶的配额值。 取值范围： 0~（263-1），单位：字节。 默认取值： 0，表示没有限制桶配额。

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

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

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input ListObjectsInput 必选 参数解释： 列举桶内对象接口入参，详情参考ListObjectsInput。 表2 ListObjectsInput 参数名称 参数类型 是否必选 描述 Bucket string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 Markers string 可选 参数解释： 列举桶内对象列表时，指定一个标识符，从该标识符以后按对象名的字典顺序返回对象列表。 约束限制： 仅用于非多版本列举。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 Prefix string 可选 参数解释： 限定返回的对象名必须带有指定前缀。 例如，假设您拥有以下对象：logs/day1、logs/day2、logs/day3和ExampleObject.jpg。如果您将logs/指定为前缀，将返回以字符串“logs/”开头的三个对象。如果您指定空的前缀且请求中没有其他过滤条件，将返回桶中的所有对象。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 MaxKeys number 可选 参数解释： 列举对象的最大数目，返回的对象列表将是按照字典顺序的最多前MaxKeys个对象。 取值范围： 1~1000，当超出范围时，按照默认的1000进行处理。 默认取值： 1000 Delimiter string 可选 参数解释： 对象名按照此标识符进行分组。通常与prefix参数搭配使用，如果指定了prefix，从prefix到第一次出现delimiter间具有相同字符串的对象名会被分成一组，形成一条CommonPrefixes；如果没有指定prefix，从对象名的首字符到第一次出现delimiter间具有相同字符串的对象名会被分成一组，形成一条CommonPrefixes。 例如，桶中有3个对象，分别为abcd、abcde、bbcde。如果指定delimiter为d，prefix为a，abcd、abcde会被分成一组，形成一条前缀为abcd的CommonPrefixes；如果只指定delimiter为d，abcd、abcde会被分成一组，形成一条前缀为abcd的CommonPrefixes，而bbcde会被单独分成一组，形成一条前缀为bbcd的CommonPrefixes。 对于并行文件系统，不携带此参数时默认列举是递归列举此目录下所有内容，会列举子目录。在大数据场景下（目录层级深、目录下文件多）的列举，建议设置[delimiter=/]，只列举当前目录下的内容，不列举子目录，提高列举效率。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 EncodingType string 可选 参数解释： 对响应中的部分元素进行指定类型的编码。如果Delimiter、Marker、Prefix、CommonPrefixes、NextMarker和Key包含xml 1.0标准不支持的控制字符（特殊字符），需设置该参数为url编码。 取值范围： 可选值为url。 默认取值： 无，不设置则不编码。

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

返回结果 表3 返回结果 参数类型 描述 Response 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见Response。 表4 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult GetBucketStorageInfoOutput 参数解释： 操作成功后的结果数据，详见GetBucketStorageInfoOutput。 约束限制： 当Status大于300时为空。 表5 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表6 GetBucketStorageInfoOutput 参数名称 参数类型 描述 RequestId string 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 Size number 参数解释： 桶中对象占用的空间大小。 取值范围： 0~（263-1），单位：字节。 Objectnumber number 参数解释： 桶内对象个数。 取值范围： 0~（231-1），单位：个。 默认取值： 无

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

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

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

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

功能介绍 桶配额是桶容量的上限值。默认情况下，OBS系统和单个桶都没有总数据容量和对象数量的限制。您可以根据需要，为桶设置配额限制来控制桶内允许上传的对象总容量，超过设置的对象容量后，上传对象会失败。例如您为桶设置配额为100G，那么当桶内所有对象的大小总和达到100G后，再上传对象就会因为超过配额导致上传失败。 容量限制只对桶配额设置生效后的对象上传操作有影响， 如果您设置桶配额时，桶配额的数值小于桶中已上传的对象容量，并不会导致桶中已有对象被删除，但该桶后续将不能再上传任何对象。这种情况下只有删除部分已有对象，将已用空间释放到配额限制以下之后才能再次上传新对象。

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

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input SetBucketQuotaInput 必选 参数解释： 设置桶配额接口入参，详见SetBucketQuotaInput。 表2 SetBucketQuotaInput 参数名称 参数类型 是否必选 描述 Bucket string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 StorageQuota number 必选 参数解释： 桶的配额值。 取值范围： 0~（263-1），单位：字节。 默认取值： 0，表示没有限制桶配额。

返回结果 表3 返回结果 参数类型 描述 Response 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见Response。 表4 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult BaseResponseOutput 参数解释： 操作成功后的结果数据，详见BaseResponseOutput。 约束限制： 当Status大于300时为空。 表5 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表6 BaseResponseOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。

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

返回结果 表4 返回结果 参数类型 描述 Response 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见Response。 表5 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult BaseResponseOutput 参数解释： 操作成功后的结果数据，详见BaseResponseOutput。 约束限制： 当Status大于300时为空。 表6 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表7 BaseResponseOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。

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

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

返回结果 表3 返回结果 参数类型 描述 Response 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表4。 表4 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult GetBucketMetadataOutput 参数解释： 操作成功后的结果数据，详见GetBucketMetadataOutput。 约束限制： 当Status大于300时为空。 表5 ICommonMsg 参数名称 参数类型 描述 Status number 参数解释： OBS服务端返回的HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 Code string 参数解释： OBS服务端返回的错误码。 Message string 参数解释： OBS服务端返回的错误描述。 HostId string 参数解释： OBS服务端返回的请求服务端ID。 RequestId string 参数解释： OBS服务端返回的请求ID。 Id2 string 参数解释： OBS服务端返回的请求ID2。 Indicator string 参数解释： OBS服务端返回的详细错误码。 表6 GetBucketLocationOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 默认取值： 无 Location string 参数解释： 桶所在的区域。 约束限制： 该参数定义了桶将会被创建在哪个区域，如果使用的终端节点是obs.myhuaweicloud.com，可以不携带此参数；如果使用的终端节点不是obs.myhuaweicloud.com，则必须携带此参数。 取值范围： 当前有效的OBS区域和终端节点的更多信息，请参考地区和终端节点。终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以向企业管理员获取区域和终端节点信息。 默认取值： 终端节点为obs.myhuaweicloud.com且用户未设定区域时，默认为华北-北京一（cn-north-1）。