华为云用户手册

参数描述 字段名 类型 约束 说明 ID string 作为请求参数时可选 CORS规则ID，由不超过255个字符的字符串组成。 AllowedMethod []string 作为请求参数时必选 CORS规则允许的HTTP方法，支持的值： GET PUT HEAD POST DELETE AllowedOrigin []string 作为请求参数时必选 CORS规则允许的请求来源（表示域名的字符串）。可以带一个匹配符“*”，每一个AllowedOrigin最多可以带一个“*”通配符。 AllowedHeader []string 作为请求参数时可选 CORS规则允许请求中可携带的头域，不可出现空格。可以带一个匹配符“*”，且每一个AllowedHeader最多可以带一个“*”通配符。 MaxAgeSeconds int 作为请求参数时可选 CORS规则允许客户端可以对跨域请求返回结果的缓存时间，以秒为单位，整数类型。 ExposeHeader []string 作为请求参数时可选 CORS规则允许响应中可返回的附加头域，不可出现空格。

参数描述 字段名 类型 说明 StatusCode int HTTP状态码。 RequestId string OBS服务端返回的请求ID。 ResponseHeaders map[string][]string HTTP响应头信息。 StorageClass StorageClassType 对象的存储类型，当对象存储类型是标准存储时，该值为空。 VersionId string 对象的版本号。 ETag string 对象的ETag值。 SseHeader SseCHeader 或 SseKmsHeader 服务端加密头信息。

参数描述 字段名 类型 约束 说明 Encryption string 作为请求参数时必选 SSE-C方式加解密对象的算法，支持的值： AES256 Key string 作为请求参数时必选 SSE-C方式下的密钥，由AES256算法算出值再经过Base64编码后得到。 KeyMD5 string 作为请求参数时可选 SSC-C方式下密钥的校验值，由密钥值经过MD5加密再经过Base64编码后得到。

参数描述 字段名 类型 约束 说明 Bucket string 必选 桶名。 Key string 必选 对象名。 ContentMD5 string 可选 待上传对象数据的MD5值（经过Base64编码），提供给OBS服务端，校验数据完整性。 ACL AclType 可选 创建对象时可指定的预定义访问策略。 WebsiteRedirectLocation string 可选 当桶设置了Website配置，该参数指明对象的重定向地址。 ContentType string 可选 待上传对象的MIME类型。 ContentLength int64 可选 待上传对象数据的长度。 SseHeader SseCHeader 或 SseKmsHeader 可选 服务端加密头信息。 StorageClass StorageClassType 可选 创建对象时可指定的对象的存储类型。 Metadata map[string]string 可选 待上传对象的自定义元数据。 Body io.Reader 可选 待上传对象的数据流。 GrantReadId string 可选 授权指定租户有读对象和获取对象元数据的权限。 GrantReadAcpId string 可选 授权指定租户有获取对象ACL的权限。 GrantWriteAcpId string 可选 授权指定租户有写对象ACL的权限。 GrantFullControlId string 可选 授权指定租户有读对象、获取对象元数据、获取对象ACL、写对象ACL的权限。 Expires int64 可选 表示对象的过期时间。

参数描述 字段名 类型 约束 说明 Bucket string 必选 桶名。 Key string 必选 对象名。 ResponseCacheControl string 可选 获取对象时重写响应中的Cache-Control头。 ResponseContentDisposition string 可选 获取对象时重写响应中的Content-Disposition头。 ResponseContentEncoding string 可选 获取对象时重写响应中的Content-Encoding头。 ResponseContentLanguage string 可选 获取对象时重写响应中的Content-Language头。 ResponseContentType string 可选 获取对象时重写响应中的Content-Type头。 ResponseExpires string 可选 获取对象时重写响应中的Expires头。 VersionId string 可选 对象的版本号。 ImageProcess string 可选 图片处理参数。 RangeStart int64 可选 指定下载对象的起始位置，非负整数。 RangeEnd int64 可选 指定下载对象的结束位置。如果该值大于对象长度-1，实际仍取对象长度-1。 IfMatch string 可选 如果对象的ETag值与该参数值相同，则返回对象内容，否则返回错误。 IfNoneMatch string 可选 如果对象的ETag值与该参数值不相同，则返回对象内容，否则返回错误。 IfModifiedSince time.Time 可选 如果对象的修改时间晚于该参数值指定的时间，则返回对象内容，否则返回错误。 IfUnmodifiedSince time.Time 可选 如果对象的修改时间早于该参数值指定的时间，则返回对象内容，否则返回错误。 Origin string 可选 预请求指定的跨域请求Origin（通常为域名）。 RequestHeader string 可选 跨域请求可以使用的HTTP头域。 SseHeader SseCHeader 可选 服务端解密头信息。 如果包含IfUnmodifiedSince并且不符合或者包含IfMatch并且不符合，则下载对象失败，返回错误信息：412 precondition failed。 如果包含IfModifiedSince并且不符合或者包含IfNoneMatch并且不符合，则下载对象失败，返回错误信息：304 Not Modified。

