对象存储服务 OBS-华为云

对象存储服务 OBS-流式下载(Node.js SDK):返回结果

返回结果表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 GetObjectOutput 参数名称参数类型描述 RequestId string 参数解释： OBS服务端返回的请求ID。 DeleteMarker string 参数解释：标识删除的对象是否是删除标记。 LastModified string 参数解释：对象的最近一次修改时间。 ContentLength string 参数解释：对象数据的长度。 CacheControl string 参数解释：响应中的Cache-Control头。 ContentDisposition string 参数解释：响应中的Content-Disposition头。 ContentEncoding string 参数解释：响应中的Content-Encoding头 ContentLanguage string 参数解释：响应中的Content-Language头 ContentType string 参数解释：对象的MIME类型。 Expires string 参数解释：响应中的Expires头。 ETag string 参数解释：对象的ETag值。 VersionId string 参数解释：对象的版本号。 WebsiteRedirectLocation string 参数解释：当桶设置了Website配置，该参数指明对象的重定向地址。 StorageClass string 参数解释：对象的存储类型，当对象存储类型是标准存储时，该值为空。 Restore string 参数解释：归档存储类别对象的恢复状态。 Expiration string 参数解释：对象的详细过期信息。 Content string | stream.Readable 参数解释：对象的内容。当设置了SaveAsFile时该值为空；当设置了SaveAsStream且为true时该值为stream.Readable对象；当SaveAsFile和SaveAsStream都未设置时为Buffer对象。 Metadata object 参数解释：对象自定义元数据。需要在桶的CORS配置中增加允许响应中可返回的附加头域。例如，新增x-amz-meta-property1以获取自定义元数据property1。

对象存储服务 OBS

对象存储服务 OBS-流式下载(Node.js SDK):接口约束

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

对象存储服务 OBS

对象存储服务 OBS-追加上传(Node.js SDK):接口约束

接口约束您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。同一个桶中存储的对象名必须是唯一的。启用服务端加密SSE-C方式时，追加上传和初始化段一样，设置诸如x-obs-server-side-encryption之类的请求Header，后续追加上传也必须携带。启用服务端加密SSE-KMS方式时，有且只有第一次上传且桶内不存在同名对象时，才设置诸如x-obs-server-side-encryption之类的请求Header，后续追加上传不携带，会继承之前的设置。每次追加上传的长度不能超过对象长度上限5G的限制。每个Appendable对象追加上传次数最多为10000次。如果对象存储类别为COLD（归档存储）或深度归档存储，则不能调用该接口。如果桶设置了跨区域复制配置，则不能调用该接口。并行文件系统不支持追加上传对象。 ObsClient.putObject上传的对象可覆盖ObsClient.appendObject上传的对象，覆盖后对象变为普通对象，不可再进行追加上传。第一次调用追加上传时，如果已存在同名的普通对象，则会抛出异常（HTTP状态码为409）。追加上传返回的ETag是当次追加数据内容的ETag，不是完整对象的ETag。

对象存储服务 OBS

对象存储服务 OBS-追加上传(Node.js SDK):返回结果

返回结果表4 返回结果参数类型描述表5 说明：该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。参数解释：接口返回信息，详见表5。表5 Response 参数名称参数类型描述 CommonMsg ICommonMsg 参数解释：接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见ICommonMsg。 InterfaceResult 表7 参数解释：操作成功后的结果数据，详见表7。约束限制：当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 AppendObjectOutput 参数名称参数类型描述 RequestId string 参数解释： OBS服务端返回的请求ID。 VersionId string 参数解释：对象的版本号。如果桶的多版本状态为开启，则会返回对象的版本号。 ETag string 参数解释：对象的ETag值，即base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。ETag只反映变化的内容，而不是其元数据。上传的对象或复制操作创建的对象，都有唯一的ETag。约束限制：当对象是服务端加密的对象时，ETag值不是对象的MD5值。 NextAppendPosition int64 参数解释：下一次追加上传请求应该提供的追加写位置（position）。约束限制：需要追加写的对象首次上传时就必须指定为0，下次追加需要填写的值为服务端本次上传成功返回消息的NextAppendPosition，也可通过ObsClient.getObjectMetadata接口获取NextAppendPosition。 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==

对象存储服务 OBS

对象存储服务 OBS-基于表单上传(Node.js SDK):功能说明

