华为云用户手册

返回结果 表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:object:RestoreObject权限，如果使用桶策略则需授予RestoreObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 重复恢复归档或深度归档存储对象时在延长恢复有效期的同时，也将会对恢复时产生的恢复费用进行重复收取。产生的标准存储类别的对象副本有效期将会延长，并且收取延长时间段产生的标准存储副本费用。

HTTP状态码(Harmony SDK) OBS服务端遵照HTTP规范，在接口调用完成均会返回标准的HTTP状态码，HTTP状态码分类以及OBS中常见的HTTP状态码如下： HTTP状态码分类： 分类 分类描述 1XX 信息，服务器收到请求，需要请求者继续执行操作，一般对用户调用函数不可见。 2XX 成功，操作被成功接收并处理。 3XX 重定向，需要进一步的操作以完成请求。 4XX 客户端错误，请求包含语法错误或无法完成请求。 5XX 服务器错误，服务器在处理请求的过程中发生了错误 OBS中常见的HTTP状态码及其含义： HTTP状态码 描述 常见原因 400 Bad Request 请求参数错误 请求参数不合法。 客户端携带MD5请求后一致性校验失败。 无效的参数（使用SDK时传递了不合法的参数）。 无效的桶名（使用了不合法的桶名）。 403 Forbidden 拒绝访问 请求的签名不匹配（一般是AK/SK错误）。 权限不足（账号对请求的资源无权限）。 账号欠费。 桶的空间不足（出现在对桶设置了配额的场景）。 无效的AK。 客户端时间和服务端时间相差过大（客户端所在机器的时间与NTP服务不同步）。 404 Not Found 请求的资源不存在 桶不存在。 对象不存在。 桶的策略配置不存在（桶CORS配置不存在、桶Policy配置不存在等）。 分段上传任务不存在。 405 Method Not Allowed 请求的方法不支持 请求的方法/特性未在该桶所在的区域上线。 408 Request Timeout 请求超时 服务端与客户端Socket连接超时。 409 Conflict 请求冲突 在不同区域重复创建桶名桶。 尝试删除非空桶。 500 Internal Server Error 服务端内部错误 服务端内部错误。 503 Service Unavaliable 服务不可用 服务端暂时不可访问 父主题： 异常处理(Harmony SDK)

请求参数说明 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input ModifyObjectInput 必选 参数解释： 修改写对象接口入参，详见ModifyObjectInput。 表2 ModifyObjectInput 参数名称 参数类型 是否必选 描述 Bucket string 必选 参数解释： 并行文件系统名。 约束限制： 并行文件系统的名字需全局唯一，不能与已有的任何并行文件系统名称重复，包括其他用户创建的并行文件系统。 并行文件系统命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名并行文件系统不会报错，创建的并行文件系统属性以第一次请求为准。 取值范围： 长度为3～63个字符。 默认取值： 无 Key string 必选 参数解释： 对象名。对象名是对象在并行文件系统中的唯一标识。对象名是对象在并行文件系统中的完整路径，路径中不包含并行文件系统名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 Position number 必选 参数解释： 修改写操作的位置。 取值范围： 不小于0的长整型，单位：字节。 默认取值： 无 Body string 必选 参数解释： 待修改对象的数据流。 默认取值： 无

返回结果说明 表3 返回结果 参数类型 描述 Response 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见Response。 表4 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult ModifyObjectOutput 参数解释： 操作成功后的结果数据，详见ModifyObjectOutput。 约束限制： 当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 ModifyObjectOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 ETag string 参数解释： 对象的ETag值，即base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。ETag只反映变化的内容，而不是其元数据。上传的对象或复制操作创建的对象，都有唯一的ETag。 约束限制： 当对象是服务端加密的对象时，ETag值不是对象的MD5值。 取值范围： 长度为32的字符串。 默认取值： 无

接口约束 您必须是并行文件系统拥有者或拥有截断对象的权限，才能截断对象。建议使用IAM或策略进行授权，如果使用IAM则需授予obs:bucket:PutObject权限，如果使用策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的region以及region与endPoint的对应关系，详细信息请参见地区与终端节点。 目前接口仅在并行文件系统支持，普通对象桶不支持，如何创建并行文件系统请参考创建并行文件系统(Harmony SDK)。

