华为云用户手册

  • 返回结果(InterfaceResult) 字段名 类型 说明 RequestId String OBS服务端返回的请求ID。 Location String 桶的区域位置。 Bucket String 桶名。 Delimiter String 用于对对象名进行分组的字符,与请求中的该参数对应。 Prefix String 对象名的前缀,与请求中的该参数对应。 IsTruncated String 表明本次请求是否返回了全部结果,“true”表示没有返回全部结果;“false”表示已返回了全部结果。 KeyMarker String 列举多版本对象的起始位置,与请求中的该参数对应。 VersionIdMarker String 表示列举多版本对象的起始位置(VersionId标识),与请求中的该参数对应。 NextKeyMarker String 下次列举多版本对象请求的起始位置。 NextVersionIdMarker String 下次列举多版本对象请求的起始位置(VersionId标识),与NextKeyMarker配合使用。 MaxKeys String 列举多版本对象的最大数目,与请求中的该参数对应。 Versions Array 多版本对象列表。 ETag String 对象的MD5值。 Size String 对象的字节数。 Key String 对象名。 VersionId String 对象的版本号。 IsLatest String 标识对象是否是最新的版本,true代表是最新的版本。 LastModified String 对象最近一次被修改的时间。 Owner Object 对象的所有者。 ID String 对象所有者的DomainId。 StorageClass String 对象的存储类型。 Type String 对象是否可被追加上传。 DeleteMarkers Array 删除标记列表。 Owner Object 对象的所有者。 ID String 对象所有者的DomainId。 Key String 对象名。 VersionId String 对象的版本号。 IsLatest String 标识对象是否是最新的版本,true代表是最新的版本。 LastModified String 对象最近一次被修改的时间。 CommonPrefixes Array 当请求中设置了Delimiter分组字符时,返回按Delimiter分组后的对象名称前缀列表。 Prefix String 按Delimiter分组后的对象名称前缀。
  • 请求参数 字段名 类型 约束 说明 Bucket String 必选 桶名。 Prefix String 可选 限定返回的对象名必须带有Prefix前缀。 KeyMarker String 可选 列举多版本对象的起始位置,返回的对象列表将是对象名按照字典序排序后该参数以后的所有对象。 MaxKeys Number 可选 列举多版本对象的最大数目,取值范围为1~1000,当超出范围时,按照默认的1000进行处理。 Delimiter String 可选 用于对对象名进行分组的字符。对于对象名中包含Delimiter的对象,其对象名(如果请求中指定了Prefix,则此处的对象名需要去掉Prefix)中从首字符至第一个Delimiter之间的字符串将作为一个分组并作为CommonPrefix返回。 VersionIdMarker String 可选 与KeyMarker配合使用,返回的对象列表将是对象名和版本号按照字典序排序后该参数以后的所有对象。 如果VersionIdMarker不是KeyMarker的一个版本号,则该参数无效。
  • 请求参数 字段名 类型 约束 说明 Bucket String 必选 桶名。 Agency String 如果是设置桶日志配置则必选 委托名。 LoggingEnabled Object 可选 日志配置信息。 TargetBucket String 必选 生成日志的目标桶。 TargetPrefix String 必选 在目标桶中生成日志对象的对象名前缀。 TargetGrants Array 可选 被授权用户权限信息列表。 Grantee Object 可选 被授权用户。 Type String 必选 被授权的用户类型。 ID String 如果Type为“CanonicalUser”则必选,否则必须为空 被授权用户的DomainId。 URI String 如果Type为“Group”则必选,否则必须为空 被授权的用户组。 Permission String 可选 被授予的权限。
  • 返回结果(InterfaceResult) 字段名 类型 说明 RequestId String OBS服务端返回的请求ID。 ETag String 对象的ETag值。 VersionId String 对象的版本号。 StorageClass String 对象的存储类型,当对象存储类型是标准存储时,该值为空。 SseKms String SSE-KMS方式的算法。 SseKmsKey String SSE-KMS方式的密钥。 SseC String SSE-C方式的算法。 SseCKeyMd5 String SSE-C方式的密钥的MD5值。
  • 请求参数 字段名 类型 约束 说明 Bucket String 必选 桶名。 Key String 必选 对象名。 ACL String 可选 创建对象时可指定的预定义访问策略。 StorageClass String 可选 创建对象时可指定的对象的存储类型。 Body String 或 stream.Readable 可选 待上传对象的内容,支持字符串和stream.Readable对象。 Offset Number 可选 当设置了SourceFile时有效,代表源文件中某一分段的起始偏移大小,默认值为0, 单位为字节。 SourceFile String 可选 待上传对象的源文件路径。 ProgressCallback Function 可选 获取上传进度的回调函数。 说明: 该回调函数依次包含三个参数:已上传字节数、总字节数、已使用的时间(单位:秒)。 Metadata Object 可选 待上传对象的自定义元数据。 WebsiteRedirectLocation String 可选 当桶设置了Website配置,该参数指明对象的重定向地址。 Expires Number 可选 待上传对象的生命周期,单位:天。 SuccessActionRedirect String 可选 上传对象成功后的重定向的地址。 ContentType String 可选 待上传对象的MIME类型。 ContentLength Number 可选 当设置了SourceFile时有效,代表待上传对象数据的长度。 ContentMD5 String 可选 待上传对象数据的MD5值(经过Base64编码),提供给OBS服务端,校验数据完整性。 SseKms String 可选 以SSE-KMS方式加密对象,支持的值: kms SseKmsKey String 可选 SSE-KMS方式下加密的主密钥,可为空。 SseC String 可选 以SSE-C方式加密对象,支持的值: AES256 SseCKey Buffer 可选 SSE-C方式下加密的密钥,由AES256算法得到。 Body与SourceFile不能同时使用。 当Body与SourceFile都为空时,上传对象的大小为0字节。
  • 返回结果(InterfaceResult) 字段名 类型 说明 RequestId String OBS服务端返回的请求ID。 ETag String 当前上传段的ETag值。 SseKms String SSE-KMS方式的算法。 SseKmsKey String SSE-KMS方式的密钥。 SseC String SSE-C方式的算法。 SseCKeyMd5 String SSE-C方式的密钥的MD5值。
  • 参数描述 字段名 类型 说明 CommonMsg Object 接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等。 Status Number HTTP状态码,小于300表明操作成功;反之,表明操作失败。 Code String OBS服务端错误码,当Status小于300时为空。 Message String OBS服务端错误描述,当Status小于300时为空。 HostId String 请求的服务端ID,当Status小于300时为空。 RequestId String OBS服务端返回的请求ID。 Id2 String OBS服务端返回的请求ID2。 Indicator String OBS服务端返回的详细错误码,当Status小于300时为空。 InterfaceResult Object 操作成功后的结果数据,当Status大于300时为空。 RequestId String OBS服务端返回的请求ID。 Id2 String OBS服务端返回的请求ID2。 其他字段 参见“桶相关接口”章节和“对象相关接口”章节的详细描述。
  • 请求参数 字段名 类型 约束 说明 Bucket String 必选 桶名。 Key String 必选 对象名。 PartNumber Number 必选 段号,取值范围:1~10000。 UploadId String 必选 分段上传任务的ID。 ContentMD5 String 可选 待上传段数据的MD5值(经过Base64编码),提供给OBS服务端,校验数据完整性。 Body String 或 stream.Readable 可选 待上传段的内容,支持字符串和stream.Readable对象。 SourceFile String 可选 待上传段的源文件路径。 Offset Number 可选 当设置了SourceFile时有效,代表源文件中某一分段的起始偏移大小,默认值为0, 单位为字节。 PartSize Number 可选 当设置了SourceFile时有效,代表源文件中某一分段的大小,默认值为文件大小减去Offset的剩下字节数,单位为字节。除最后一段的大小范围是0~5GB外,其他段的大小范围是100KB~5GB。 SseC String 可选 以SSE-C方式加密段,支持的值: AES256 SseCKey Buffer 可选 SSE-C方式下加密的密钥,由AES256算法得到。 Body与SourceFile不能同时使用。 当Body与SourceFile都为空时,上传对象的大小为0字节。 Offset、PartSize和SourceFile配套使用,用于指定上传源文件中的某一分段数据。
  • 代码样例 // 引入obs库// 使用npm安装var ObsClient = require('esdk-obs-nodejs');var ProxyAgent = require('proxy-agent');// 使用源码安装// var ObsClient = require('./lib/obs');// 创建ObsClient实例var obsClient = new ObsClient({ //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。 //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html access_key_id: process.env.AC CES S_KEY_ID, secret_access_key: process.env.SECRET_ACCESS_KEY, //这里以华北-北京四为例,其他地区请按实际情况填写 server: 'https://obs.cn-north-4.myhuaweicloud.com' max_retry_count : 1, timeout : 20, ssl_verify : false, long_conn_param : 0, http_agent : new ProxyAgent('*** Provide your Network proxy ***') // 配置网络代理});
  • 参数描述 字段名 类型 约束 说明 access_key_id String 可选 访问密钥中的AK。 secret_access_key String 可选 访问密钥中的SK。 server String 必选 连接OBS的服务地址。可包含协议类型、 域名 、端口号。示例:https://your-endpoint:443。 您可以从这里查看OBS当前开通的服务地址。 max_retry_count Number 可选 HTTP/HTTPS连接异常时的请求重试次数。默认为3次。 https_agent Object 可选 配置客户端网络https代理信息。 http_agent Object 可选 配置客户端网络http代理信息。 timeout Number 可选 HTTP/HTTPS请求超时时间(单位:秒)。默认为60秒。 ssl_verify Boolean 或 String 可选 验证服务端证书参数。可能的取值: 服务端pem格式根证书文件路径; true:使用默认的CAs验证服务端证书; false:表示不验证服务端证书。 默认为false。 long_conn_param Number 可选 长连接模式参数(单位:秒)。当该参数大于等于0时,开启长连接模式,并将该参数作为TCP Keep-Alive数据包的初始延迟。 默认为空,代表关闭长连接模式。 is_cname Boolean 可选 是否通过自定义域名访问OBS服务。默认为false。
  • 请求参数 字段名 类型 约束 说明 Method String 必选 HTTP方法类型,支持的值: GET POST PUT DELETE HEAD Bucket String 可选 桶名。 Key String 可选 对象名。 SpecialParam String 可选 特殊操作符,代表要操作的子资源,支持的值: versions uploads location storageinfo quota storagePolicy acl append logging policy lifecycle website versioning cors notification tagging delete restore Expires Number 可选 带授权信息的URL的过期时间(单位:秒),默认值:300。 Headers Object 可选 请求中携带的头域。 QueryParams Object 可选 请求中携带的查询参数。
  • 请求参数 字段名 类型 约束 说明 Bucket String 必选 桶名。 Key String 必选 对象名。 VersionId String 可选 对象的版本号。 ACL String 可选 预定义访问策略。 Owner Object 可选 对象的所有者。 ID String 必选 对象所有者的DomainId。 Delivered Boolean 可选 桶的ACL是否向桶内对象传递。 Grants Array 可选 被授权用户权限信息列表。 Grantee Object 必选 被授权用户。 Type String 必选 被授权的用户类型。 ID String 如果Type为“CanonicalUser”则必选,否则必须为空 被授权用户的DomainId。 URI String 如果Type为“Group”则必选,否则必须为空 被授权的用户组。 Permission String 必选 被授予的权限。 Owner和Grants必须配套使用,且与ACL互斥。当设置了这两个字段时,不能设置ACL;反之,当设置了ACL时,不能设置Owner和Grants。 Owner、Grants与ACL不能全为空。
  • 请求参数 字段名 类型 约束 说明 Bucket String 可选 桶名。 Key String 可选 对象名,对应表单中的key字段。 Expires Number 可选 表单上传鉴权参数的过期时间(单位:秒),默认值300。 FormParams Object 可选 除key、policy、signature外,表单上传时的其他参数,支持的值: acl cache-control content-type content-disposition content-encoding expires
  • 返回结果(InterfaceResult) 字段名 类型 说明 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 归档存储类型对象的取回状态。 SseKms String SSE-KMS方式的算法。 SseKmsKey String SSE-KMS方式的主密钥。 SseC String SSE-C方式的算法。 SseCKeyMd5 String SSE-C方式的密钥的MD5值。 Expiration String 对象的详细过期信息。 Metadata Object 对象自定义元数据。
  • 请求参数 字段名 类型 约束 说明 Bucket String 必选 桶名。 Key String 必选 对象名。 DownloadFile String 可选 下载对象的本地文件全路径。当该值为空时,默认为当前程序的运行目录。 PartSize Number 可选 分段大小,单位字节,取值范围是100KB~5GB,默认为5MB。 TaskNum Number 可选 分段下载时的最大并发数,默认为20。 ProgressCallback Function 可选 获取下载进度的回调函数。 说明: 该回调函数依次包含三个参数:已下载的字节数、总字节数、已使用的时间(单位:秒)。 ResumeCallback Function 可选 获取取消断点续传控制参数的回调函数。 说明: 该回调函数有一个参数:取消断点续传下载任务控制参数; 可以调用取消断点续传下载任务控制参数的cancel方法来暂停断点续传下载任务。 EnableCheckpoint Boolean 可选 是否开启断点续传模式,默认为false,表示不开启。 CheckpointFile String 可选 记录下载进度的文件,只在断点续传模式下有效。当该值为空时,默认与下载对象的本地文件路径同目录。 VersionId String 可选 对象的版本号。 IfModifiedSince String 可选 如果对象的修改时间晚于该参数值指定的时间,则返回对象内容,否则返回异常码。 IfUnmodifiedSince String 可选 如果对象的修改时间早于该参数值指定的时间,则返回对象内容,否则返回异常码。 IfMatch String 可选 如果对象的ETag值与该参数值相同,则返回对象内容,否则返回异常码。 IfNoneMatch String 可选 如果对象的ETag值与该参数值不相同,则返回对象内容,否则返回异常码。 SseC String 可选 以SSE-C方式解密对象,支持的值: AES256 SseCKey String 可选 SSE-C方式下解密的密钥,由AES256算法算出。
  • 返回结果(InterfaceResult) 字段名 类型 说明 RequestId String OBS服务端返回的请求ID。 Bucket String 桶名。 KeyMarker String 列举分段上传任务的起始位置,与请求中的该参数对应。 UploadIdMarker String 列举分段上传任务的起始位置(UploadId标识),与请求中的该参数对应。 NextKeyMarker String 下次列举分段上传任务请求的起始位置。 NextUploadIdMarker String 下次列举分段上传任务请求的起始位置(UploadId标识),与NextKeyMarker配合使用。 Delimiter String 用于对分段上传任务中的对象名进行分组的字符,与请求中的该参数对应。 Prefix String 分段上传任务中的对象名前缀,与请求中的该参数对应。 MaxUploads String 列举分段上传任务的最大数目,与请求中的该参数对应。 IsTruncated String 表明本次请求是否返回了全部结果,“true”表示没有返回全部结果;“false”表示已返回了全部结果。 Uploads Array 分段上传任务列表。 Key String 分段上传任务的对象名。 UploadId String 分段上传任务的ID。 Initiator Object 分段上传任务的创建者。 ID String 创建者的DomainId。 Owner Object 和Initiator相同,代表分段上传任务的创建者。 ID String 创建者的DomainId。 Initiated String 分段上传任务的初始化时间。 StorageClass String 分段上传对象的存储类型。 CommonPrefixes Array 当请求中设置了Delimiter分组字符时,返回按Delimiter分组后的对象名称前缀列表。 Prefix String 按Delimiter分组后的对象名称前缀。
  • 请求参数 字段名 类型 约束 说明 Bucket String 必选 桶名。 Delimiter String 可选 用于对分段上传任务中的对象名进行分组的字符。对于对象名中包含Delimiter的任务,其对象名(如果请求中指定了Prefix,则此处的对象名需要去掉Prefix)中从首字符至第一个Delimiter之间的字符串将作为一个分组并作为CommonPrefix返回。 Prefix String 可选 限定返回的分段上传任务中的对象名必须带有Prefix前缀。 MaxUploads Number 可选 列举分段上传任务的最大数目,取值范围为1~1000,当超出范围时,按照默认的1000进行处理。 KeyMarker String 可选 表示列举时返回指定的KeyMarker之后的分段上传任务。 UploadIdMarker String 可选 只有与KeyMarker参数一起使用时才有意义,用于指定返回结果的起始位置,即列举时返回指定KeyMarker的UploadIdMarker之后的分段上传任务。
  • 请求参数 字段名 类型 约束 说明 Bucket String 必选 桶名。 桶命名规则如下: 3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。 禁止使用类IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻(如:“my..bucket”)。 禁止“.”和“-”相邻(如:“my-.bucket”和“my.-bucket”)。 ACL String 可选 创桶时可指定的预定义访问策略。 StorageClass String 可选 创桶时可指定的桶的存储类型。 Location String 如果请求的OBS服务地址所在区域为默认区域,则可为空,否则为必选。 桶所在的区域。 该参数定义了桶将会被创建在哪个区域,如果使用的终端节点归属于默认区域华北-北京一(cn-north-1),可以不携带此参数;如果使用的终端节点归属于其他区域,则必须携带此参数。当前有效的区域名称可从这里查询。有关OBS区域和终端节点的更多信息,请参考地区和终端节点。 AzRedundancy String 可选 桶AZ存储类型。 如果不携带该值,则默认为单AZ存储。 如果设置为多AZ存储,值为"3az"。 如果Location不支持多AZ,则该桶的存储类型仍为单AZ。
  • 请求参数 字段名 类型 约束 说明 Bucket String 必选 桶名。 ACL String 可选 预定义访问策略。 Owner Object 可选 桶的所有者。 ID String 必选 桶所有者的DomainId。 Grants Array 可选 被授权用户权限信息列表。 Grantee Object 必选 被授权用户。 Type String 必选 被授权的用户类型。 ID String 如果Type为“CanonicalUser”则必选,否则必须为空 被授权用户的DomainId。 URI String 如果Type为“Group”则必选,否则必须为空 被授权的用户组。 Permission String 必选 被授予的权限。 Delivered Boolean 可选 桶内对象ACL是否继承桶的ACL。 Owner和Grants必须配套使用,且与ACL互斥。当设置了这两个字段时,不能设置ACL;反之,当设置了ACL时,不能设置Owner和Grants。 Owner、Grants与ACL不能全为空。
  • 功能说明 按照用户指定的桶名创建一个新桶。新创建桶的桶名在OBS中必须是唯一的。如果是同一个用户重复创建同一区域的同名桶时返回HTTP状态码200。除此以外的其他场景重复创建同名桶返回HTTP状态码409,表明桶已存在。一个用户可以拥有的桶的数量不能超过100个。 ObsClient的桶相关操作接口函数均支持首字母大小写,如ObsClient.createBucket和ObsClient.CreateBucket是相同的函数。
  • 预定义访问策略 所属模块 访问方式 类型 说明 obs.js ObsClient.enums.AclPrivate String 私有读写。 obs.js ObsClient.enums.AclPublicRead String 公共读。 obs.js ObsClient.enums.AclPublicReadWrite String 公共读写。 obs.js ObsClient.enums.AclPublicReadDelivered String 桶公共读,桶内对象公共读。 obs.js ObsClient.enums.AclPublicReadWriteDelivered String 桶公共读写,桶内对象公共读写。 父主题: 预定义常量
  • 请求参数 字段名 类型 约束 说明 Bucket String 必选 桶名。 Key String 必选 对象名。 UploadFile String 必选 待上传的本地文件。 PartSize Number 可选 分段大小,单位字节,取值范围是100KB~5GB,默认为5MB。 TaskNum Number 可选 分段上传时的最大并发数,默认为20。 ProgressCallback Function 可选 获取上传进度的回调函数。 说明: 该回调函数依次包含三个参数:已上传的字节数、总字节数、已使用的时间(单位:秒)。 ResumeCallback Function 可选 获取取消断点续传控制参数的回调函数。 说明: 该回调函数有一个参数:取消断点续传上传任务控制参数; 可以调用取消断点续传上传任务控制参数的cancel方法来暂停断点续传上传任务。 EnableCheckpoint Boolean 可选 是否开启断点续传模式,默认为false,表示不开启。 CheckpointFile String 可选 记录上传进度的文件,只在断点续传模式下有效。当该值为空时,默认与待上传的本地文件同目录。 EnableCheckSum Boolean 可选 是否校验待上传文件的内容,只在断点续传模式下有效。默认为false,表示不校验。 ContentType String 可选 对象的MIME类型。 ACL String 可选 预定义访问策略。 WebsiteRedirectLocation String 可选 当桶设置了Website配置,该参数指明对象的重定向地址。 SseKms String 可选 以SSE-KMS方式加密对象,支持的值: kms SseKmsKey String 可选 SSE-KMS方式下加密的主密钥,可为空。 sseC String 可选 以SSE-C方式加密对象,支持的值: AES256 SseCKey String 可选 SSE-C方式下加密的密钥,由AES256算法得到。 Metadata Object 可选 对象的自定义元数据信息。
  • 返回结果(InterfaceResult) 字段名 类型 说明 RequestId String OBS服务端返回的请求ID。 ETag String 合并段后根据各个段的ETag值计算出的结果。 Bucket String 合并段所在的桶。 Key String 合并段后得到的对象名。 Location String 合并段后得到的对象的url。 VersionId String 合并段后得到的对象版本号。 SseKms String SSE-KMS方式的算法。 SseKmsKey String SSE-KMS方式的主密钥。 SseC String SSE-C方式的算法。 SseCKeyMd5 String SSE-C方式的密钥的MD5值。
  • 请求参数 字段名 类型 约束 说明 Bucket String 必选 桶名。 Key String 必选 对象名。 VersionId String 可选 对象的版本号。 ProgressCallback Function 可选 获取下载进度的回调函数。 说明: 该回调函数依次包含三个参数:已下载字节数、总字节数、已使用的时间(单位:秒)。 IfMatch String 可选 如果对象的ETag值与该参数值相同,则返回对象内容,否则返回异常码。 IfModifiedSince String 可选 如果对象的修改时间晚于该参数值指定的时间,则返回对象内容,否则返回异常码。该参数值必须符合http://www.ietf.org/rfc/rfc2616.txt规定的HTTP时间格式。 IfNoneMatch String 可选 如果对象的ETag值与该参数值不相同,则返回对象内容,否则返回异常码。 IfUnmodifiedSince String 可选 如果对象的修改时间早于该参数值指定的时间,则返回对象内容,否则返回异常码。该参数值必须符合http://www.ietf.org/rfc/rfc2616.txt规定的HTTP时间格式。 Range String 可选 指定下载的范围,取值区间:[0,对象长度-1],格式:bytes=x-y。如果Range的最大长度超出对象长度-1,仍旧取对象长度-1。 Origin String 可选 预请求指定的跨域请求Origin(通常为域名)。 RequestHeader String 可选 跨域请求可以使用的HTTP头域。 ResponseCacheControl String 可选 重写响应中的Cache-Control头。 ResponseContentDisposition String 可选 重写响应中的Content-Disposition头。 ResponseContentEncoding String 可选 重写响应中的Content-Encoding头。 ResponseContentLanguage String 可选 重写响应中的Content-Language头。 ResponseContentType String 可选 重写响应中的Content-Type头。 ResponseExpires String 可选 重写响应中的Expires头。 ImageProcess String 可选 图片处理参数。 SaveAsFile String 可选 下载对象的目标路径,包含文件名。 SaveAsStream Boolean 可选 是否将对象以流(stream.Readable)的形式返回。 SseC String 可选 以SSE-C方式解密对象,支持的值: AES256 SseCKey Buffer 可选 SSE-C方式下解密的密钥,由AES256算法算出。 SaveAsFile和SaveAsStream不能同时使用。 如果包含IfUnmodifiedSince并且不符合或者包含IfMatch并且不符合,抛出异常中HTTP状态码为:412 precondition failed。 如果包含IfModifiedSince并且不符合或者包含IfNoneMatch并且不符合,抛出异常中HTTP状态码为:304 Not Modified。
  • 返回结果(InterfaceResult) 字段名 类型 说明 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 归档存储类型对象的取回状态。 AllowOrigin String 如果请求中的Origin满足桶的CORS规则,则返回CORS规则中的AllowedOrigin。 AllowHeader String 如果请求的RequestHeader满足桶的CORS规则,则返回CORS规则中的AllowedHeader。 AllowMethod String 桶CORS规则中的AllowedMethod。 ExposeHeader String 桶CORS规则中的ExposeHeader。 MaxAgeSeconds String 桶CORS规则中的MaxAgeSeconds。 SseKms String SSE-KMS方式的算法。 SseKmsKey String SSE-KMS方式的主密钥。 SseC String SSE-C方式的算法。 SseCKeyMd5 String SSE-C方式的密钥的MD5值。 Expiration String 对象的详细过期信息。 Content String 或 stream.Readable 对象的内容。当设置了SaveAsFile时该值为空;当设置了SaveAsStream且为true时该值为stream.Readable对象;当SaveAsFile和SaveAsStream都未设置时为Buffer对象。 Metadata Object 对象自定义元数据。
  • 返回结果(InterfaceResult) 字段名 类型 说明 RequestId String OBS服务端返回的请求ID。 Owner Object 桶的所有者。 ID String 桶所有者的DomainId。 Name String 桶所有者的名字。 Grants Array 被授权用户权限信息列表。 Grantee Object 被授权用户。 Name String 被授权用户的名字,当用户类型是Group时为空。 ID String 被授权用户的DomainId,当用户类型是Group时为空。 URI String 被授权的用户组,当用户类型是CanonicalUser时为空。 Permission String 被授予的权限。 Delivered String 桶内对象ACL是否继承桶的ACL。
  • 返回结果(InterfaceResult) 字段名 类型 说明 RequestId String OBS服务端返回的请求ID。 ETag String 目标对象的ETag值。 LastModified String 目标对象的最近一次修改时间。 VersionId String 目标对象的版本号,如果目标桶未开启多版本状态则该值为空。 CopySourceVersionId String 源对象的版本号,如果源桶未开启多版本状态则该值为空。 SseKms String SSE-KMS方式的算法。 SseKmsKey String SSE-KMS方式的主密钥。 SseC String SSE-C方式的算法。 SseCKeyMd5 String SSE-C方式的密钥的MD5值。
  • 请求参数 字段名 类型 约束 说明 Bucket String 必选 目标桶名。 Key String 必选 目标对象名。 ACL String 可选 复制对象时可指定的预定义访问策略。 StorageClass String 可选 复制时设置对象的存储类型。 CopySource String 必选 指定源桶、源对象和源对象版本号(可为空)的参数,格式:源桶名/源对象名?versionId=源对象版本号。 CopySourceIfMatch String 可选 如果源对象的ETag值与该参数值相同,则进行复制,否则返回异常码。 CopySourceIfModifiedSince String 可选 如果源对象的修改时间晚于该参数值指定的时间,则进行复制,否则返回异常码。该参数值必须符合http://www.ietf.org/rfc/rfc2616.txt规定的HTTP时间格式。 CopySourceIfNoneMatch String 可选 如果源对象的ETag值与该参数值不相同,则进行复制,否则返回异常码。 CopySourceIfUnmodifiedSince String 可选 如果源对象的修改时间早于该参数值指定的时间,则进行复制,否则返回异常码。该参数值必须符合http://www.ietf.org/rfc/rfc2616.txt规定的HTTP时间格式。 CacheControl String 可选 复制时重写响应中的Cache-Control头。 ContentDisposition String 可选 复制时重写响应中的Content-Disposition头。 ContentEncoding String 可选 复制时重写响应中的Content-Encoding头。 ContentLanguage String 可选 复制时重写响应中的Content-Language头。 ContentType String 可选 复制时重写响应中的Content-Type头。 Expires String 可选 复制时重写响应中的Expires头。 MetadataDirective String 可选 复制策略。 Metadata Object 可选 目标对象的自定义元数据。 WebsiteRedirectLocation String 可选 当桶设置了Website配置,该参数指明对象的重定向地址。 SuccessActionRedirect String 可选 复制对象成功后的重定向的地址。 SseKms String 可选 以SSE-KMS方式加密目标对象,支持的值: kms SseKmsKey String 可选 SSE-KMS方式下加密目标对象的主密钥,可为空。 SseC String 可选 以SSE-C方式加密目标对象,支持的值: AES256 SseCKey Buffer 可选 SSE-C方式下加密目标对象的密钥,由AES256算法算出。 CopySourceSseC String 可选 以SSE-C方式解密源对象,支持的值: AES256 CopySourceSseCKey Buffer 可选 SSE-C方式下解密源对象的密钥,由AES256算法算出。 如果包含CopySourceIfUnmodifiedSince并且不符合,或者包含CopySourceIfMatch并且不符合,或者包含CopySourceIfModifiedSince并且不符合,或者包含CopySourceIfNoneMatch并且不符合,抛出异常中HTTP状态码为:412 precondition failed。 CopySourceIfModifiedSince和CopySourceIfNoneMatch可以一起使用;CopySourceIfUnmodifiedSince和CopySourceIfMatch可以一起使用。
  • 请求参数 字段名 类型 约束 说明 Bucket String 必选 桶名。 CorsRules Array 必选 桶的CORS规则列表。 ID String 可选 CORS规则ID,由不超过255个字符的字符串组成。 AllowedMethod Array of Strings 必选 CORS规则允许的HTTP方法,支持的值: GET PUT HEAD POST DELETE AllowedOrigin Array of Strings 必选 CORS规则允许的请求来源(表示域名的字符串)。可以带一个匹配符“*”,每一个AllowedOrigin最多可以带一个“*”通配符。 AllowedHeader Array of Strings 可选 CORS规则允许请求中可携带的头域,不可出现空格。可以带一个匹配符“*”,且每一个AllowedHeader最多可以带一个“*”通配符。 MaxAgeSeconds Number 可选 CORS规则允许客户端可以对跨域请求返回结果的缓存时间,以秒为单位,整数类型。 ExposeHeader Array of Strings 可选 CORS规则允许响应中可返回的附加头域,不可出现空格。
  • 返回结果(InterfaceResult) 字段名 类型 说明 RequestId String OBS服务端返回的请求ID。 ETag String 对象的ETag值。 NextPosition String 下次追加上传的位置。 StorageClass String 对象的存储类型,当对象存储类型是标准存储时,该值为空。 SseKms String SSE-KMS方式的算法。 SseKmsKey String SSE-KMS方式的密钥。 SseC String SSE-C方式的算法。 SseCKeyMd5 String SSE-C方式的密钥的MD5值。
共99354条