参数描述 字段名 类型 约束 说明 Bucket string 必选 桶名。 Key string 必选 对象名。 ContentMD5 string 可选 待上传对象数据的MD5值（经过Base64编码），提供给OBS服务端，校验数据完整性。 ACL AclType 可选 创建对象时可指定的预定义访问策略。 WebsiteRedirectLocation string 可选 当桶设置了Website配置，该参数指明对象的重定向地址。 ContentType string 可选 待上传对象的MIME类型。 ContentLength int64 可选 待上传对象数据的长度。 SseHeader SseCHeader 或 SseKmsHeader 可选 服务端加密头信息。 StorageClass StorageClassType 可选 创建对象时可指定的对象的存储类型。 Metadata map[string]string 可选 待上传对象的自定义元数据。 SourceFile string 可选 待上传对象的源文件路径。 GrantReadId string 可选 授权指定租户有读对象和获取对象元数据的权限。 GrantReadAcpId string 可选 授权指定租户有获取对象ACL的权限。 GrantWriteAcpId string 可选 授权指定租户有写对象ACL的权限。 GrantFullControlId string 可选 授权指定租户有读对象、获取对象元数据、获取对象ACL、写对象ACL的权限。 Expires int64 可选 表示对象的过期时间。

参数描述 字段名 类型 说明 Key string 对象名。 VersionId string 对象的版本号。 LastModified time.Time 对象最近一次被修改的时间。 ETag string 对象的MD5值。 Size int64 对象的字节数。 Owner Owner 对象的所有者。 StorageClass StorageClassType 对象的存储类型。 IsLatest bool 标识对象是否是最新的版本，True代表是最新的版本。

参数描述 字段名 类型 说明 StatusCode int HTTP状态码。 RequestId string OBS服务端返回的请求ID。 ResponseHeaders map[string][]string HTTP响应头信息。 Location string 桶的区域位置。 Name string 桶名。 Prefix string 对象名的前缀，与请求中的该参数对应。 Marker string 列举对象的起始位置，与请求中的该参数对应。 Delimiter string 用于对对象名进行分组的字符，与请求中的该参数对应。 MaxKeys int 列举对象的最大数目，与请求中的该参数对应。 IsTruncated bool 表明本次请求是否返回了全部结果，true表示没有返回全部结果；false表示已返回了全部结果。 NextMarker string 下次列举对象请求的起始位置。 Contents []Content 桶内对象列表。 CommonPrefixes []string 当请求中设置了Delimiter分组字符时，返回按Delimiter分组后的对象名称前缀列表。 EncodingType string 表明响应中的部分元素的编码类型。

参数描述 字段名 类型 约束 说明 Bucket string 必选 桶名。 Location string 如果请求的OBS服务地址所在区域为默认区域，则可为空，否则为必选。 桶所在的区域。 该参数定义了桶将会被创建在哪个区域，如果使用的终端节点归属于默认区域华北-北京一（cn-north-1），可以不携带此参数；如果使用的终端节点归属于其他区域，则必须携带此参数。当前有效的区域名称可从这里查询。有关OBS区域和终端节点的更多信息，请参考地区和终端节点终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以向企业管理员获取区域和终端节点信息。 ACL AclType 可选 创桶时可指定的预定义访问策略。 StorageClass StorageClassType 可选 创桶时可指定的桶的存储类型。 GrantReadId string 可选 授权指定帐号有READ权限。允许列举桶内对象、列举桶中多段任务、列举桶中多版本对象、获取桶元数据。 GrantWriteId string 可选 授权指定帐号有WRITE权限。允许创建、删除、覆盖桶内所有对象，允许初始化段、上传段、拷贝段、合并段、取消多段上传任务。 GrantReadAcpId string 可选 授权指定帐号有READ_ACP权限。允许读桶的ACL信息。 GrantWriteAcpId string 可选 授权指定帐号有WRITE_ACP权限，允许修改桶的ACL信息。 GrantFullControlId string 可选 授权指定帐号有FULL_CONTROL权限。 GrantReadDeliveredId string 可选 授权指定帐号有READ权限，并且在默认情况下，该READ权限将传递给桶内所有对象。 GrantFullControlDeliveredId string 可选 授权指定帐号有FULL_CONTROL权限，并且在默认情况下，该FULL_CONTROL权限将传递给桶内所有对象。 Epid string 可选 创桶时可指定的企业项目id，开通企业项目的用户可以从企业项目服务获取，格式为uuid，默认项目传“0”或者不带该头域，未开通企业项目的用户可以不带该头域。 AvailableZone string 可选 创桶时可指定的AZ类型，可选值3az。 IsFSFileInterface bool 可选 支持创建POSIX桶。