请求参数 表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 GetBucketLoggingOutput 参数解释： 操作成功后的结果数据，详见GetBucketLoggingOutput。 约束限制： 当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 GetBucketLoggingOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 默认取值： 无 Agency string 参数解释： 目标桶（存放日志文件的桶）的所有者通过 统一身份认证 服务（IAM）创建对OBS云服务委托的名称。 可以选择账号下已有的IAM委托，也可以创建一个新的委托。创建委托参见创建IAM委托。 约束限制： 默认情况下，在为委托配置权限时只需设置日志存储桶的上传对象（PutObject）权限。如果日志存储桶开启了默认加密功能，还需要委托同时具有日志存储桶所在区域的KMS Administrator权限。 默认取值： 无 LoggingEnabled LoggingEnabled 参数解释： 日志配置信息。 约束限制： 无 取值范围： 详见LoggingEnabled。 默认取值： 无，指关闭桶日志。 表7 LoggingEnabled 参数名称 参数类型 是否必选 描述 TargetBucket string 设置logging时必选。 关闭logging时勿选。 参数解释： 日志存储桶的桶名，该桶用于存放日志文件。 约束限制： 需要和开启日志功能的桶在同一个region中。 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 TargetPrefix string 设置logging时必选。 关闭logging时勿选。 参数解释： 日志文件对象的对象名前缀，设置后日志文件对象将携带统一前缀存储在日志存储桶中。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 TargetGrants Grant 可选 参数解释： 被授权用户的权限信息列表，定义哪些用户可以针对日志文件进行哪些访问操作，详见Grant。 表8 Grant 参数名称 参数类型 是否必选 描述 Grantee Grantee 作为请求参数时必选 参数解释： 被授权用户相关信息，详见Grantee。 Permission PermissionType 作为请求参数时必选 参数解释： 被授予的权限。 取值范围： 权限取值范围：详见PermissionType。 默认取值： 无 表9 Grantee 参数名称 参数类型 是否必选 描述 Type GranteeType 作为请求参数时必选 参数解释： 被授权用户的类型。 取值范围： 被授权用户类型的取值范围：详见GranteeType。 默认取值： 无 ID string 作为请求参数时，如果Type为用户类型则必选。 参数解释： 被授权用户的账号ID，即domain_id。 取值范围： 如何获取账号ID请参见获取账号ID。 默认取值： 无 Name string 作为请求参数时可选 参数解释： 被授权用户的账号名。 约束限制： 不支持中文。 只能以字母开头。 长度为6-32个字符。 只能包含英文字母、数字或特殊字符(-_)。 默认取值： 无 URI GroupUriType 作为请求参数时，如果Type为用户组类型则必选。 参数解释： 被授权的用户组。 取值范围： 授权用户组取值范围：详见GroupUriType。 默认取值： 无 表10 GranteeType 常量名 原始值 说明 GROUP Group 授权给用户组。 CANONICAL_USER CanonicalUser 授权给单个用户。 表11 GroupUriType 常量名 原始值 说明 ALL_USERS AllUsers 所有用户。 AUTHENTICATED_USERS AuthenticatedUsers 授权用户，已废弃。 LOG _DELIVERY LogDelivery 日志投递组，已废弃。 表12 PermissionType 常量名 原始值 说明 READ READ 如果有桶的读权限，则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 如果有对象的读权限，则可以获取该对象内容和元数据。 WRITE WRITE 如果有桶的写权限，则可以上传、覆盖和删除该桶内任何对象和段。 此权限在对象上不适用。 READ_ACP READ_ACP 如果有读ACP的权限，则可以获取对应的桶或对象的权限控制列表（ACL）。 桶或对象的所有者永远拥有读对应桶或对象ACP的权限。 WRITE_ACP WRITE_ACP 如果有写ACP的权限，则可以更新对应桶或对象的权限控制列表（ACL）。 桶或对象的所有者永远拥有写对应桶或对象的ACP的权限。 拥有了写ACP的权限，由于可以更改权限控制策略，实际上意味着拥有了完全访问的权限。 FULL_CONTROL FULL_CONTROL 如果有桶的完全控制权限意味着拥有PermissionRead、PermissionWrite、PermissionReadAcp和PermissionWriteAcp的权限。 如果有对象的完全控制权限意味着拥有PermissionRead、PermissionReadAcp和PermissionWriteAcp的权限。

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

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

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

