问题现象 当部署主机相关的应用时，出现如下日志： 以路径为例，有以下几种常见现象： 输入的路径参数有“\b”特殊字符导致部署报错，如下图所示。 图1 日志信息 输入的路径参数有“\f”特殊字符导致部署报错，如下图所示。 图2 日志信息 输入的路径参数有“\r”特殊字符导致部署报错，如下图所示。 图3 日志信息 输入的路径参数有“\t”特殊字符导致部署报错，如下图所示。 图4 日志信息 输入的路径参数有“\n”特殊字符导致部署报错，如下图所示。 图5 日志信息

问题现象 当部署主机相关的应用时，出现如下日志： 以路径为例，有以下几种常见现象： 输入的路径参数有“\b”特殊字符导致部署报错，如下图所示。 图1 日志信息 输入的路径参数有“\f”特殊字符导致部署报错，如下图所示。 图2 日志信息 输入的路径参数有“\r”特殊字符导致部署报错，如下图所示。 图3 日志信息 输入的路径参数有“\t”特殊字符导致部署报错，如下图所示。 图4 日志信息 输入的路径参数有“\n”特殊字符导致部署报错，如下图所示。 图5 日志信息

返回结果说明 表4 返回结果 参数类型 描述 表5 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表5。 表5 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult BaseResponseOuput 参数解释： 操作成功后的结果数据，详见BaseResponseOuput。 约束限制： 当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。

接口约束 您必须拥有obs:bucket:CreateBucket权限，才能创建桶。建议使用 IAM 进行授权，配置方式详见使用IAM自定义策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。创建桶时，如果使用的终端节点归属于默认区域华北-北京一（cn-north-1），则可以不指定区域；如果使用的终端节点归属于其他区域，则必须指定区域，且指定的区域必须与终端节点归属的区域一致。当前有效的区 域名 称可从这里查询。比如初始化时使用的终端节点EndPoint是obs.cn-north-4.myhuaweicloud.com，那么在创建桶的时候必须指定Location：cn-north-4才会创建成功，否则会返回状态码400。 同一账号下，可以创建多个存储桶，数量上限是100个（不区分地域），存储桶中的对象数量和大小没有限制。 新创建桶的桶名在OBS中必须是唯一的。如果是同一个用户重复创建同一区域的同名桶时返回HTTP状态码200。除此以外的其他场景重复创建同名桶返回HTTP状态码409，表明桶已存在。 用户删除桶后，需要等待30分钟才能创建同名桶和并行文件系统。 并不是所有区域都支持创建多AZ桶，您可以在产品价格详情页面，查询指定区域是否支持多AZ。

接口约束 您必须是桶拥有者或拥有复制对象的权限，才能复制对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 目标对象大小范围是[0, 5GB]，如果源对象大小超过5GB，只能使用复制段(Node.js SDK)功能复制部分对象。

返回结果 表5 返回结果 参数类型 描述 表6 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表6。 表6 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult 表8 参数解释： 操作成功后的结果数据，详见表8。 约束限制： 当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 CopyObjectOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 LastModified string 参数解释： 目标对象的最近一次修改时间（UTC时间）。 ETag string 参数解释： 目标对象的ETag值。对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。ETag只反映变化的内容，而不是其元数据。上传的对象或复制操作创建的对象，都有唯一的ETag。 约束限制： 当对象是服务端加密的对象时，ETag值不是对象的MD5值。 CopySourceVersionId string 参数解释： 源对象的版本号。 VersionId string 参数解释： 目标对象的版本号。