参数描述 字段名 类型 说明 StatusCode int HTTP状态码。 RequestId string OBS服务端返回的请求ID。 ResponseHeaders map[string][]string HTTP响应头信息。 Status string HTTP文本描述。 Code string OBS服务端错误码。 Message string OBS服务端错误描述。 Resource string 发生错误时相关的桶或对象。 HostId string 请求的服务端ID。

常量列表 常量名 原始值 说明 LEVEL_OFF 500 关闭级别，如果设置为这个级别，日志打印功能将被关闭。 LEVEL_ERROR 400 错误级别，如果设置为这个级别，仅打印发生异常时的错误信息。 LEVEL_WARN 300 告警级别，如果设置为这个级别，除了打印错误级别的信息外，还将打印一些关键事件的信息。 LEVEL_INFO 200 信息级别，如果设置为这个级别，除了打印告警级别的信息外，还将打印HTTP/HTTPS请求的耗时时间，ObsClient接口的耗时时间等。 LEVEL_DEBUG 100 调试级别，如果设置为这个级别，除了打印INFO级别的信息外，还将打印每次HTTP/HTTPS请求和响应的头信息、鉴权算法计算出的stringToSign信息等。

常量列表 常量名 原始值 说明 AclPrivate private 私有读写。 AclPublicRead public-read 公共读私有写。 AclPublicReadWrite public-read-write 公共读写。 AclPublicReadDelivered public-read-delivered 桶公共读，桶内对象公共读。 AclPublicReadWriteDelivered public-read-write-delivered 桶公共读写，桶内对象公共读写。 AclPublicReadDelivered和AclPublicReadWriteDelivered不能应用于对象。

常量列表 常量名 原始值 说明 ObjectCreatedAll ObjectCreated:* 所有创建对象操作的事件。 包含PUT上传对象、POST上传对象、复制对象、合并段。 ObjectCreatedPut ObjectCreated:Put PUT上传对象的事件。 ObjectCreatedPost ObjectCreated:Post POST上传对象的事件。 ObjectCreatedCopy ObjectCreated:Copy 复制对象的事件。 ObjectCreatedCompleteMultipartUpload ObjectCreated:CompleteMultipartUpload 合并段的事件。 ObjectRemovedAll ObjectRemoved:* 所有调用删除、取消段接口的对象操作的事件。 包含指定对象版本号删除对象；多版本开启后，不指定对象版本号删除对象。 ObjectRemovedDelete ObjectRemoved:Delete 指定对象版本号删除对象的事件。 ObjectRemovedDeleteMarkerCreated ObjectRemoved:DeleteMarkerCreated 多版本开启后，不指定对象版本号删除对象的事件。

常量列表 常量名 原始值 适用接口 SubResourceStoragePolicy storagePolicy 设置/获取桶存储类型。 SubResourceQuota quota 设置/获取桶配额。 SubResourceStorageInfo storageinfo 获取桶存量信息。 SubResourceLocation location 获取桶区域位置。 SubResourceAcl acl 设置/获取桶ACL、设置/获取对象ACL。 SubResourcePolicy policy 设置/获取/删除桶策略。 SubResourceCors cors 设置/获取/删除桶CORS配置。 SubResourceVersioning versioning 设置/获取桶多版本状态。 SubResourceWebsite website 设置/获取/删除桶Website配置。 SubResourceLogging logging 设置/获取桶日志管理配置。 SubResourceLifecycle lifecycle 设置/获取/删除桶生命周期配置。 SubResourceNotification notification 设置/获取桶时间通知配置。 SubResourceTagging tagging 设置/获取/删除桶标签。 SubResourceDelete delete 批量删除对象。 SubResourceVersions versions 列举桶内多版本对象。 SubResourceUploads uploads 列举桶内分段上传任务、初始化分段上传任务。 SubResourceRestore restore 恢复归档存储对象。

常量列表 常量名 原始值 说明 HttpMethodGet GET HTTP GET请求。 HttpMethodPut POST HTTP POST请求。 HttpMethodPost PUT HTTP PUT请求。 HttpMethodDelete DELETE HTTP DELETE请求。 HttpMethodHead HEAD HTTP HEAD请求。 HttpMethodOptions OPTIONS HTTP OPTIONS请求。

