云服务器内容精选
-
返回结果 表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都未设置时为String对象。 Metadata object 参数解释: 对象自定义元数据。需要在桶的CORS配置中增加允许响应中可返回的附加头域。例如,新增x-amz-meta-property1以获取自定义元数据property1。
-
接口约束 您必须是桶拥有者或拥有下载对象的权限,才能下载对象。建议使用 IAM 或桶策略进行授权,如果使用IAM则需授予obs:object:GetObject权限,如果使用桶策略则需授予GetObject权限。相关授权方式介绍可参见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。