返回结果 表2 返回结果 参数类型 描述 表3 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表3。 表3 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult 表5 参数解释： 操作成功后的结果数据，详见表5。 约束限制： 当Status大于300时为空。 表4 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服务端返回的详细错误码。 表5 GetBucketAclOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 Owner Owner 参数解释： 桶的所有者的账号ID，详见Owner。 Grants Grant[] 参数解释： 被授权用户权限信息，详见Grant。 表6 Owner 参数名称 参数类型 是否必选 描述 ID string 作为请求参数时必选 参数解释： 所有者的账号ID，即domain_id。 取值范围： 如何获取账号ID请参见如何获取账号ID和用户ID？(Node.js SDK) 默认取值： 无 DisplayName string 可选 参数解释： 所有者的账号用户名。 默认取值： 无 表7 Grant 参数名称 参数类型 描述 Grantee Grantee 参数解释： 被授权用户相关信息，详见Grantee。 Permission string 参数解释： 被授予的权限，详见PermissionType。 表8 Grantee 参数名称 参数类型 描述 Type string 参数解释： 被授权用户的类型，详见GranteeType。 ID string 参数解释： 被授权用户的账号ID，即domain_id。 Name string 参数解释： 被授权用户的账号名。 URI string 参数解释： 被授权的用户组，详见GroupUriType。 表9 GranteeType 常量值 说明 Group 授权给用户组。 CanonicalUser 授权给单个用户。 表10 GroupUriType 常量名 原始值 说明 ObsClient.enums.GroupAllUsers AllUsers 所有用户。 ObsClient.enums.GroupAuthenticatedUsers AuthenticatedUsers 授权用户，已废弃。 ObsClient.enums.GroupLogDelivery LogDelivery 日志投递组，已废弃。 表11 PermissionType 常量名 原始值 说明 ObsClient.enums.PermissionRead READ 如果有桶的读权限，则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 如果有对象的读权限，则可以获取该对象内容和元数据。 ObsClient.enums.PermissionWrite WRITE 如果有桶的写权限，则可以上传、覆盖和删除该桶内任何对象和段。 此权限在对象上不适用。 ObsClient.enums.PermissionReadAcp READ_ACP 如果有读ACP的权限，则可以获取对应的桶或对象的权限控制列表（ACL）。 桶或对象的所有者永远拥有读对应桶或对象ACP的权限。 ObsClient.enums.PermissionWriteAcp WRITE_ACP 如果有写ACP的权限，则可以更新对应桶或对象的权限控制列表（ACL）。 桶或对象的所有者永远拥有写对应桶或对象的ACP的权限。 拥有了写ACP的权限，由于可以更改权限控制策略，实际上意味着拥有了完全访问的权限。 ObsClient.enums.PermissionFullControl FULL_CONTROL 如果有桶的完全控制权限意味着拥有PermissionRead、PermissionWrite、PermissionReadAcp和PermissionWriteAcp的权限。 如果有对象的完全控制权限意味着拥有PermissionRead、PermissionReadAcp和PermissionWriteAcp的权限。

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

功能介绍 访问控制列表（Access Control List，ACL）用于资源拥有者给其他账号授予资源的访问权限。默认情况下，创建存储桶或对象时仅资源拥有者对资源的完全控制权限，即桶创建者对桶拥有完全控制权限，对象上传者对对象拥有完全控制权限，而其他账号默认无权访问资源。如果资源拥有者想授予其他账号资源的读写权限，可以使用ACL实现。OBS桶和对象的ACL是基于账号进行授权，授权后对账号和账号下的IAM用户都生效。 了解更多可参见ACL权限控制方式介绍。 调用获取桶ACL接口，您可以获取指定桶的ACL。

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

返回结果 表3 返回结果 参数类型 描述 表4 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 参数解释： 接口返回信息，详见表4。 表4 Response 参数名称 参数类型 描述 CommonMsg ICommonMsg 参数解释： 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult 表6 参数解释： 操作成功后的结果数据，详见表6。 约束限制： 当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 UploadFileOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 ETag string 参数解释： 合并段后根据各个段的ETag值计算出的结果。对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。ETag只反映变化的内容，而不是其元数据。上传的对象或复制操作创建的对象，都有唯一的ETag。 约束限制： 当对象是服务端加密的对象时，ETag值不是对象的MD5值。 Bucket string 参数解释： 合并段所在的桶名。 Key string 参数解释： 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径，路径中不包含桶名。 例如，您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中，对象名为folder/test.txt。 Location string 参数解释： 合并段后得到的对象的url。 例如：https://example-Bucket.obs.regions.myhuaweicloud.com/example-Object VersionId string 参数解释： 合并段后得到的对象版本号。如果桶的多版本状态为开启，则会返回对象的版本号。 SseKms string 参数解释： 表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。 SseKmsKey string 参数解释： SSE-KMS加密方式下使用的KMS主密钥的ID值。 SseC string 参数解释： 表示服务端加密是SSE-C方式。对象使用SSE-C加密方式。 SseCKeyMd5 string 参数解释： SSE-C方式下加密使用密钥的MD5值，该值用于验证密钥传输过程中是否出错。 约束限制： 由密钥值经过MD5加密再经过Base64编码后得到，示例：4XvB3tbNTN+tIEVa0/fGaQ==