参数描述 字段名 类型 约束 说明 ID string 作为请求参数时可选 规则ID，由不超过255个字符的字符串组成。 Prefix string 作为请求参数时必选 对象名前缀，用以标识哪些对象可以匹配到当前这条规则。可为空字符串，代表匹配桶内所有对象。 Status RuleStatusType 作为请求参数时必选 标识当前这条规则是否启用。 Transitions []Transition 作为请求参数时可选 对象转换策略列表。 Expiration Expiration 作为请求参数时可选 对象过期时间配置。 NoncurrentVersionTransitions []NoncurrentVersionTransition 作为请求参数时可选 历史版本对象转换策略列表。 NoncurrentVersionExpiration NoncurrentVersionExpiration 作为请求参数时可选 历史版本对象过期时间配置。 Transitions、Expiration、NoncurrentVersionTransitions、NoncurrentVersionExpiration不能全为空。

参数描述 字段名 类型 约束 说明 Bucket string 必选 桶名。 KeyMarker string 可选 列举多版本对象的起始位置，返回的对象列表将是对象名按照字典序排序后该参数以后的所有对象。 VersionIdMarker string 可选 与KeyMarker配合使用，返回的对象列表将是对象名和版本号按照字典序排序后该参数以后的所有对象。 如果VersionIdMarker不是KeyMarker的一个版本号，则该参数无效。 Prefix string 可选 限定返回的对象名必须带有prefix前缀。 MaxKeys int 可选 列举多版本对象的最大数目，取值范围为1~1000，当超出范围时，按照默认的1000进行处理。 Delimiter string 可选 指定用于对对象名分组的字符。分组步骤如下：① 先选出所有含此Delimiter的对象名；② 去掉这些对象名中的prefix（若请求中未指定prefix字段，则跳过此步）；③ 以首字符与Delimiter间的字符串（后续会作为CommonPrefix返回）为标准进行分组。 Origin string 可选 预请求指定的跨域请求Origin（通常为域名）。 RequestHeader string 可选 跨域请求可以使用的HTTP头域。 EncodingType string 可选 对响应中的部分元素进行指定类型的编码。如果Delimiter、KeyMarker、Prefix、CommonPrefixes、NextKeyMarker和Key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的Delimiter、KeyMarker、Prefix、CommonPrefixes、NextKeyMarker和Key进行编码。 可选值：url。

参数描述 字段名 类型 约束 说明 Bucket string 必选 桶名。 Marker string 可选 列举对象的起始位置，返回的对象列表将是对象名按照字典序排序后该参数以后的所有对象。 Prefix string 可选 限定返回的对象名必须带有prefix前缀。 MaxKeys int 可选 列举对象的最大数目，取值范围为1~1000，当超出范围时，按照默认的1000进行处理。 Delimiter string 可选 指定用于对对象名分组的字符。分组步骤如下：① 先选出所有含此Delimiter的对象名；② 去掉这些对象名中的prefix（若请求中未指定prefix字段，则跳过此步）；③ 以首字符与Delimiter间的字符串（后续会作为CommonPrefix返回）为标准进行分组。 对于并行文件系统，不携带此参数时默认列举是递归列举此目录下所有内容，会列举子目录。在大数据场景下（目录层级深、目录下文件多）的列举，建议设置[delimiter=/]，只列举当前目录下的内容，不列举子目录，提高列举效率。 Origin string 可选 预请求指定的跨域请求Origin（通常为域名）。 RequestHeader string 可选 跨域请求可以使用的HTTP头域。 EncodingType string 可选 对响应中的部分元素进行指定类型的编码。如果Delimiter、Marker、Prefix、CommonPrefixes、NextMarker和Key包含xml 1.0标准不支持的控制字符，可通过设置该参数指定对响应中的Delimiter、Marker、Prefix、CommonPrefixes、NextMarker和Key进行编码。 可选值：url。

参数描述 字段名 类型 说明 StatusCode int HTTP状态码。 RequestId string OBS服务端返回的请求ID。 ResponseHeaders map[string][]string HTTP响应头信息。 Location string 桶的区域位置。 Name string 桶名。 Prefix string 对象名的前缀，与请求中的该参数对应。 KeyMarker string 列举多版本对象的起始位置，与请求中的该参数对应。 VersionIdMarKer string 表示列举多版本对象的起始位置（VersionId标识），与请求中的该参数对应。 Delimiter string 用于对对象名进行分组的字符，与请求中的该参数对应。 MaxKeys int 列举多版本对象的最大数目，与请求中的该参数对应。 IsTruncated bool 表明本次请求是否返回了全部结果，true表示没有返回全部结果；false表示已返回了全部结果。 NextKeyMarker string 下次列举多版本对象请求的起始位置。 NextVersionIdMarker string 下次列举多版本对象请求的起始位置（VersionId标识），与NextKeyMarker配合使用。 Versions []Version 桶内多版本对象列表。 DeleteMarkers []DeleteMarker 桶内多版本删除标记列表。 CommonPrefixes []string 当请求中设置了Delimiter分组字符时，返回按Delimiter分组后的对象名称前缀列表。 EncodingType string 表明响应中的部分元素的编码类型。