返回结果 表3 CreateBrowserBasedSignatureOutput 参数名称 参数类型 描述 OriginPolicy string 参数解释： Policy未经过base64之前的值，仅用于校验。 示例：{"expiration":"2023-09-12T12:52:59Z","conditions":[{"content-type":"text/plain"},{"bucket":"examplebucket"},{"key":"example/objectname"},]}"。 默认取值： 无 Policy string 参数解释： 表单中的policy，已经base64之后的值。 示例：eyJleHBpcmF0aW9uIjoiMjAyMy0wOS0xMlQxMjo1Mjo1OVoiLCJjb25kaXRpb25zIjpbeyJjb250ZW50LXR5cGUiOiJ0ZXh0L3BsYWluIn0seyJidWNrZXQiOiJleGFtcGxlYnVja2V0In0seyJrZXkiOiJleGFtcGxlL29iamVjdG5hbWUifSxdfQ==。 默认取值： 无 Signature string 参数解释： 表单中的signature。 示例：g0jQr4v9VWd1Q2FOFDG6LGfV9Cw=。 默认取值： 无

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input CreatePostSignatureSyncInput 必选 参数解释： 生成带授权信息的表单上传参数接口入参，详见CreatePostSignatureSyncInput。 表2 CreatePostSignatureSyncInput 参数名称 参数类型 是否可选 描述 Bucket string 可选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 Key string 可选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4. emyhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 Expires number 可选 参数解释： 表单上传鉴权的过期时间。 取值范围： 0~（263-1），单位：秒。 默认取值： 300 FormParams object 可选 参数解释： 除key，policy，signature外，表单上传时的其他参数。 取值范围： acl、cache-control、content-type、content-disposition、content-encoding、expires。 默认取值： 无