功能说明基于表单上传是使用HTML表单形式上传对象到指定桶中，对象最大不能超过5GB。您可以通过ObsClient.createPostSignatureSync生成基于表单上传的请求参数。使用Node.js代码模拟表单上传的完整代码示例，参见post-object-sample。您也可以通过如下步骤进行表单上传：使用ObsClient.createPostSignatureSync生成用于鉴权的请求参数。准备表单HTML页面。将生成的请求参数填入HTML页面。选择本地文件，进行表单上传。

对象存储服务 OBS

对象存储服务 OBS-基于表单上传(Node.js SDK):请求参数

请求参数表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的字符串。默认取值：无 Expires Number 可选参数解释：表单上传鉴权的过期时间。约束限制：无取值范围：正整数。单位：秒。默认取值： 300 FormParams Object 可选参数解释：除key、policy、signature外，表单上传时的其他参数。约束限制：无取值范围： acl cache-control content-type content-disposition content-encoding expires 默认取值：无

对象存储服务 OBS

对象存储服务 OBS-创建文件夹(Node.js SDK):接口约束

接口约束您必须是桶拥有者或拥有上传对象的权限，才能上传对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:PutObject权限，如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。创建文件夹本质上来说是创建了一个大小为0且对象名以“/”结尾的对象。

对象存储服务 OBS

对象存储服务 OBS-范围下载(Node.js SDK):返回结果

返回结果表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 GetObjectOutput 参数名称参数类型描述 RequestId string 参数解释： OBS服务端返回的请求ID。 DeleteMarker string 参数解释：标识删除的对象是否是删除标记。 LastModified string 参数解释：对象的最近一次修改时间。 ContentLength string 参数解释：对象数据的长度。 CacheControl string 参数解释：响应中的Cache-Control头。 ContentDisposition string 参数解释：响应中的Content-Disposition头。 ContentEncoding string 参数解释：响应中的Content-Encoding头 ContentLanguage string 参数解释：响应中的Content-Language头 ContentType string 参数解释：对象的MIME类型。 Expires string 参数解释：响应中的Expires头。 ETag string 参数解释：对象的ETag值。 VersionId string 参数解释：对象的版本号。 WebsiteRedirectLocation string 参数解释：当桶设置了Website配置，该参数指明对象的重定向地址。 StorageClass string 参数解释：对象的存储类型，当对象存储类型是标准存储时，该值为空。 Restore string 参数解释：归档存储类型对象的恢复状态。 Expiration string 参数解释：对象的详细过期信息。 Content string | stream.Readable 参数解释：对象的内容。当设置了SaveAsFile时该值为空；当设置了SaveAsStream且为true时该值为stream.Readable对象；当SaveAsFile和SaveAsStream都未设置时为Buffer对象。 Metadata object 参数解释：对象自定义元数据。需要在桶的CORS配置中增加允许响应中可返回的附加头域。例如，新增x-amz-meta-property1以获取自定义元数据property1。

对象存储服务 OBS

对象存储服务 OBS-范围下载(Node.js SDK):功能说明

功能说明您可以根据需要将存储在OBS中的对象下载到本地。如果只需要下载对象的其中一部分数据，可以使用范围下载，下载指定范围的数据。如果指定的下载范围是0~1000，则返回第0到第1000个字节的数据，包括第1000个，共1001字节的数据，即[0， 1000]。如果指定的范围无效，则返回整个对象的数据。可以利用范围下载并发下载大对象，详细代码示例请参考concurrent-download-object-sample。

对象存储服务 OBS

对象存储服务 OBS-范围下载(Node.js SDK):接口约束

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

对象存储服务 OBS

对象存储服务 OBS-获取桶配额(Node.js SDK):返回结果

返回结果表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 GetBucketQuotaOutput 参数名称参数类型描述 RequestId string 参数解释： OBS服务端返回的请求ID。 StorageQuota number 参数解释：桶的配额值。默认取值： 0，表示没有限制桶配额。

对象存储服务 OBS

对象存储服务 OBS-获取桶配额(Node.js SDK):请求参数

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

对象存储服务 OBS

对象存储服务 OBS-获取桶配额(Node.js SDK):接口约束

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

对象存储服务 OBS

对象存储服务 OBS-获取桶存储类别(Node.js SDK):接口约束

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

对象存储服务 OBS

对象存储服务 OBS-获取桶存储类别(Node.js SDK):请求参数

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

对象存储服务 OBS

云服务器内容精选

对象存储服务 OBS

7*24

备案

专业服务

退订

建议反馈

售前咨询热线