参数描述 字段名 类型 约束 说明 Bucket string 必选 桶名。 Prefix string 可选 限定返回的分段上传任务中的对象名必须带有prefix前缀。 MaxUploads int 可选 列举分段上传任务的最大数目，取值范围为1~1000，当超出范围时，按照默认的1000进行处理。 Delimiter string 可选 指定用于对对象名分组的字符。分组步骤如下：① 先选出所有含此Delimiter的对象名；② 去掉这些对象名中的prefix（若请求中未指定prefix字段，则跳过此步）；③ 以首字符与Delimiter间的字符串（后续会作为CommonPrefix返回）为标准进行分组。 KeyMarker string 可选 表示列举时返回指定的KeyMarker之后的分段上传任务。 UploadIdMarker string 可选 只有与KeyMarker参数一起使用时才有意义，用于指定返回结果的起始位置，即列举时返回指定KeyMarker的UploadIdMarker之后的分段上传任务。 EncodingType string 可选 对响应中的部分元素进行指定类型的编码。如果Delimiter、KeyMarker、Prefix、CommonPrefixes、NextKeyMarker和Key包含xml 1.0标准不支持的控制字符，可通过设置该参数对响应中的Delimiter、KeyMarker、Prefix、CommonPrefixes、NextKeyMarker和Key进行编码。 可选值：url。

参数描述 字段名 类型 说明 StatusCode int HTTP状态码。 RequestId string OBS服务端返回的请求ID。 ResponseHeaders map[string][]string HTTP响应头信息。 Bucket string 桶名。 KeyMarker string 列举分段上传任务的起始位置，与请求中的该参数对应。 UploadIdMarker string 列举分段上传任务的起始位置（uploadId标识），与请求中的该参数对应。 NextKeyMarker string 下次列举分段上传任务请求的起始位置。 NextUploadIdMarker string 下次列举分段上传任务请求的起始位置（uploadId标识），与nextKeyMarker配合使用。 MaxUploads int 列举分段上传任务的最大数目，与请求中的该参数对应。 IsTruncated bool 表明本次请求是否返回了全部结果，true表示没有返回全部结果；false表示已返回了全部结果。 Prefix string 分段上传任务中的对象名前缀，与请求中的该参数对应。 Delimiter string 用于对分段上传任务中的对象名进行分组的字符，与请求中的该参数对应。 Uploads []Upload 桶内分段上传任务列表。 CommonPrefixes []string 当请求中设置了Delimiter分组字符时，返回按Delimiter分组后的对象名称前缀列表。 EncodingType string 表明响应中的部分元素的编码类型。

参数描述 字段名 类型 说明 Key string 分段上传任务的对象名。 UploadId string 分段上传任务的ID。 Initiator Initiator 分段上传任务的创建者。 Owner Owner 和Initiator相同，代表分段上传任务的创建者。 StorageClass StorageClassType 分段上传的对象的存储类型。 Initiated time.Time 分段上传任务的初始化时间。

参数描述 字段名 类型 约束 说明 Bucket string 必选 桶名。 RedirectAllRequestsTo RedirectAllRequestTo 可选 所有请求重定向规则。 IndexDocument IndexDocument 可选 默认页面配置，包含Suffix字段。 ErrorDocument ErrorDocument 可选 错误页面配置，包含Key字段。 RoutingRules []RoutingRule 可选 请求重定向规则列表。 ErrorDocument，IndexDocument和RoutingRules必须配套使用，且与RedirectAllRequestsTo互斥。当设置了这三个字段时，不能设置RedirectAllRequestsTo；反之，当设置了RedirectAllRequestsTo时，不能设置ErrorDocument，IndexDocument和RoutingRules。 当ErrorDocument，IndexDocument和RoutingRules三个字段一起使用时，RoutingRules可为空。 IndexDocument，IndexDocument、RoutingRules与RedirectAllRequestsTo不能全为空。

参数描述 字段名 类型 说明 StatusCode int HTTP状态码。 RequestId string OBS服务端返回的请求ID。 ResponseHeaders map[string][]string HTTP响应头信息。 Location string 桶的区域位置。 Version string OBS服务端版本。 StorageClass StorageClassType 桶的存储类型，当桶存储类型是标准存储时，该值为空。 AllowOrigin string 如果请求中的Origin满足桶的CORS规则，则返回CORS规则中的AllowedOrigin。 AllowHeader string 如果请求中的RequestHeader满足桶的CORS规则，则返回CORS规则中的AllowedHeader。 AllowMethod string 桶CORS规则中的AllowedMethod。 ExposeHeader string 桶CORS规则中的ExposeHeader。 MaxAgeSeconds int 桶CORS规则中的MaxAgeSeconds。 Epid string 创桶时可指定的企业项目id，开通企业项目的用户可以从企业项目服务获取，格式为uuid，默认项目传“0”或者不带该头域，未开通企业项目的用户可以不带该头域。 FSStatus FSStatusType 桶类型。 AZRedundancy string 桶的数据冗余存储策略属性，反映数据是单AZ存储还是多AZ存储。 取值为3az，表示数据冗余存储在同一区域的多个可用区。 不携带此头域表示为单az存储，仅使用1个可用区存储。

