华为云用户手册

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

返回结果 表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的权限。

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

功能说明 OBS支持对对象的操作进行权限控制。默认情况下，只有对象的创建者才有该对象的读写权限。用户也可以设置其他的访问策略，比如对一个对象可以设置公共访问策略，允许所有人对其都有读权限。SSE-KMS方式加密的对象即使设置了ACL，跨租户也不生效。 OBS用户在上传对象时可以设置权限控制策略，也可以通过ACL操作API接口对已存在的对象更改或者获取ACL(access control list) 。 对象访问权限与桶访问权限类似（参见桶访问权限），也可支持预定义访问策略或直接设置。 对象访问权限（ACL）可以通过三种方式设置： 上传对象时指定预定义访问策略，参见代码示例一：上传对象时指定预定义访问策略。 调用ObsClient.setObjectAcl指定预定义访问策略，参见代码示例二：为对象设置预定义访问策略。 调用ObsClient.setObjectAcl直接设置，参见代码示例三：直接设置对象访问权限。

返回结果 表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 GetObjectAclOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 VersionId string 参数解释： 对象的版本号。例如：G001117FCE89978B0000401205D5DC9A。 Owner Owner 参数解释： 对象的所有者，详见Owner。 Delivered string 参数解释： 桶的ACL是否向桶内对象传递。 Grants Grant[] 参数解释： 被授权用户权限信息，详见Grant。 表6 Owner 参数名称 参数类型 是否必选 描述 ID string 作为请求参数时必选 参数解释： 所有者的账号ID，即domain_id。 取值范围： 如何获取账号ID请参见如何获取账号ID和用户ID？(Node.js SDK) 默认取值： 无 DisplayName string 可选 参数解释： 所有者的账号用户名。 默认取值： 无 表7 Grant 参数名称 参数类型 是否必选 描述 Grantee Grantee 作为请求参数时必选 参数解释： 被授权用户相关信息，详见Grantee。 Permission PermissionType 作为请求参数时必选 参数解释： 被授予的权限。 取值范围： 权限取值范围详见PermissionType。 表8 Grantee 参数名称 参数类型 是否必选 描述 Type string 作为请求参数时必选 参数解释： 被授权用户的类型。 取值范围： 被授权用户类型的取值范围详见GranteeType。 默认取值： 无 ID string 作为请求参数时，如果Type为用户类型则必选。 参数解释： 被授权用户的账号ID，即domain_id。 取值范围： 如何获取账号ID请参见如何获取账号ID和用户ID？(Node.js SDK) 默认取值： 无 Name string 作为请求参数时可选 参数解释： 被授权用户的账号名。 约束限制： 不支持中文。 只能以字母开头。 长度为6-32个字符。 只能包含英文字母、数字或特殊字符(-_)。 默认取值： 无 URI GroupUriType 作为请求参数时，如果Type为用户组类型则必选。 参数解释： 被授权的用户组。 取值范围： 授权用户组取值范围详见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 请求参数列表 参数名称 参数类型 是否必选 描述 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的权限，才能获取对象ACL。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:GetObjectAcl权限，如果使用桶策略则需授予GetObjectAcl权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

接口约束 您必须是桶拥有者或拥有设置对象元数据的权限，才能设置对象元数据。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:ModifyObjectMetaData权限，如果使用桶策略则需授予ModifyObjectMetaData权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、配置对象策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。 当桶开启多版本控制时，最新版本的对象支持设置元数据，历史版本的对象不支持设置元数据。 对于存储类别为归档或深度归档存储的对象，不能对其设置对象的元数据。

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

返回结果 表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。