OBS服务端错误码(Harmony SDK) 在向OBS系统发出请求后，如果遇到错误，会在响应中包含响应的错误码描述错误信息。对象存储访问服务的错误码如表1所示。 表1 错误码 状态码 错误码 错误信息 处理措施 301 Moved Permanently PermanentRedirect 尝试访问的桶必须使用指定的地址，请将以后的请求发送到这个地址。 按照返回的重定向地址发送请求。 301 Moved Permanently WebsiteRedirect Website请求缺少bucketName。 携带桶名后重试。 307 Moved Temporarily TemporaryRedirect 临时重定向，当DNS更新时，请求将被重定向到桶。 会自动重定向，也可以将请求发送到重定向地址。 400 Bad Request BadDigest 客户端指定的对象内容的MD5值与系统接收到的内容MD5值不一致。 检查头域中携带的MD5与消息体计算出来的MD5是否一致。 400 Bad Request BadDomainName 域名 不合法。 使用合法的域名。 400 Bad Request BadRequest 请求参数不合法。 根据返回的错误消息体提示进行修改。 400 Bad Request CustomDomainAreadyExist 配置了已存在的域。 已经配置过了，不需要再配置。 400 Bad Request CustomDomainNotExist 删除不存在的域。 未配置或已经删除，无需删除。 400 Bad Request EntityTooLarge 通过SDK或API的PUT上传、POST上传和追加写超过5GB的文件 上传段超过5GB 设置的桶配置超过20KB 超过post表单中policy限制的文件大小（用户可自定义） 通过SDK或API的多段上传以及SDK的断点续传超过48.8TB的文件 修改上传的policy中的条件或者减少对象大小。 400 Bad Request EntityTooSmall 上传段除最后一段小于100KB 小于post表单中policy限制的文件大小（用户可自定义） 修改上传的policy中的条件或者增加对象大小。 400 Bad Request IllegalLocationConstraintException 用户未带Location在非默认Region创桶。 请求发往默认Region创桶或带非默认Region的Location创桶。 400 Bad Request IncompleteBody 由于网络原因或其他问题导致请求体未接受完整。 重新上传对象。 400 Bad Request IncorrectNumberOfFilesInPost Request 每个POST请求都需要带一个上传的文件。 带上一个上传文件。 400 Bad Request InvalidArgument 无效的参数。 根据返回的错误消息体提示进行修改。 400 Bad Request InvalidBucket 请求访问的桶已不存在。 更换桶名。 400 Bad Request InvalidBucketName 请求中指定的桶名无效，超长或带不允许的特殊字符。 更换桶名。 400 Bad Request InvalidContentLength Content-Length头域内容有误。 请检查封装头域或者提交工单寻求技术支持。 请检查封装头域或联系技术支持。 400 Bad Request InvalidDefaultStorageClass 存储类别不可用。 请确认能够使用的存储类别。 400 Bad Request InvalidEncryptionAlgorithmError 错误的加密算法。下载SSE-C加密的对象，携带的加密头域错误，导致不能解密。 携带正确的加密头域下载对象。 400 Bad Request InvalidLocationConstraint 创建桶时，指定的Location不合法或不存在。 指定正确的Location创桶。 400 Bad Request InvalidPart 一个或多个指定的段无法找到。这些段可能没有上传，或者指定的entity tag与段的entity tag不一致。 按照正确的段和entity tag合并段。 400 Bad Request InvalidPartOrder 段列表的顺序不是升序，段列表必须按段号升序排列。 按段号升序排列后重新合并。 400 Bad Request InvalidPolicyDocument 表单中的内容与策略文档中指定的条件不一致。 根据返回的错误消息体提示修改构造表单的policy重试。 400 Bad Request InvalidRedirectLocation 无效的重定向地址。 指定正确的地址。 400 Bad Requestvdf InvalidRequest 无效请求。 根据返回的错误消息体提示进行修改。 400 Bad Request InvalidRequestBody 请求体无效，需要消息体的请求没有上传消息体。 按照正确的格式上传消息体。 400 Bad Request InvalidTargetBucketForLogging delivery group对目标桶无ACL权限。 对目标桶配置ACL权限后重试。 400 Bad Request InvalidTag 桶标签不合规，不符合标签策略定义的规范，标签策略相关信息详见标签策略。 请更换符合标签策略规范的标签值。 400 Bad Request KeyTooLongError 提供的Key过长。 使用较短的Key。 400 Bad Request KMS.DisabledException SSE-KMS加密方式下，主密钥被禁用。 更换密钥后重试，或提交工单寻求技术支持。 400 Bad Request KMS.NotFoundException SSE-KMS加密方式下，主密钥不存在。 携带正确的主密钥重试。 400 Bad Request MalformedACLError 提供的XML格式错误，或者不符合要求的格式。 使用正确的XML格式重试。 400 Bad Request MalformedError 请求中携带的XML格式不正确。 使用正确的XML格式重试。 400 Bad Request MalformedLoggingStatus Logging的XML格式不正确。 使用正确的XML格式重试。 400 Bad Request MalformedPolicy Bucket policy检查不通过。 根据返回的错误消息体提示结合桶policy的要求进行修改。 400 Bad Request MalformedQuotaError Quota的XML格式不正确。 使用正确的XML格式重试。 400 Bad Request MalformedXML 当用户发送了一个配置项的错误格式的XML会出现这样的错误。 使用正确的XML格式重试。 400 Bad Request MaxMessageLengthExceeded 拷贝对象，带请求消息体。 拷贝对象不带消息体重试。 400 Bad Request MetadataTooLarge 元数据消息头超过了允许的最大元数据大小。 减少元数据消息头。 400 Bad Request MissingRegion 请求中缺少Region信息，且系统无默认Region。 请求中携带Region信息。 400 Bad Request MissingRequestBodyError 当用户发送一个空的XML文档作为请求时会发生。 提供正确的XML文档。 400 Bad Request MissingRequiredHeader 请求中缺少必要的头域。 提供必要的头域。 400 Bad Request MissingSecurityHeader 请求缺少一个必须的头。 提供必要的头域。 400 Bad Request MultipleContentLengths 多个Content-Length头域。 请检查封装头域或者提交工单寻求技术支持。 400 Bad Request TooManyBuckets 用户拥有的桶的数量达到了系统的上限，并且请求试图创建一个新桶。 删除部分桶后重试。 400 Bad Request TooManyCustomDomains 配置了过多的用户域。 删除部分用户域后重试。 400 Bad Request TooManyWrongSignature 因高频错误请求被拒绝服务。 更换正确的Access Key后重试。 400 Bad Request UnexpectedContent 该请求需要消息体而客户端没带，或该请求不需要消息体而客户端带了。 根据说明重试。 400 Bad Request UserKeyMustBeSpecified 该操作只有特殊用户可使用。 请提交工单寻求技术支持。 400 Bad Request FileGatewayBucket 并行文件系统不支持配置桶清单。 请使用对象桶。 403 Forbidden AccessDenied 拒绝访问，请求没有携带日期头域或者头域格式错误。 请求携带正确的日期头域。 403 Forbidden AccessForbidden 权限不足，桶未配置CORS或者CORS规则不匹配。 修改桶的CORS配置，或者根据桶的CORS配置发送匹配的OPTIONS请求。 403 Forbidden AllAccessDisabled 用户无权限执行某操作。桶名为禁用关键字。 更换桶名。 403 Forbidden DeregisterUserId 用户已经注销。 充值或重新开户。 403 Forbidden InArrearOrInsufficientBalance 用户欠费或余额不足而没有权限进行某种操作。 充值。 403 Forbidden InsufficientStorageSpace 存储空间不足。 超过配额限制，增加配额或删除部分对象。 403 Forbidden InvalidAccessKeyId 系统记录中不存在用户提供的Access Key Id。 携带正确的Access Key Id。 403 Forbidden InvalidObjectState 归档对象不能直接下载，需要先进行恢复才能下载。 先对对象进行恢复操作。 403 Forbidden NotSignedUp 您的账户还没有在系统中注册，必须先在系统中注册了才能使用该账户。 先注册OBS服务。 403 Forbidden RequestTimeTooSkewed 客户端发起请求的时间与OBS服务端的时间相差太大。 出于安全目的，OBS会校验客户端与OBS服务端的时间差，当该时间差大于15分钟时，OBS服务端会拒绝您的请求，从而出现此报错。 请检查客户端时间是否与当前OBS服务端时间相差太大。请根据本地UTC时间调整客户端时间后再访问。 403 Forbidden SignatureDoesNotMatch 请求中带的签名与系统计算得到的签名不一致。 检查您的Secret Access Key和签名计算方法。详细排查方法请参见签名不匹配（SignatureDoesNotMatch）如何处理。 403 Forbidden VirtualHostDomainRequired 未使用 虚拟主机 访问域名。 Host使用虚拟主机访问域名。 须知： 除获取桶列表之外的所有接口，都应当包含桶名。OBS基于DNS解析性能和可靠性的考虑，要求凡是携带桶名的请求，在构造URL的时候都必须将桶名放在domain前面，形成三级域名形式，又称为虚拟主机访问域名。 例如，如果您有一个位于cn-north-4区域的名为test-bucket的桶，期望访问桶中一个名为test-object对象的acl，正确的访问URL为https://test-bucket.obs.cn-north-4.myhuaweicloud.com/test-object?acl 403 Forbidden Unauthorized 用户未实名认证。 请实名认证后重试。 404 Not Found NoSuchBucket 指定的桶不存在。 先创桶再操作。 404 Not Found NoSuchBucketPolicy 桶policy不存在。 先配置桶policy。 404 Not Found NoSuchCORSConfiguration CORS配置不存在。 先配置CORS。 404 Not Found NoSuchCustomDomain 请求的用户域不存在。 先设置用户域。 404 Not Found NoSuchKey 指定的Key不存在。 先上传对象。 404 Not Found NoSuchLifecycleConfiguration 请求的LifeCycle不存在。 先配置LifeCycle。 404 Not Found NoSuchUpload 指定的多段上传不存在。Upload ID不存在，或者多段上传已经终止或完成。 使用存在的段或重新初始化段。 404 Not Found NoSuchVersion 请求中指定的version ID与现存的所有版本都不匹配。 使用正确的version ID。 404 Not Found NoSuchWebsiteConfiguration 请求的Website不存在。 先配置Website。 405 Method Not Allowed MethodNotAllowed 指定的方法不允许操作在请求的资源上。 对应返回的Message为：Specified method is not supported. 方法不允许。 请确认该区域是否支持所调用的接口功能。各功能发布的区域请参见OBS功能总览。 405 Method Not Allowed FsNotSupport posix桶不支持该API。 方法不允许。 请确认该区域是否支持所调用的接口功能。各功能发布的区域请参见OBS功能总览。 405 Method Not Allowed FeatureNotAvailable 不支持该特性。 服务端不支持特性，请提交工单寻求技术支持。 408 Request Timeout RequestTimeout 用户与Server之间的socket连接在超时时间内没有进行读写操作。 检查网络后重试，或提交工单寻求技术支持。 409 Conflict BucketAlreadyExists 请求的桶名已经存在。桶的命名空间是系统中所有用户共用的，选择一个不同的桶名再重试一次。 更换桶名。 409 Conflict BucketAlreadyOwnedByYou 发起该请求的用户已经创建过了这个名字的桶，并拥有这个桶。 不需要再创桶了。 409 Conflict BucketNotEmpty 用户尝试删除的桶不为空。 先删除桶中对象，然后再删桶。 409 Conflict InvalidBucketState 无效的桶状态，配置跨Region复制后不允许关闭桶多版本。 不关闭桶的多版本或取消跨Region复制。 409 Conflict OperationAborted 另外一个冲突的操作当前正作用在这个资源上，请重试。 等待一段时间后重试。 409 Conflict ServiceNotSupported 请求的方法服务端不支持。 服务端不支持，请提交工单寻求技术支持。 409 Conflict FsObjectConflict 并行文件系统中，文件和目录不支持互相覆盖，或者重命名的目标文件已经存在。 请确认待覆盖的目标类型（是文件还是目录），请确认重命名的目标文件是否存在。 409 ObjectNotAppendable ObjectNotAppendable 该对象不支持追加上传 请确认桶类型，并行文件系统不支持追加上传。请确认对象类型，归档存储和深度归档存储对象不支持追加上传。 411 Length Required MissingContentLength 必须要提供HTTP消息头中的Content-Length字段。 提供Content-Length消息头。 412 Precondition Failed PreconditionFailed 用户指定的先决条件中至少有一项没有包含。 根据返回消息体中的Condition提示进行修改。 414 URI Too Long Request-URI Too Large 请求使用的URI过长 请减少URI的长度。 416 Client Requested Range Not Satisfiable InvalidRange 请求的range不可获得。 携带正确的range重试。 500 Internal Server Error InternalError 系统遇到内部错误，请重试。 请提交工单寻求技术支持。 501 Not Implemented ServiceNotImplemented 请求的方法服务端没有实现。 当前不支持，请提交工单寻求技术支持。 503 Service Unavailable ServiceUnavailable 服务器过载或者内部错误异常。 等待一段时间后重试，或提交工单寻求技术支持。 503 Service Unavailable SlowDown 请降低请求频率。 请降低请求频率。 父主题： 异常处理(Harmony SDK)