参数描述 字段名 类型 说明 StatusCode int HTTP状态码。 RequestId string OBS服务端返回的请求ID。 ResponseHeaders map[string][]string HTTP响应头信息。 Agency string 委托名。 TargetBucket string 生成日志的目标桶。 TargetPrefix string 在目标桶中生成日志对象的对象名前缀。 TargetGrants []Grant 被授权用户权限信息列表。

参数描述 字段名 类型 说明 StatusCode int HTTP状态码。 RequestId string OBS服务端返回的请求ID。 ResponseHeaders map[string][]string HTTP响应头信息。 RedirectAllRequestsTo RedirectAllRequestTo 所有请求重定向规则。 IndexDocument IndexDocument 默认页面配置，包含Suffix字段。 ErrorDocument ErrorDocument 错误页面配置，包含Key字段。 RoutingRules []RoutingRule 请求重定向规则列表。

运行示例 以Windows操作系统为例，运行obsutil rm obs://bucket-test，删除bucket-test桶。 obsutil rm obs://bucket-testDo you want delete bucket [bucket-test] ? Please input (y/n) to confirm:yDelete bucket [bucket-test] successfully!

参数说明 参数 约束 描述 authorization_code 或 file://authorization_code_file_url 必选 授权码。 说明： 如果以“file://”开头，则表明授权码是从本地文件中获取。 file_or_folder_url 下载对象时必选 本地文件/文件夹路径。 folder_url 批量下载时必选 本地文件夹路径。 key 附加参数，下载对象时必选 批量下载时可选 待下载的对象名，或批量下载的对象名前缀。 下载对象时，该值不能为空，最终保存在本地的位置及命名规则如下： 如果file_or_folder_url不存在，则工具会判断其是否以“/”或“\”结尾，如果是，则会以该路径创建文件夹，将对象下载到该新建的文件夹下； 如果file_or_folder_url不存在，且不以“/”或“\”结尾，则以该值作为文件名，将对象下载到本地； 如果file_or_folder_url为已存在的文件，则以该值作为文件名，将对象覆盖下载到本地； 如果file_or_folder_url为已存在的文件夹，则以对象名为文件名，将对象覆盖下载到file_or_folder_url指定的文件夹下。 批量下载时，最终保存在本地的位置规则如下： 如果该值为空，则表示将授权码中授权路径下的所有对象下载到folder_url指定的文件夹下； 如果该值不为空，则将桶内以该值作为对象名前缀的内容下载到folder_url指定的文件夹下。 说明： 如果该值不为空，其必须是授权码中授权路径的子集； 批量下载且该值不为空时，若未设置flat选项，则下载的本地文件会包含上一级父对象名前缀；若设置了flat选项，则下载的本地文件不包含上一级父对象名前缀。 须知： 批量下载时，如果设置了flat选项，且如果创建授权码时的对象名前缀为空或者不以“/”结尾，则可能导致下载的对象列表为空。 ac 附加参数，可选 提取码。 说明： 如果未使用该参数设置提取码，obsutil工具会以交互模式提示输入提取码； 提取码必须为6位。 r 附加参数，批量下载时必选 按指定的对象名前缀批量下载对象。 fr 附加参数，下载对象时可选 下载对象时生成结果清单文件。 flat 附加参数，批量下载时可选 批量下载时，不包含上一级父对象名前缀。 tempFileDir 附加参数，可选 分段下载时保存临时文件的文件夹，默认为配置文件中的defaultTempFileDir。 说明： 如果该值为空，且配置文件中的defaultTempFileDir也为空，则分段下载时生成的临时文件会保存在待下载文件的同目录下并以.obs.temp结尾。 由于分段下载时生成的临时文件会保存在该目录，请确保运行obsutil的用户对该路径有写权限； 该路径的可用空间需要大于待下载对象的大小。 dryRun 附加参数，可选 测试模式运行，不执行实际的下载操作。 u 附加参数，可选 增量下载操作，设置该参数后，下载每个对象时会对比本地对应路径的文件，仅在文件不存在，或者文件大小与对象大小不一致，或者文件的最后修改时间早于对象的最后修改时间时进行下载。 注意： 在比较每个本地文件与桶内对象差异时，会产生一次HEAD请求费用。 vlength 附加参数，可选 下载完成后，验证本地文件大小是否与桶中对象的大小一致。 vmd5 附加参数，可选 下载完成后，验证本地文件的MD5值是否与桶中对象的MD5值一致。 说明： 桶中对象必须包含元数据x-obs-meta-md5chksum，否则会忽略MD5值校验。 p 附加参数，可选 每个分段下载任务的最大并发数，默认为配置文件中的defaultParallels。 threshold 附加参数，可选 开启分段下载任务的阈值，单位：字节，默认为配置文件中的defaultBigfileThreshold。 说明： 如果待下载的对象小于该阈值，则使用直接下载模式；否则使用分段下载模式； 直接下载模式不会产生断点记录文件，不支持断点续传； 支持带容量单位配置，例如，配置1MB代表1048576字节。 ps 附加参数，可选 每个分段下载任务的段大小，单位：字节，默认为配置文件中的defaultPartSize。 说明： 支持带容量单位配置，例如，配置1MB代表1048576字节； 支持配置为auto，此时obsutil会根据源对象大小自动设置每个分段任务的段大小。 cpd 附加参数，可选 生成断点记录文件的文件夹，默认为运行obsutil命令的用户目录的子文件夹.obsutil_checkpoint。 说明： 每个分段下载任务会产生唯一对应的断点记录文件并保存至该文件夹的down子文件夹下，分段任务执行成功后，对应的断点记录文件会被自动删除；分段任务执行失败或被中断后，下次执行该分段任务时会尝试通过对应的断点记录文件恢复任务。 f 附加参数，批量下载时可选 强制操作，不进行询问提示。 j 附加参数，批量下载时可选 批量下载时的最大并发数，默认为配置文件中的defaultJobs。 说明： 工具会保证该值至少为1。 exclude 附加参数，批量下载时可选 不包含源对象的匹配模式，如：*.txt。 说明： 支持“*”匹配多个任意字符和“?”匹配单个任意字符，例如abc*.txt代表匹配以abc开头以.txt结尾的任意文件； 您可以使用“\*”代表匹配“*”字符本身，使用“\?”代表匹配“?”字符本身； 如果待下载的对象名匹配该参数，则跳过该对象的复制； 须知： 建议使用引号传递该匹配模式（macOS/Linux操作系统使用单引号，Windows操作系统使用双引号）防止特殊符号被操作系统转义，导致不可预期的结果； 该匹配模式作用于对象全路径（含从根路径开始的对象前缀和对象名，例如，桶内对象路径为obs://bucket/src1/src2/test.txt，则对象的全路径为src1/src2/test.txt）； 该匹配模式仅适用于对象名非“/”结尾的对象； 支持指定多个exclude参数，如-exclude=*.xxx -exclude=*.xxx include 附加参数，批量下载时可选 包含源对象的匹配模式，如：*.jpg。 说明： 支持“*”匹配多个任意字符和“?”匹配单个任意字符； 您可以使用“\*”代表匹配“*”字符本身，使用“\?”代表匹配“?”字符本身； 首先执行exclude的匹配规则，如果待下载的对象名不匹配exclude，则判断待下载的对象名是否匹配该参数，如果匹配则下载该对象，否则跳过该文件的下载。 须知： 建议使用引号传递该匹配模式（macOS/Linux操作系统使用单引号，Windows操作系统使用双引号）防止特殊符号被操作系统转义，导致不可预期的结果。 该匹配模式作用于对象全路径（含从根路径开始的对象前缀和对象名，例如，桶内对象路径为obs://bucket/src1/src2/test.txt，则对象的全路径为src1/src2/test.txt）。 该匹配模式仅适用于对象名非“/”结尾的对象。 支持指定多个include参数，如-include=*.xxx -include=*.xxx timeRange 附加参数，批量下载时可选 下载对象时的时间段匹配模式，仅下载最后修改时间在该时间段内的对象。 该匹配模式优先级低于对象名匹配模式：exclude和include，优先执行对象名匹配模式后才会执行该匹配模式。 说明： 使用“time1-time2”，代表匹配的时间段，其中time1必须小于等于time2，格式为yyyyMMddHHmmss。 时间格式支持自动补全，例如yyyyMMdd等价于yyyyMMdd000000，yyyyMM等价于yyyyMM01000000。 使用“*-time2”，代表匹配最后修改时间在time2之前的所有文件，使用“time1-*”，代表匹配最后修改时间time1之后的所有文件。 须知： 该匹配模式表示的时间是UTC时间。 该匹配模式仅适用于对象名非“/”结尾的对象。 mf 附加参数，可选 设置名称匹配模式（include、exclude）和时间匹配模式（timeRange）对对象名以“/”结尾的对象也生效。 o 附加参数，可选 生成结果清单文件的文件夹，命令执行完成后，会在该文件夹下生成结果清单文件（可能包含成功结果、失败结果和警告结果三个文件），默认为运行obsutil命令的用户目录的子文件夹.obsutil_output。 说明： 结果清单文件命名规则：share-cp_{succeed | failed | warning}_report_时间_TaskId.txt。 单个结果清单文件默认情况下最大为30MB且最大可保留的文件个数为1024，可在配置文件中通过recordMaxLogSize和recordBackups分别配置。 当涉及多文件/文件夹时，如需确认失败任务的具体错误信息，可参考结果清单文件夹下的失败结果清单文件及日志路径下的日志文件； config 附加参数，可选 运行当前命令时的自定义配置文件，可支持的配置参数请参考配置参数说明。 e 附加参数，可选 指定终端节点。 i 附加参数，可选 指定用户的AK。 k 附加参数，可选 指定用户的SK。 t 附加参数，可选 指定用户的securitytoken。