请求参数 表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的字符串。 默认取值： 无 DownloadFile string 可选 参数解释： 下载对象的本地文件全路径。当该值为空时，默认为当前程序的运行目录。 约束限制： 包含文件名，如aa/bb.txt 取值范围： 无 默认取值： 无 PartSize number 可选 参数解释： 当前段的长度。 约束限制： 无 取值范围： 100KB~5GB，单位：字节。 默认取值： 102400字节 TaskNum number 可选 参数解释： 分段下载时的最大并发数。 约束限制： 无 取值范围： 1~10000 默认取值： 1，即不设置则默认串行下载。 ProgressCallback function 可选 参数解释： 获取下载进度的回调函数。 说明： 该回调函数依次包含三个参数：已下载的字节数、总字节数、已使用的时间（单位：秒）。 约束限制： 无 取值范围： 无 默认取值： 无 ResumeCallback function 可选 参数解释： 获取取消断点续传控制参数的回调函数。 约束限制： 无 取值范围： 无 默认取值： 无 说明： 该回调函数有一个参数：取消断点续传下载任务控制参数； 可以调用取消断点续传下载任务控制参数的cancel方法来暂停断点续传下载任务。 EnableCheckpoint boolean 可选 参数解释： 是否开启断点续传模式。 约束限制： 无 取值范围： true：开启断点续传模式。 false：关闭断点续传模式，此时断点续传下载接口退化成对分段下载的简单封装，不会产生checkpoint文件 默认取值： false CheckpointFile string 可选 参数解释： 断点续传过程中，会生成一个进度记录文件，文件中会记录段的下载进度和段的相关信息。checkpointFile参数为该记录文件的文件路径。 约束限制： 仅在断点续传模式下有效。 取值范围： 无 默认取值： 当该值为空时，默认为待下载的本地文件的同级目录。 IfMatch string 可选 参数解释： 指定一个预设的Etag值，如果下载对象的ETag值与该参数值相同，则返回对象内容，否则返回错误。 约束限制： 无 取值范围： 长度为32的字符串。 默认取值： 无 IfModifiedSince string 可选 参数解释： 如果对象的修改时间晚于该参数值指定的时间，则返回对象内容，否则返回异常码。 约束限制： 该参数值必须符合http://www.ietf.org/rfc/rfc2616.txt规定的HTTP时间格式。 取值范围： 无 默认取值： 无 IfNoneMatch string 可选 参数解释： 指定一个预设的Etag值，如果下载对象的ETag值与该参数值不相同，则返回对象内容，否则返回错误。 约束限制： 无 取值范围： 长度为32的字符串。 默认取值： 无 IfUnmodifiedSince string 可选 参数解释： 如果对象的修改时间早于该参数值指定的时间，则返回对象内容，否则返回异常码。 约束限制： 该参数值必须符合http://www.ietf.org/rfc/rfc2616.txt规定的HTTP时间格式。 取值范围： 无 默认取值： 无 SseC string 当使用SSE-C方式时，必选 参数解释： 以SSE-C方式解密对象。 约束限制： 仅支持AES256。 取值范围： 可选值：AES256。 默认取值： 无 SseCKey string 当使用SSE-C方式时，必选 参数解释： SSE-C方式下解密的密钥，该密钥用于解密对象。 约束限制： 该头域由256bit的密钥经过Base64编码得到，示例：K7QkYpBkM5+hca27fsNkUnNVaobncnLht/rCB2o/9Cw= 取值范围： 无 默认取值： 无 如果包含IfUnmodifiedSince并且不符合或者包含IfMatch并且不符合，抛出异常中HTTP状态码为：412 precondition failed。 如果包含IfModifiedSince并且不符合或者包含IfNoneMatch并且不符合，抛出异常中HTTP状态码为：304 Not Modified。

返回结果 表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 DownloadFileOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。 DeleteMarker string 参数解释： 标识删除的对象是否是删除标记。 LastModified 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 参数解释： 对象的详细过期信息。 Metadata object 参数解释： 对象自定义元数据。需要在桶的CORS配置中增加允许响应中可返回的附加头域。例如，新增x-amz-meta-property1以获取自定义元数据property1。 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==

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

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

请求参数 表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。 约束限制： ObsClient.restoreObject中指定的对象必须是归档存储类别，否则调用该接口会报错。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 VersionId string 可选 参数解释： 待恢复归档存储或深度归档对象的版本号。 约束限制： 无 取值范围： 长度为32的字符串。 默认取值： 无，如果不设置则默认指定最新版本的对象。 Days number 必选 参数解释： 恢复对象后，会生成一个对象的标准存储副本，此参数指定恢复有效期，即标准存储副本的保存时间。 约束限制： 无 取值范围： [1, 30]，单位：天。 默认取值： 无 Tier RestoreTierType 可选 参数解释： 恢复选项，用户可根据需求选择恢复选项，不同的恢复选项恢复耗时不同。 约束限制： 无 取值范围： 恢复选项可选值详见RestoreTierType。 默认取值： Standard 表2 RestoreTierType 常量名 原始值 说明 ObsClient.enums.RestoreTierExpedited Expedited 快速恢复，归档存储恢复耗时1~5 min，深度归档（受限公测）存储恢复约耗时3~5 h。 ObsClient.enums.RestoreTierStandard Standard 标准恢复，归档存储恢复耗时3~5 h，深度归档（受限公测）存储恢复约耗时5~12 h。 说明： 对于深度归档对象，大批量恢复建议使用标准恢复，且对象最终恢复时间受对象大小以及取回数据量的影响。

接口约束 您必须是桶拥有者或拥有恢复归档或深度归档存储对象的权限，才能恢复归档或深度归档存储对象。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:object:RestoreObject权限，如果使用桶策略则需授予RestoreObject权限。相关授权方式介绍可参见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 BaseResponseOutput 参数名称 参数类型 描述 RequestId string 参数解释： OBS服务端返回的请求ID。

返回结果 表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。

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

返回结果 表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中的对象下载到本地。如果只需要下载对象的其中一部分数据，可以使用范围下载，下载指定范围的数据。如果指定的下载范围是0~1000，则返回第0到第1000个字节的数据，包括第1000个，共1001字节的数据，即[0， 1000]。如果指定的范围无效，则返回整个对象的数据。可以利用范围下载并发下载大对象，详细代码示例请参考concurrent-download-object-sample。

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

返回结果 表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。

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

返回结果 表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。

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

返回结果 表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。

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

对象下载简介(Node.js SDK) 开发过程中，您有任何问题可以在github上提交issue，或者在华为云 对象存储服务 论坛中发帖求助。 OBS Node.js SDK提供了丰富的对象下载接口，可以通过以下方式下载对象： 文本下载(Node.js SDK) 流式下载(Node.js SDK) 文件下载(Node.js SDK) 范围下载(Node.js SDK) 断点续传下载(Node.js SDK) 您可以通过ObsClient.getObject下载对象。 父主题： 下载对象(Node.js SDK)