返回结果 表5 返回结果 参数类型 描述 Response 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见Response。 表6 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult BaseResponseOutput 参数解释： 操作成功后的结果数据，详见BaseResponseOutput。 约束限制： 当Status大于300时为空。 表7 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服务端返回的详细错误码。 表8 BaseResponseOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。

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

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input SetBucketEncryptionInput 必选 参数解释： 设置桶加密配置接口入参，详见SetBucketEncryptionInput。 表2 SetBucketEncryptionInput 参数名称 参数类型 是否可选 描述 Bucket string 必选 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 取值范围： 长度为3～63个字符。 Rule BucketEncryptionRule 必选 参数解释： 桶加密配置信息，详见BucketEncryptionRule。 表3 BucketEncryptionRule 参数名称 参数类型 是否可选 描述 ApplyServerSideEncryptionByDefault ApplyServerSideEncryptionByDefault 必选 参数解释： 默认加密配置信息，详见ApplyServerSideEncryptionByDefault。 表4 ApplyServerSideEncryptionByDefault 参数名称 参数类型 是否可选 描述 SSEAlgorithm string 必选 参数解释： 表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。 取值范围： 可选值：kms，即选择SSE-KMS方式加密对象。 默认取值： 无 KMSMasterKeyID string 可选 参数解释： SSE-KMS加密方式下使用的KMS主密钥。 取值范围： 有效值支持两种格式： regionID:domainID(账号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属账号的账号ID，获取方法参见如何获取账号ID和用户ID？(Harmony SDK)； key_id是从 数据加密 服务创建的密钥ID，获取方法请参见查看密钥。 默认取值： 如果用户没有提供该头域，那么默认的主密钥将会被使用。 ProjectID string 可选 参数解释： SSE-KMS加密方式下KMS主密钥所属的项目ID。 约束限制： 项目ID需要与KMSMasterKeyID相匹配。 在未设置KMSMasterKeyID的情况下，不可设置项目ID。 取值范围： 项目ID获取方式请参见如何获取项目ID。 默认取值： 无

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

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input DeleteObjectInput 必选 参数解释： 复制对象接口入参，详见DeleteObjectInput。 表2 DeleteObjectInput 参数名称 参数类型 是否必选 描述 Bucket string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 Key string 必选 参数解释： 目标对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4. myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 VersionId string 可选 参数解释： 对象的版本号，用于删除指定版本号的对象。例如：G001117FCE89978B0000401205D5DC9。 取值范围： 长度为32的字符串。 默认取值： 无，如果不设置则默认删除最新版本的对象。

返回结果 表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。 默认取值： 无 DeleteMarker boolean 参数解释： 标识删除的对象是否是删除标记。 取值范围： true：是删除标记。 false：不是删除标记。 默认取值： false VersionId string 参数解释： 对象的版本号，用于删除指定版本号的对象。例如：G001117FCE89978B0000401205D5DC9。 取值范围： 长度为32的字符串。 默认取值： 无，如果不设置则默认删除最新版本的对象。

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

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input ListMultipartUploadsInput 必选 参数解释： 列举分段上传任务接口入参，详见ListMultipartUploadsInput。 表2 ListMultipartUploadsInput 参数名称 参数类型 是否必选 描述 Bucket string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 Prefix string 可选 参数解释： 限定返回的分段上传任务中的对象名必须带有prefix前缀。 例如，假设您拥有以下对象：logs/day1、logs/day2、logs/day3和ExampleObject.jpg。如果您将logs/指定为前缀，将返回以字符串“logs/”开头的三个对象所在的分段上传任务。如果您指定空的前缀且请求中没有其他过滤条件，将返回桶中的所有分段上传任务。 约束限制： 长度大于0且不超过1024的字符串。 默认取值： 无 MaxUploads number 可选 参数解释： 列举分段上传任务的最大数目。 约束限制： 当该参数超出1000时，按照默认的1000进行处理。 取值范围： 1~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。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 KeyMarker string 可选 参数解释： 列举分段上传任务的起始位置。表示列举时返回指定的KeyMarker之后的分段上传任务。 取值范围： 上次请求返回体的NextKeyMarker值。 默认取值： 无 UploadIdMarker string 可选 参数解释： 列举分段上传任务的起始位置（uploadId标识）。 约束限制： 只有与KeyMarker参数一起使用时才有意义，即列举时返回指定KeyMarker的UploadIdMarker之后的分段上传任务。 取值范围： 对象的分段上传任务ID，即上次请求返回体的NextUploadIdMarker值。 默认取值： 无 EncodingType string 可选 参数解释： 用于指定对响应中的Key进行指定类型的编码。如果Key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的Key进行编码。 取值范围： 可选值为url。 默认取值： 无，不设置则不编码。

功能说明 通过分段上传任务的ID，列举指定桶中已上传的段。 您可以列出特定多段上传任务或所有正在进行的多段上传任务的分段。列举已上传的段操作将返回您已为特定多段上传任务而上传的段信息。对于每个列举已上传的段请求，OBS将返回有关特定多段上传任务的分段信息，最多为1000个分段。如果多段上传中的段超过1000个，您必须发送一系列列举已上传的段请求以检索所有段。请注意，返回的分段列表不包括已合并的分段。

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

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 input ListPartsInput 必选 参数解释： 列举已上传的段接口入参，详见ListPartsInput。 表2 ListPartsInput 参数名称 参数类型 是否必选 描述 Bucket string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 Key string 必选 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 UploadId string 必选 参数解释： 分段上传任务的ID， 例如：000001648453845DBB78F2340DD460D8。 取值范围： 长度大于0且不超过32的字符串。 默认取值： 无 PartNumberMarker number 可选 参数解释： 列举已上传段的起始位置。 约束限制： 只有PartNumber数目大于该参数的Part会被列出。 默认取值： 无 MaxParts number 可选 参数解释： 列举已上传段的返回结果最大段数目，即分页时每一页中段数目。 约束限制： 如果该参数超出1000时，则按照默认的1000进行处理。 取值范围： 范围是[1，1000] 默认取值： 1000 EncodingType string 可选 参数解释： 用于指定对响应中的Key进行指定类型的编码。如果Key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的Key进行编码。 取值范围： 可选值为url。 默认取值： 无，不设置则不编码。

准备访问密钥 OBS通过用户账号中的AK和SK进行签名验证，确保通过授权的账号才能访问指定的OBS资源。获取访问密钥前，请确保访问OBS的IAM子用户已开启编程访问，开启方式详见修改或查看IAM用户信息。以下是对AK和SK的解释说明： AK：Access Key ID，接入键标识，用户在 对象存储服务 系统中的接入键标识，一个接入键标识唯一对应一个用户，一个用户可以同时拥有多个接入键标识。对象存储服务系统通过接入键标识识别访问系统的用户。 SK：Secret Access Key，安全接入键，用户在对象存储服务系统中的安全接入键，是用户访问对象存储服务系统的密钥，用户根据安全接入键和请求头域生成鉴权信息。安全接入键和接入键标识一一对应。 访问密钥分永久访问密钥（AK/SK）和临时访问密钥（AK/SK和SecurityToken）两种。每个用户最多可创建两个有效的永久访问密钥。临时访问密钥只在设置的有效期内能够访问OBS，过期后需要重新获取。出于安全性考虑，建议您使用临时访问密钥访问OBS，或使用永久访问密钥访问OBS时，定期更新您的访问密钥（AK/SK）。两种密钥的获取方式如下。 永久访问密钥： 登录管理控制台。 单击页面右上角的用户名，并选择“我的凭证”。 在“我的凭证”页面，单击左侧导航栏的“访问密钥”。 在“访问密钥”页面，单击“新增访问密钥”。 在弹出的“新增访问密钥”对话框中，输入登录密码和对应验证码。 用户如果未绑定邮箱和手机，则只需输入登录密码。 用户如果同时绑定了邮箱和手机，可以选择其中一种方式进行验证。 单击“确定”。 在弹出的“下载确认”提示框中，单击“确定”后，密钥会直接保存到浏览器默认的下载文件夹中。 打开下载下来的“credentials.csv”文件既可获取到访问密钥（AK和SK）。 每个用户最多可创建两个有效的访问密钥。 为防止访问密钥泄露，建议您将其保存到安全的位置。如果用户在此提示框中单击“取消”，则不会下载密钥，后续也将无法重新下载。如果需要使用访问密钥，可以重新创建新的访问密钥。 临时访问密钥： 临时AK/SK和SecurityToken是系统颁发给用户的临时访问令牌，通过接口设置有效期，范围为15分钟至24小时，过期后需要重新获取。临时AK/SK和SecurityToken遵循权限最小化原则。使用临时AK/SK鉴权时，临时AK/SK和SecurityToken必须同时使用。 获取临时访问密钥的接口请参考获取临时AK/SK和securitytoken。 OBS属于全局级服务，所以在获取临时访问密钥时，需要设置Token的使用范围取值为domain，表示获取的Token可以作用于全局服务，全局服务不区分项目或者区域。

返回结果 表3 返回结果 参数类型 描述 Response 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见Response。 表4 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult GetBucketEncryptionOutput 参数解释： 操作成功后的结果数据，详见GetBucketEncryptionOutput。 约束限制： 当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 GetBucketEncryptionOutput 参数名称 参数类型 描述 Rule BucketEncryptionRule 参数解释： 桶加密配置信息，详见BucketEncryptionRule。 表7 BucketEncryptionRule 参数名称 参数类型 描述 ApplyServerSideEncryptionByDefault ApplyServerSideEncryptionByDefault 参数解释： 默认加密配置信息，详见ApplyServerSideEncryptionByDefault。 表8 ApplyServerSideEncryptionByDefault 参数名称 参数类型 描述 SSEAlgorithm string 参数解释： 表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。 取值范围： 可选值：kms，即选择SSE-KMS方式加密对象。 默认取值： 无 KMSMasterKeyID string 参数解释： SSE-KMS加密方式下使用的KMS主密钥。 取值范围： 有效值支持两种格式： regionID:domainID(账号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属账号的账号ID，获取方法参见如何获取账号ID和用户ID？(Harmony SDK)； key_id是从数据加密服务创建的密钥ID，获取方法请参见查看密钥。 默认取值： 如果用户没有提供该头域，那么默认的主密钥将会被使用。 ProjectID string 参数解释： SSE-KMS加密方式下KMS主密钥所属的项目ID。 约束限制： 项目ID需要与KMSMasterKeyID相匹配。 在未设置KMSMasterKeyID的情况下，不可设置项目ID。 取值范围： 项目ID获取方式请参见如何获取项目ID。 默认取值： 无

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

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

接口约束 您必须是桶拥有者或拥有下载对象的权限，才能下载对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObject权限，如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 对于存储类别为归档存储或深度归档存储的对象，需要确认对象的状态为“已恢复”才能对其进行下载。