命令结构 Windows操作系统 直接输入授权码下载单个对象 obsutil share-cp authorization_code file_or_folder_url -key=xxx [-ac=xxx] [-dryRun] [-tempFileDir=xxx] [-u] [-vlength] [-vmd5] [-p=1] [-threshold=52428800] [-ps=auto] [-cpd=xxx][-fr] [-o=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx] 使用文件路径传入授权码下载单个对象 obsutil share-cp file://authorization_code_file_url file_or_folder_url -key=xxx [-ac=xxx] [-dryRun] [-tempFileDir=xxx] [-u] [-vlength] [-vmd5] [-p=1] [-threshold=52428800] [-ps=auto] [-cpd=xxx][-fr] [-o=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx] 直接输入授权码批量下载对象 obsutil share-cp authorization_code folder_url -r [-key=xxx] [-ac=xxx] [-dryRun] [-tempFileDir=xxx] [-f] [-u] [-vlength] [-vmd5] [-flat] [-j=1] [-p=1] [-threshold=52428800] [-ps=auto] [-include=*.xxx] [-exclude=*.xxx] [-timeRange=time1-time2] [-mf] [-o=xxx] [-cpd=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx] 使用文件路径传入授权码批量下载对象 obsutil share-cp file://authorization_code_file_url folder_url -r [-key=xxx] [-ac=xxx] [-dryRun] [-tempFileDir=xxx] [-f] [-u] [-vlength] [-vmd5] [-flat] [-j=1] [-p=1] [-threshold=52428800] [-ps=auto] [-include=*.xxx] [-exclude=*.xxx] [-timeRange=time1-time2] [-mf] [-o=xxx] [-cpd=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx] macOS/Linux操作系统 直接输入授权码下载单个对象 ./obsutil share-cp authorization_code file_or_folder_url -key=xxx [-ac=xxx] [-dryRun] [-tempFileDir=xxx] [-u] [-vlength] [-vmd5] [-p=1] [-threshold=52428800] [-ps=auto] [-cpd=xxx][-fr] [-o=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx] 使用文件路径传入授权码下载单个对象 ./obsutil share-cp file://authorization_code_file_url file_or_folder_url -key=xxx [-ac=xxx] [-dryRun] [-tempFileDir=xxx] [-u] [-vlength] [-vmd5] [-p=1] [-threshold=52428800] [-ps=auto] [-cpd=xxx][-fr] [-o=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx] 直接输入授权码批量下载对象 ./obsutil share-cp authorization_code folder_url -r [-key=xxx] [-ac=xxx] [-dryRun] [-tempFileDir=xxx] [-f] [-u] [-vlength] [-vmd5] [-flat] [-j=1] [-p=1] [-threshold=52428800] [-ps=auto] [-include=*.xxx] [-exclude=*.xxx] [-timeRange=time1-time2] [-mf] [-o=xxx] [-cpd=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx] 使用文件路径传入授权码批量下载对象 ./obsutil share-cp file://authorization_code_file_url folder_url -r [-key=xxx] [-ac=xxx] [-dryRun] [-tempFileDir=xxx] [-f] [-u] [-vlength] [-vmd5] [-flat] [-j=1] [-p=1] [-threshold=52428800] [-ps=auto] [-include=*.xxx] [-exclude=*.xxx] [-timeRange=time1-time2] [-mf] [-o=xxx] [-cpd=xxx] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

指定obsutil上传下载时进行限速 obsutil支持通过在配置文件.obsutilconfig中配置rateLimitThreshold参数实现对上传/下载操作进行限速，参数具体描述可参考配置参数说明；默认不指定即不进行限速，此时具体的上传/下载速度取决于用户侧的实际网络带宽及上传/下载任务的并发配置，具体调优方案可以参考obsutil性能调优最佳实践。 需要注意的是，rateLimitThreshold参数指定的是obsutil任务的全局限速，这意味着当使用cp、sync等命令进行批量文件的上传/下载时，最终的实际上传/下载速度上限仍然为rateLimitThreshold指定的阈值而不是批量任务的并发任务数*rateLimitThreshold 父主题： 最佳实践