请求参数 表1 请求参数列表 参数名称 类型 是否必选 说明 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的字符串。 默认取值： 无 UploadFile string 可选 参数解释： 待上传对象的源文件路径。 约束限制： 无 取值范围： 无 默认取值： 无 PartSize number 可选 参数解释： 当前段的长度。 约束限制： 无 取值范围： 100KB~5GB，单位：字节。 默认取值： 102400字节 TaskNum number 可选 参数解释： 分段上传时的最大并发数。 约束限制： 无 取值范围： 1~10000 默认取值： 1，即不设置则默认串行上传。 ProgressCallback function 可选 参数解释： 获取上传进度的回调函数。 说明： 该回调函数依次包含三个参数：已上传的字节数、总字节数、已使用的时间（单位：秒）。 约束限制： 无 取值范围： 无 默认取值： 无 ResumeCallback function 可选 参数解释： 获取取消断点续传控制参数的回调函数。 约束限制： 无 取值范围： 无 默认取值： 无 说明： 该回调函数有一个参数：取消断点续传上传任务控制参数，该参数有暂停断点续传上传任务和取消断点续传上传任务两个方法； 可以调用取消断点续传上传任务控制参数的cancel方法来暂停断点续传上传任务。 可以调用取消断点续传上传任务控制参数的abort方法来取消断点续传上传任务。 EnableCheckpoint boolean 可选 参数解释： 是否开启断点续传模式。 约束限制： 无 取值范围： true：开启断点续传模式。 false：关闭断点续传模式，此时断点续传上传接口退化成对分段上传的简单封装，不会产生checkpoint文件。 默认取值： false CheckpointFile string 可选 参数解释： 断点续传过程中，会生成一个进度记录文件，文件中会记录段的上传进度和段的相关信息。checkpointFile参数为该记录文件的文件路径。 约束限制： 仅在断点续传模式下有效。 取值范围： 无 默认取值： 当该值为空时，默认为待上传的本地文件的同级目录。 EnableCheckSum boolean 可选 参数解释： 是否校验待上传文件的内容，如果开启该参数，会在每次任务重新开始前对待上传文件进行校验，验证是否与任务初始化时使用文件为同一文件。 约束限制： 仅在断点续传模式下有效。 取值范围： true：校验待上传文件的内容。 false：不校验待上传文件的内容。 默认取值： false ContentType string 可选 参数解释： 待上传对象的文件类型（MIME类型）。Content-Type（MIME）用于标识发送或接收数据的类型，浏览器根据该参数来决定数据的打开方式。 约束限制： 无 取值范围： 常见的Content-Type（MIME）列表参见如何理解Content-Type（MIME）(Node.js SDK) 默认取值： 如果您在上传Object时未指定Content-Type，SDK会根据指定Object名称的后缀名来判定文件类型并自动填充Content-Type。 ACL AclType 可选 参数解释： 创建对象时可指定的预定义访问策略，有关访问控制列表（Access Control List，ACL）功能的详细信息可参见ACL功能介绍。 约束限制： 无 取值范围： 可选择的访问策略选项参见AclType。 默认取值： 无 WebsiteRedirectLocation string 可选 参数解释： 当桶设置了Website配置，可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL。 例如，重定向请求到桶内另一对象： WebsiteRedirectLocation:/anotherPage.html 或重定向请求到一个外部URL： WebsiteRedirectLocation:http://www.example.com/ OBS将这个值从头域中取出，保存在对象的元数据“WebsiteRedirectLocation”中。 约束限制： 必须以“/”、“http://”或“https://”开头，长度不超过2KB。 OBS仅支持为桶根目录下的对象设置重定向，不支持为桶中文件夹下的对象设置重定向。 取值范围： 无 默认取值： 无 SseKmsKey string 可选 参数解释： SSE-KMS加密方式下使用的KMS主密钥的ID值。 约束限制： 有效值支持两种格式： regionID:domainID(账号ID):key/key_id key_id 其中： regionID是使用密钥所属region的ID，可在地区和终端节点页面获取； domainID是使用密钥所属账号的账号ID，获取方法参见如何获取账号ID和用户ID？(Node.js SDK)； key_id是从 数据加密 服务创建的密钥ID，获取方法请参见查看密钥。 取值范围： 无 默认取值： 如果用户没有提供该头域，那么默认的主密钥将会被使用。 如果默认主密钥不存在，将默认创建并使用。 SseC string 当使用SSE-C方式时，必选 参数解释： 表示服务端加密是SSE-C方式。对象使用SSE-C加密方式。 约束限制： 仅支持AES256。 取值范围： 可选值：AES256，即选择SSE-C方式加密对象。 默认取值： 无 SseCKey string 作为请求参数时必选 参数解释： SSE-C方式下加密使用的密钥，该密钥用于加密对象。 约束限制： 该头域由256bit的密钥经过Base64编码得到，示例：K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw= 取值范围： 无 默认取值： 无 Metadata object 可选 参数解释： 待上传对象的自定义元数据。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 取值范围： 无 默认取值： 无 表2 AclType 常量名 原始值 说明 ObsClient.enums.AclPrivate private 私有读写。 桶或对象的所有者拥有完全控制的权限，其他任何人都没有访问权限。 ObsClient.enums.AclPublicRead public-read 公共读私有写。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 设在对象上，所有人可以获取该对象内容和元数据。 ObsClient.enums.AclPublicReadWrite public-read-write 公共读写。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、复制段、取消多段上传任务。 设在对象上，所有人可以获取该对象内容和元数据。 ObsClient.enums.AclPublicReadDelivered public-read-delivered 桶公共读，桶内对象公共读。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本，可以获取该桶内对象的内容和元数据。 说明： AclPublicReadDelivered不能应用于对象。 ObsClient.enums.AclPublicReadWriteDelivered public-read-write-delivered 桶公共读写，桶内对象公共读写。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、复制段、取消多段上传任务，可以获取该桶内对象的内容和元数据。 说明： AclPublicReadWriteDelivered不能应用于对象。 ObsClient.enums.AclBucketOwnerFullControl bucket-owner-full-control 设在对象上，桶和对象的所有者拥有对象的完全控制权限，其他任何人都没有访问权限。 默认情况下，上传对象至其他用户的桶中，桶拥有者没有对象的控制权限。对象拥有者为桶拥有者添加此权限控制策略后，桶所有者可以完全控制对象。例如，用户A上传对象x至用户B的桶中，系统默认用户B没有对象x的控制权。当用户A为对象x设置bucket-owner-full-control策略后，用户B就拥有了对象x的控制权。

功能说明 断点续传上传接口是利用分段上传特性实现的，是对分段上传的封装和加强，解决上传大文件时由于网络不稳定或程序崩溃导致上传失败的问题。 当上传大文件时，经常出现因网络不稳定或程序崩溃导致上传失败的情况。失败后再次重新上传不仅浪费资源，而且当网络不稳定时仍然有上传失败的风险。断点续传上传接口能有效地解决此类问题引起的上传失败，其原理是将待上传的文件分成若干个分段分别上传，并实时地将每段上传结果统一记录在checkpoint文件中，仅当所有分段都上传成功时返回上传成功的结果，否则在回调函数中返回错误码提醒用户再次调用接口进行重新上传（重新上传时因为有checkpoint文件记录当前的上传进度，避免重新上传所有分段，从而节省资源提高效率）。 断点续传上传接口不仅能在失败重传时节省资源提高效率，还因其对分段进行并发上传的机制能加快上传速度，能帮助用户快速完成上传业务；且其对用户透明，用户不用关心checkpoint文件的创建和删除、分段任务的切分、并发上传的实现等内部细节。

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

请求参数 表1 请求参数列表 参数名称 参数类型 是否必选 描述 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的字符串。 默认取值： 无 VersionId string 可选 参数解释： 对象的版本号。例如：G001117FCE89978B0000401205D5DC9A。 约束限制： 无 取值范围： 长度为32的字符串。 默认取值： 无 ACL AclType 可选 参数解释： 预定义访问策略。 约束限制： Owner、Grants与ACL不能全为空。 取值范围： AclType取值详见AclType。 默认取值： 无 Owner Owner 可选 参数解释： 桶的所有者。 约束限制： Owner和Grants必须配套使用，且与ACL互斥。 Owner、Grants与ACL不能全为空。 取值范围： 详见Owner。 默认取值： 无 Delivered boolean 可选 参数解释： 对象ACL是否继承桶的ACL。 取值范围： true：对象ACL继承桶的ACL。 false：对象ACL不继承桶的ACL。 默认取值： 无 Grants Grant[] 可选 参数解释： 被授权用户权限信息。 约束限制： Owner和Grants必须配套使用，且与ACL互斥。 Owner、Grants与ACL不能全为空。 取值范围： 详见Grant。 默认取值： 无 表2 AclType 常量名 原始值 说明 ObsClient.enums.AclPrivate private 私有读写。 桶或对象的所有者拥有完全控制的权限，其他任何人都没有访问权限。 ObsClient.enums.AclPublicRead public-read 公共读私有写。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 设在对象上，所有人可以获取该对象内容和元数据。 ObsClient.enums.AclPublicReadWrite public-read-write 公共读写。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、复制段、取消多段上传任务。 设在对象上，所有人可以获取该对象内容和元数据。 ObsClient.enums.AclPublicReadDelivered public-read-delivered 桶公共读，桶内对象公共读。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本，可以获取该桶内对象的内容和元数据。 说明： AclPublicReadDelivered不能应用于对象。 ObsClient.enums.AclPublicReadWriteDelivered public-read-write-delivered 桶公共读写，桶内对象公共读写。 设在桶上，所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、复制段、取消多段上传任务，可以获取该桶内对象的内容和元数据。 说明： AclPublicReadWriteDelivered不能应用于对象。 ObsClient.enums.AclBucketOwnerFullControl bucket-owner-full-control 设在对象上，桶和对象的所有者拥有对象的完全控制权限，其他任何人都没有访问权限。 默认情况下，上传对象至其他用户的桶中，桶拥有者没有对象的控制权限。对象拥有者为桶拥有者添加此权限控制策略后，桶所有者可以完全控制对象。例如，用户A上传对象x至用户B的桶中，系统默认用户B没有对象x的控制权。当用户A为对象x设置bucket-owner-full-control策略后，用户B就拥有了对象x的控制权。 表3 Owner 参数名称 参数类型 是否必选 描述 ID string 作为请求参数时必选 参数解释： 所有者的账号ID，即domain_id。 取值范围： 如何获取账号ID请参见如何获取账号ID和用户ID？(Node.js SDK) 默认取值： 无 DisplayName string 可选 参数解释： 所有者的账号用户名。 默认取值： 无 表4 Grant 参数名称 参数类型 是否必选 描述 Grantee Grantee 作为请求参数时必选 参数解释： 被授权用户相关信息，详见Grantee。 Permission PermissionType 作为请求参数时必选 参数解释： 被授予的权限。 取值范围： 权限取值范围详见PermissionType。 默认取值： 无 表5 Grantee 参数名称 参数类型 是否必选 描述 Type string 作为请求参数时必选 参数解释： 被授权用户的类型。 取值范围： 被授权用户类型的取值范围详见GranteeType。 默认取值： 无 ID string 作为请求参数时，如果Type为用户类型则必选。 参数解释： 被授权用户的账号ID，即domain_id。 取值范围： 如何获取账号ID请参见如何获取账号ID和用户ID？(Node.js SDK) 默认取值： 无 Name string 作为请求参数时可选 参数解释： 被授权用户的账号名。 约束限制： 不支持中文。 只能以字母开头。 长度为6-32个字符。 只能包含英文字母、数字或特殊字符(-_)。 默认取值： 无 URI GroupUriType 作为请求参数时，如果Type为用户组类型则必选。 参数解释： 被授权的用户组。 取值范围： 授权用户组取值范围详见GroupUriType。 默认取值： 无 表6 GranteeType 常量值 说明 Group 授权给用户组。 CanonicalUser 授权给单个用户。 表7 GroupUriType 常量名 原始值 说明 ObsClient.enums.GroupAllUsers AllUsers 所有用户。 ObsClient.enums.GroupAuthenticatedUsers AuthenticatedUsers 授权用户，已废弃。 ObsClient.enums.GroupLogDelivery LogDelivery 日志投递组，已废弃。 表8 PermissionType 常量名 原始值 说明 ObsClient.enums.PermissionRead READ 如果有桶的读权限，则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 如果有对象的读权限，则可以获取该对象内容和元数据。 ObsClient.enums.PermissionWrite WRITE 如果有桶的写权限，则可以上传、覆盖和删除该桶内任何对象和段。 此权限在对象上不适用。 ObsClient.enums.PermissionReadAcp READ_ACP 如果有读ACP的权限，则可以获取对应的桶或对象的权限控制列表（ACL）。 桶或对象的所有者永远拥有读对应桶或对象ACP的权限。 ObsClient.enums.PermissionWriteAcp WRITE_ACP 如果有写ACP的权限，则可以更新对应桶或对象的权限控制列表（ACL）。 桶或对象的所有者永远拥有写对应桶或对象的ACP的权限。 拥有了写ACP的权限，由于可以更改权限控制策略，实际上意味着拥有了完全访问的权限。 ObsClient.enums.PermissionFullControl FULL_CONTROL 如果有桶的完全控制权限意味着拥有PermissionRead、PermissionWrite、PermissionReadAcp和PermissionWriteAcp的权限。 如果有对象的完全控制权限意味着拥有PermissionRead、PermissionReadAcp和PermissionWriteAcp的权限。