配置、编辑、查看对象元数据

ContentDisposition

用来指示浏览器如何处理接收到的内容。最常见用于在下载文件时，指示浏览器直接显示文件还是重命名后下载至本地。常见的取值如下：

• ContentDisposition: inline：表示直接预览文件内容。

  如果没有为桶配置自定义域名，那么为对象配置元数据ContentDisposition: inline将不生效，因为OBS会强制返回ContentDisposition: attachment头域。

• ContentDisposition: attachment：以原文件名下载到浏览器指定路径下。
• ContentDisposition: attachment; filename="testfile.xls"：以自定义文件名（testfile.xls）下载到浏览器指定路径下。

关于更多内容，详情请参见HTTP协议中关于ContentDisposition的定义。

是

ContentLanguage

说明访问者希望根据自己偏好的语言来定制展示对象内容所采用的语言或语言组合。常见的取值如下：

• ContentLanguage: zh-CN：简体中文
• Content-Language: en-US：英语
• Content-Language: fr-FR：法语
• Content-Language: es-ES：西班牙语

关于更过内容，详情请参见HTTP协议中关于ContentLanguage的定义。

是

WebsiteRedirectLocation

为对象提供重定向功能，重定向到其他对象或者外部的URL。当对象被配置为重定向时，请求该对象，返回的响应头中会包含WebsiteRedirectLocation（用来告诉客户端应该重定向到其他URL页面）。重定向功能通过静态网站托管实现。

格式为：WebsiteRedirectLocation: <url>，其中“<url>”为重定向的目标URL。

OBS仅支持为桶根目录下的对象设置重定向，不支持为桶中文件夹下的对象设置重定向。

例如，可根据如下步骤实现对象重定向功能。

1. 为桶“testbucket”根目录下的对象“testobject.html”设置元数据，元数据名称选择为“WebsiteRedirectLocation”，元数据值填写为“http://www.example.com”
2. 在桶“testbucket”中配置静态网站托管，将该桶中的对象“testobject.html”设置为静态网站托管的“默认首页”。
3. 当通过静态网站托管页面上的“访问地址”访问对象“testobject.html”时，会直接重定向访问http://www.example.com。

是

ContentEncoding

指定对象被下载时的内容编码格式。配置该元数据，可以让客户端根据对象的编码格式来正确解码，以便正确显示或处理内容。可以设置如下类型：

• 标准定义：
  • identity：内容未被编码，即原始内容。
  • gzip：使用GNU zip压缩算法，最常见的压缩方式，适用于各种数据。
  • compress：使用LZW压缩算法，较少使用。
  • deflate：使用zlib格式的压缩算法，基于DEFLATE算法，较少使用。
  • exi：使用EXI格式进行压缩，专门用于XML数据。
  • pack200-gzip：使用Java的Pack200压缩算法，然后使用gzip进一步压缩，专为Java JAR文件设计的压缩方式。
• 其他：
  • br：使用Brotli压缩算法，现在的浏览器普遍都支持。
  • bzip2：使用bzip2压缩算法，压缩效果好但速度慢。
  • lzma：使用LZMA压缩算法，压缩效果好但速度慢。
  • peerdist：使用PDP进行内容分发。
  • sdch：使用SDCH压缩算法，通过共享字典进行高效压缩。
  • xpress：使用Xpress压缩算法，较少使用，用于特定场景。
  • xz：使用XZ压缩算法，基于LZMA2，压缩效果非常好但速度慢。

是

CacheControl

指定对象被下载时的网页的缓存行为。取值如下：

• 可缓冲性：
  • public：可以被任何缓存存储，包括私有和共享缓存。
  • private：只能被私有用户缓存存储，不能被共享缓存存储。
  • no-cache：缓存不存储任何请求或响应相关的内容。
  • only-if-cached：仅接受缓存中的资源，不重新验证。
• 到期时间：
  • max-age=<seconds>：客户端接受资源的最大新鲜度。
  • s-maxage=<seconds>：共享缓存中资源保持新鲜的最长时间。
  • max-stale[=<seconds>]：客户端愿意接受已过期的资源，可指定最长过期时间。
  • min-fresh=<seconds>：客户端接受资源的最小新鲜度
  • stale-while-revalidate=<seconds>：缓存在资源过期后继续使用已缓存的旧资源，同时在后台重新验证资源的新鲜度。
  • stale-if-error=<seconds>：缓存在网络错误或重新验证失败时使用已缓存的旧资源。
• 重新验证和重新加载：
  • must-revalidate：缓存必须在资源过期后重新验证资源。
  • proxy-revalidate：类似于must-revalidate，但仅适用于共享缓存。
  • immutable：资源在其缓存生命周期内不会发生变化。缓存可以无限期地使用已缓存的资源，而不需要重新验证。
• 其他：

  no-store：客户端不用存储任何请求或响应相关的内容。

  no-transform：缓存服务器不要修改资源。缓存服务器可能会对资源进行压缩、格式转换等操作，以优化传输。

是

Expires

设置缓存过期时间（GMT）。

是

ContentType

设置对象的文件类型。文件类型决定了浏览器将以什么形式、什么编码读取文件。详见表2。

是

Date

当前日期和时间。如：WED, 01 Jul 2015 04:19:21 GMT

否

Content-Length

对象大小

单位：字节

否

Last-Modified

对象首次上传日期或最后一次修改的日期。如：WED, 01 Jul 2015 04:19:21 GMT

对于分段上传，对象的创建日期是开始进行分段上传的日期。

否

ETag

对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识，可以通过该值识别对象内容是否有变化。例如：上传对象时ETag为A，下载对象时ETag为B，则说明对象内容发生了变化。

实际的ETag是对象的哈希值。

否

x-obs-tagging-count

对象关联的标签个数。如：x-obs-tagging-count:1表示该对象有1个标签

否

x-obs-version-id

对象的版本号。对桶启用多版本控制时，OBS会为桶中的对象指定版本号。更多信息，请参见多版本控制。

否

x-obs-storage-class

对象的存储类别。取值如下：

• STANDARD：标准存储类别
• WARM：低频访问存储类别
• COLD：归档存储类别
• DEEP_ARCHIVE：深度归档存储类别

是

.*（二进制流，不知道下载文件类型）

application/octet-stream

.7z

application/x-7z-compressed

.001

application/x-001

.301

application/x-301

.323

text/h323

.906

application/x-906

.907

drawing/907

.a11

application/x-a11

.acp

audio/x-mei-aac

.ai

application/postscript

.aif

audio/aiff

.aifc

audio/aiff

.aiff

audio/aiff

.anv

application/x-anv

.asa

text/asa

.asf

video/x-ms-asf

.asp

text/asp

.asx

video/x-ms-asf

.au

audio/basic

.avi

video/avi

.awf

application/vnd.adobe.workflow

.biz

text/xml

.bmp

application/x-bmp

.bot

application/x-bot

.c4t

application/x-c4t

.c90

application/x-c90

.cal

application/x-cals

.cat

application/vnd.ms-pki.seccat

.cdf

application/x-netcdf

.cdr

application/x-cdr

.cel

application/x-cel

.cer

application/x-x509-ca-cert

.cg4

application/x-g4

.cgm

application/x-cgm

.cit

application/x-cit

.class

java/*

.cml

text/xml

.cmp

application/x-cmp

.cmx

application/x-cmx

.cot

application/x-cot

.crl

application/pkix-crl

.crt

application/x-x509-ca-cert

.csi

application/x-csi

.css

text/css

.cut

application/x-cut

.dbf

application/x-dbf

.dbm

application/x-dbm

.dbx

application/x-dbx

.dcd

text/xml

.dcx

application/x-dcx

.der

application/x-x509-ca-cert

.dgn

application/x-dgn

.dib

application/x-dib

.dll

application/x-msdownload

.doc

application/msword

.dot

application/msword

.drw

application/x-drw

.dtd

text/xml

.dwf

Model/vnd.dwf

.dwf

application/x-dwf

.dwg

application/x-dwg

.dxb

application/x-dxb

.dxf

application/x-dxf

.edn

application/vnd.adobe.edn

.emf

application/x-emf

.eml

message/rfc822

.ent

text/xml

.epi

application/x-epi

.eps

application/x-ps

.eps

application/postscript

.etd

application/x-ebx

.exe

application/x-msdownload

.fax

image/fax

.fdf

application/vnd.fdf

.fif

application/fractals

.fo

text/xml

.frm

application/x-frm

.g4

application/x-g4

.gbr

application/x-gbr

.

application/x-

.gif

image/gif

.gl2

application/x-gl2

.gp4

application/x-gp4

.hgl

application/x-hgl

.hmr

application/x-hmr

.hpg

application/x-hpgl

.hpl

application/x-hpl

.hqx

application/mac-binhex40

.hrf

application/x-hrf

.hta

application/hta

.htc

text/x-component

.htm

text/html

.html

text/html

.htt

text/webviewhtml

.htx

text/html

.icb

application/x-icb

.ico

image/x-icon

.ico

application/x-ico

.iff

application/x-iff

.ig4

application/x-g4

.igs

application/x-igs

.iii

application/x-iphone

.img

application/x-img

.ins

application/x-internet-signup

.isp

application/x-internet-signup

.IVF

video/x-ivf

.java

java/*

.jfif

image/jpeg

.jpe

image/jpeg

.jpe

application/x-jpe

.jpeg

image/jpeg

.jpg

image/jpeg

.jpg

application/x-jpg

.js

application/x-javascript

.jsp

text/html

.la1

audio/x-liquid-file

.lar

application/x-laplayer-reg

.latex

application/x-latex

.lavs

audio/x-liquid-secure

.lbm

application/x-lbm

.lmsff

audio/x-la-lms

.ls

application/x-javascript

.ltr

application/x-ltr

.m1v

video/x-mpeg

.m2v

video/x-mpeg

.m3u

audio/mpegurl

.m4e

video/mpeg4

.mac

application/x-mac

.man

application/x-troff-man

.math

text/xml

.mdb

application/msaccess

.mdb

application/x-mdb

.mfp

application/x-shockwave-flash

.mht

message/rfc822

.mhtml

message/rfc822

.mi

application/x-mi

.mid

audio/mid

.midi

audio/mid

.mil

application/x-mil

.mml

text/xml

.mnd

audio/x-musicnet-download

.mns

audio/x-musicnet-stream

.mocha

application/x-javascript

.movie

video/x-sgi-movie

.mp1

audio/mp1

.mp2

audio/mp2

.mp2v

video/mpeg

.mp3

audio/mp3

.mp4

video/mp4

.mpa

video/x-mpg

.mpd

application/vnd.ms-project

.mpe

video/x-mpeg

.mpeg

video/mpg

.mpg

video/mpg

.mpga

audio/rn-mpeg

.mpp

application/vnd.ms-project

.mps

video/x-mpeg

.mpt

application/vnd.ms-project

.mpv

video/mpg

.mpv2

video/mpeg

.mpw

application/vnd.ms-project

.mpx

application/vnd.ms-project

.mtx

text/xml

.mxp

application/x-mmxp

.net

image/pnetvue

.nrf

application/x-nrf

.nws

message/rfc822

.odc

text/x-ms-odc

.out

application/x-out

.p10

application/pkcs10

.p12

application/x-pkcs12

.p7b

application/x-pkcs7-certificates

.p7c

application/pkcs7-mime

.p7m

application/pkcs7-mime

.p7r

application/x-pkcs7-certreqresp

.p7s

application/pkcs7-signature

.pc5

application/x-pc5

.pci

application/x-pci

.pcl

application/x-pcl

.pcx

application/x-pcx

.pdf

application/pdf

.pdf

application/pdf

.pdx

application/vnd.adobe.pdx

.pfx

application/x-pkcs12

.pgl

application/x-pgl

.pic

application/x-pic

.pko

application/vnd.ms-pki.pko

.pl

application/x-perl

.plg

text/html

.pls

audio/scpls

.plt

application/x-plt

.png

image/png

.png

application/x-png

.pot

application/vnd.ms-powerpoint

.ppa

application/vnd.ms-powerpoint

.ppm

application/x-ppm

.pps

application/vnd.ms-powerpoint

.ppt

application/vnd.ms-powerpoint

.ppt

application/x-ppt

.pr

application/x-pr

.prf

application/pics-rules

.prn

application/x-prn

.prt

application/x-prt

.ps

application/x-ps

.ps

application/postscript

.ptn

application/x-ptn

.pwz

application/vnd.ms-powerpoint

.r3t

text/vnd.rn-realtext3d

.ra

audio/vnd.rn-realaudio

.ram

audio/x-pn-realaudio

.ras

application/x-ras

.rat

application/rat-file

.rdf

text/xml

.rec

application/vnd.rn-recording

.red

application/x-red

.rgb

application/x-rgb

.rjs

application/vnd.rn-realsystem-rjs

.rjt

application/vnd.rn-realsystem-rjt

.rlc

application/x-rlc

.rle

application/x-rle

.rm

application/vnd.rn-realmedia

.rmf

application/vnd.adobe.rmf

.rmi

audio/mid

.rmj

application/vnd.rn-realsystem-rmj

.rmm

audio/x-pn-realaudio

.rmp

application/vnd.rn-rn_music_package

.rms

application/vnd.rn-realmedia-secure

.rmvb

application/vnd.rn-realmedia-vbr

.rmx

application/vnd.rn-realsystem-rmx

.rnx

application/vnd.rn-realplayer

.rp

image/vnd.rn-realpix

.rpm

audio/x-pn-realaudio-plugin

.rsml

application/vnd.rn-rsml

.rt

text/vnd.rn-realtext

.rtf

application/msword

.rtf

application/x-rtf

.rv

video/vnd.rn-realvideo

.sam

application/x-sam

.sat

application/x-sat

.sdp

application/sdp

.sdw

application/x-sdw

.sit

application/x-stuffit

.slb

application/x-slb

.sld

application/x-sld

.slk

drawing/x-slk

.smi

application/smil

.smil

application/smil

.smk

application/x-smk

.snd

audio/basic

.sol

text/plain

.sor

text/plain

.spc

application/x-pkcs7-certificates

.spl

application/futuresplash

.spp

text/xml

.ssm

application/streamingmedia

.sst

application/vnd.ms-pki.certstore

.stl

application/vnd.ms-pki.stl

.stm

text/html

.sty

application/x-sty

.svg

text/xml

.swf

application/x-shockwave-flash

.tdf

application/x-tdf

.tg4

application/x-tg4

.tga

application/x-tga

.tif

image/tiff

.tif

application/x-tif

.tiff

image/tiff

.tld

text/xml

.top

drawing/x-top

.torrent

application/x-bittorrent

.tsd

text/xml

.txt

text/plain

.uin

application/x-icq

.uls

text/iuls

.vcf

text/x-vcard

.vda

application/x-vda

.vdx

application/vnd.visio

.vml

text/xml

.vpg

application/x-vpeg005

.vsd

application/vnd.visio

.vsd

application/x-vsd

.vss

application/vnd.visio

.vst

application/vnd.visio

.vst

application/x-vst

.vsw

application/vnd.visio

.vsx

application/vnd.visio

.vtx

application/vnd.visio

.vxml

text/xml

.wav

audio/wav

.wax

audio/x-ms-wax

.wb1

application/x-wb1

.wb2

application/x-wb2

.wb3

application/x-wb3

.wbmp

image/vnd.wap.wbmp

.wiz

application/msword

.wk3

application/x-wk3

.wk4

application/x-wk4

.wkq

application/x-wkq

.wks

application/x-wks

.wm

video/x-ms-wm

.wma

audio/x-ms-wma

.wmd

application/x-ms-wmd

.wmf

application/x-wmf

.wml

text/vnd.wap.wml

.wmv

video/x-ms-wmv

.wmx

video/x-ms-wmx

.wmz

application/x-ms-wmz

.wp6

application/x-wp6

.wpd

application/x-wpd

.wpg

application/x-wpg

.wpl

application/vnd.ms-wpl

.wq1

application/x-wq1

.wr1

application/x-wr1

.wri

application/x-wri

.wrk

application/x-wrk

.ws

application/x-ws

.ws2

application/x-ws

.wsc

text/scriptlet

.wsdl

text/xml

.wvx

video/x-ms-wvx

.xdp

application/vnd.adobe.xdp

.xdr

text/xml

.xfd

application/vnd.adobe.xfd

.xfdf

application/vnd.adobe.xfdf

.xhtml

text/html

.xlsx

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

.xls

application/x-xls

.xlw

application/x-xlw

.xml

text/xml

.xpl

audio/scpls

.xq

text/xml

.xql

text/xml

.xquery

text/xml

.xsd

text/xml

.xsl

text/xml

.xslt

text/xml

.xwd

application/x-xwd

.x_b

application/x-x_b

.sis

application/vnd.symbian.install

.sisx

application/vnd.symbian.install

.x_t

application/x-x_t

.ipa

application/vnd.iphone

.apk

application/vnd.android.package-archive

.xap

application/x-silverlight-app

.zip

application/zip

.rar

application/x-rar-compressed

.wasm

application/wasm

-

-

Java

Python

C

Go

BrowserJS

.NET

Android

iOS

PHP

Node.js

bucket

必选

对象所属的桶的名称。

key

设置单个对象属性时必选

批量设置对象属性时可选

待设置属性的对象名，或批量设置对象属性时的对象名前缀。

批量设置对象属性时，如果该值为空，则表示设置桶内所有对象的属性。

meta

附加参数，可选

设置对象属性时可指定的目标对象的标准和自定义元数据。

• 标准元数据包括：Content-Type、Content-Encoding、Cache-Control、Content-Disposition、Content-Language、Expires。
• 自定义元数据格式为：key:value，多个自定义元数据使用#链接。例如key1:value1#key2:value2#key3:value3，其含义是，设置对象属性后，桶内目标对象包含三组自定义元数据，分别为：key1:value1、key2:value2、key3:value3。

该参数需要与direct搭配使用才会生效。

direct

附加参数，可选

元数据操作指示符。

取值为：

• REPLACE_NEW：对于已经存在值的元数据进行替换，不存在值的元数据进行赋值，未指定的元数据保持不变。
• REPLACE：使用当前请求中携带的头域完整替换，未指定的元数据会被删除。

该参数需要与meta搭配使用才会生效。

sc

附加参数，可选

对象的存储类别。支持的值：

• standard：标准存储，访问时延低、吞吐量高，适用于有大量热点文件（平均一个月多次）或小文件（小于1MB）。
• warm：低频访问存储，可用性略低于standard，适用于不频繁访问（平均一年少于12次）但在需要时也要求快速访问数据的业务场景。
• cold：归档存储，，安全、持久且成本极低，适用于很少访问（平均一年访问一次）数据的业务场景。
• deep-archive：深度归档存储，适用于长期不访问（平均几年访问一次）数据的业务场景，其成本相比归档存储更低，但相应的数据恢复时间将更长，一般为数小时。

存储类型为cold的对象，必须首先恢复该对象再设置其存储类别，否则无法设置成功，恢复对象的命令请参见恢复对象。

acl

附加参数，可选

对象的预定义访问策略。支持的值：

• private：私有读写
• public-read：公共读
• public-read-write：公共读写
• bucket-owner-full-control：桶拥有者完全控制

aclXml

附加参数，可选

桶的访问策略（xml格式表示）。格式如下：

<AccessControlPolicy>
    <Owner>
        <ID>ownerid</ID>
    </Owner>
    <AccessControlList>
        <Grant>
            <Grantee>
                <ID>userid</ID>
            </Grantee>
            <Permission>[WRITE|WRITE_ACP|READ|READ_ACP|FULL_CONTROL]</Permission>
        </Grant>
        <Grant>
            <Grantee>
                <Canned>Everyone</Canned>
            </Grantee>
            <Permission>[WRITE|WRITE_ACP|READ|READ_ACP|FULL_CONTROL]</Permission>
        </Grant>
    </AccessControlList>
</AccessControlPolicy>

• Owner节点为可选，指定对象拥有者ID。
• AccessControlList节点下的Grant子节点包含被授权的用户列表，Grantee子节点指定被授权用户的ID，Canned子节点指定被授权的用户组（当前仅支持Everyone）。
• 可支持被授予的权限有：
  • WRITE：写权限
  • WRITE_ACP：写ACL权限
  • READ：读权限
  • READ_ACP：读ACL权限
  • FULL_CONTROL：完全控制权限

由于该参数值必定含有“<”和“>”，作为命令运行时，必须使用引号转义（macOS/Linux操作系统使用单引号，Windows操作系统使用双引号）。

fs

附加参数，可选

是否使用并行文件系统的列举方式，如果桶是并行文件系统，推荐加上该参数。

• 该参数开启后，会忽略marker和limit值，统计桶或者并行文件系统或者指定目录的大小。
• Util 5.5.12版本及以上支持该参数。
• 该列举方式会因为目录结构，耗时差别很大。

versionId

附加参数，设置单个对象属性时可选

待设置属性对象的版本号。

fr

附加参数，设置单个对象属性时可选

设置单个对象属性时生成结果清单文件。

f

附加参数，批量设置对象属性时可选

强制操作，不进行询问提示。

r

附加参数，批量设置对象属性时必选

按指定的对象名前缀批量设置对象属性。

v

附加参数，批量设置对象属性时可选

按指定的对象名前缀批量设置多版本对象属性。

o

附加参数，可选

生成结果清单文件的文件夹，命令执行完成后，会在该文件夹下生成结果清单文件（包含成功结果和失败结果两个文件）。

默认为运行obsutil命令的用户目录的子文件夹.obsutil_output。

• 结果清单文件命名规则：cp_{succeed | failed | warning}_report_时间_TaskId.txt。
• 单个结果清单文件默认情况下最大为30MB，可在配置文件中通过recordMaxLogSize分别配置。
• 单个结果清单文件默认情况下最多可保留1024个文件，可在配置文件中通过recordBackups分别配置。
• 当涉及多文件/文件夹时，如需确认失败任务的具体错误信息，可参考结果清单文件夹下的失败结果清单文件“cp_failed_report_时间_TaskId.txt”和日志路径下的日志文件。

j

附加参数，批量设置对象属性时可选

批量设置对象属性的最大并发数，默认为配置文件中的defaultJobs。

bucket-cname

附加参数，可选

指定桶绑定的自定义域名

config

附加参数，可选

运行当前命令时的自定义配置文件。可支持的配置参数请参考配置参数说明。

e

附加参数，可选

指定终端节点。

i

附加参数，可选

指定用户的AK。

k

附加参数，可选

指定用户的SK。

t

附加参数，可选

指定用户的securitytoken。

Parallel

请求中的-p参数。

Jobs

请求中的-j参数。

Threshold

请求中的-threshold参数。

PartSize

请求中的-ps参数。

Exclude

请求中的-exclude参数。

Include

请求中的-include参数。

TimeRange

请求中的-timeRange参数。

VerifyLength

请求中的-vlength参数。

VerifyMd5

请求中的-vmd5参数。

CheckpointDir

请求中的-cpd参数。

OutputDir

请求中的-o参数。

ArcDir

请求中的-arcDir参数。

Succeed count

成功的任务数。

Failed count

失败的任务数。

Skip count

增量上传/下载/复制、同步上传/下载/复制跳过的任务数。

Warning count

执行完成但包含警告的任务数。

Succeed bytes

上传/下载成功的字节数。

max cost

所有任务中的最长耗时，单位：毫秒。

min cost

所有任务中的最短耗时，单位：毫秒。

average cost

平均耗时，单位：毫秒。

average tps

平均每秒的任务完成个数。

Task id

每次运行的唯一标识号，用于查找批量任务生成的结果清单文件。

Java

Python

C

Go

BrowserJS

.NET

Android

iOS

PHP

Node.js

bucket

必选

对象所属的桶的名称。

key

设置单个对象属性时必选

批量设置对象属性时可选

待设置属性的对象名，或批量设置对象属性时的对象名前缀。

批量设置对象属性时，如果该值为空，则表示设置桶内所有对象的属性。

meta

附加参数，可选

设置对象属性时可指定的目标对象的标准和自定义元数据。

• 标准元数据包括：Content-Type、Content-Encoding、Cache-Control、Content-Disposition、Content-Language、Expires。
• 自定义元数据格式为：key:value，多个自定义元数据使用#链接。例如key1:value1#key2:value2#key3:value3，其含义是，设置对象属性后，桶内目标对象包含三组自定义元数据，分别为：key1:value1、key2:value2、key3:value3。

该参数需要与direct搭配使用才会生效。

direct

附加参数，可选

元数据操作指示符。

取值为：

• REPLACE_NEW：对于已经存在值的元数据进行替换，不存在值的元数据进行赋值，未指定的元数据保持不变。
• REPLACE：使用当前请求中携带的头域完整替换，未指定的元数据会被删除。

该参数需要与meta搭配使用才会生效。

sc

附加参数，可选

对象的存储类别。支持的值：

• standard：标准存储，访问时延低、吞吐量高，适用于有大量热点文件（平均一个月多次）或小文件（小于1MB）。
• warm：低频访问存储，可用性略低于standard，适用于不频繁访问（平均一年少于12次）但在需要时也要求快速访问数据的业务场景。
• cold：归档存储，，安全、持久且成本极低，适用于很少访问（平均一年访问一次）数据的业务场景。
• deep-archive：深度归档存储，适用于长期不访问（平均几年访问一次）数据的业务场景，其成本相比归档存储更低，但相应的数据恢复时间将更长，一般为数小时。

存储类型为cold的对象，必须首先恢复该对象再设置其存储类别，否则无法设置成功，恢复对象的命令请参见恢复对象。

acl

附加参数，可选

对象的预定义访问策略。支持的值：

• private：私有读写
• public-read：公共读
• public-read-write：公共读写
• bucket-owner-full-control：桶拥有者完全控制

aclXml

附加参数，可选

桶的访问策略（xml格式表示）。格式如下：

<AccessControlPolicy>
    <Owner>
        <ID>ownerid</ID>
    </Owner>
    <AccessControlList>
        <Grant>
            <Grantee>
                <ID>userid</ID>
            </Grantee>
            <Permission>[WRITE|WRITE_ACP|READ|READ_ACP|FULL_CONTROL]</Permission>
        </Grant>
        <Grant>
            <Grantee>
                <Canned>Everyone</Canned>
            </Grantee>
            <Permission>[WRITE|WRITE_ACP|READ|READ_ACP|FULL_CONTROL]</Permission>
        </Grant>
    </AccessControlList>
</AccessControlPolicy>

• Owner节点为可选，指定对象拥有者ID。
• AccessControlList节点下的Grant子节点包含被授权的用户列表，Grantee子节点指定被授权用户的ID，Canned子节点指定被授权的用户组（当前仅支持Everyone）。
• 可支持被授予的权限有：
  • WRITE：写权限
  • WRITE_ACP：写ACL权限
  • READ：读权限
  • READ_ACP：读ACL权限
  • FULL_CONTROL：完全控制权限

由于该参数值必定含有“<”和“>”，作为命令运行时，必须使用引号转义（macOS/Linux操作系统使用单引号，Windows操作系统使用双引号）。

fs

附加参数，可选

是否使用并行文件系统的列举方式，如果桶是并行文件系统，推荐加上该参数。

• 该参数开启后，会忽略marker和limit值，统计桶或者并行文件系统或者指定目录的大小。
• Util 5.5.12版本及以上支持该参数。
• 该列举方式会因为目录结构，耗时差别很大。

versionId

附加参数，设置单个对象属性时可选

待设置属性对象的版本号。

fr

附加参数，设置单个对象属性时可选

设置单个对象属性时生成结果清单文件。

f

附加参数，批量设置对象属性时可选

强制操作，不进行询问提示。

r

附加参数，批量设置对象属性时必选

按指定的对象名前缀批量设置对象属性。

v

附加参数，批量设置对象属性时可选

按指定的对象名前缀批量设置多版本对象属性。

o

附加参数，可选

生成结果清单文件的文件夹，命令执行完成后，会在该文件夹下生成结果清单文件（包含成功结果和失败结果两个文件）。

默认为运行obsutil命令的用户目录的子文件夹.obsutil_output。

• 结果清单文件命名规则：cp_{succeed | failed | warning}_report_时间_TaskId.txt。
• 单个结果清单文件默认情况下最大为30MB，可在配置文件中通过recordMaxLogSize分别配置。
• 单个结果清单文件默认情况下最多可保留1024个文件，可在配置文件中通过recordBackups分别配置。
• 当涉及多文件/文件夹时，如需确认失败任务的具体错误信息，可参考结果清单文件夹下的失败结果清单文件“cp_failed_report_时间_TaskId.txt”和日志路径下的日志文件。

j

附加参数，批量设置对象属性时可选

批量设置对象属性的最大并发数，默认为配置文件中的defaultJobs。

bucket-cname

附加参数，可选

指定桶绑定的自定义域名

config

附加参数，可选

运行当前命令时的自定义配置文件。可支持的配置参数请参考配置参数说明。

e

附加参数，可选

指定终端节点。

i

附加参数，可选

指定用户的AK。

k

附加参数，可选

指定用户的SK。

t

附加参数，可选

指定用户的securitytoken。

Parallel

请求中的-p参数。

Jobs

请求中的-j参数。

Threshold

请求中的-threshold参数。

PartSize

请求中的-ps参数。

Exclude

请求中的-exclude参数。

Include

请求中的-include参数。

TimeRange

请求中的-timeRange参数。

VerifyLength

请求中的-vlength参数。

VerifyMd5

请求中的-vmd5参数。

CheckpointDir

请求中的-cpd参数。

OutputDir

请求中的-o参数。

ArcDir

请求中的-arcDir参数。

Succeed count

成功的任务数。

Failed count

失败的任务数。

Skip count

增量上传/下载/复制、同步上传/下载/复制跳过的任务数。

Warning count

执行完成但包含警告的任务数。

Succeed bytes

上传/下载成功的字节数。

max cost

所有任务中的最长耗时，单位：毫秒。

min cost

所有任务中的最短耗时，单位：毫秒。

average cost

平均耗时，单位：毫秒。

average tps

平均每秒的任务完成个数。

Task id

每次运行的唯一标识号，用于查找批量任务生成的结果清单文件。

Java

Python

C

Go

BrowserJS

.NET

Android

iOS

PHP

Node.js

bucket

必选

对象所属的桶的名称。

key

必选

待查询属性的对象名称。

acl

可选

同时查询对象的访问策略。

bf

附加参数，可选

对象大小字节数的显示格式。支持的值：

• human-readable：以易于人理解的方式显示对象存储大小。例如，显示为1GB（千字节，MB，GB，TB等），而不是显示一个很大的数字（如：1073741824）。
• raw：直接显示字节数，不经过任何形式的转换或格式化。例如，如果一个对象占用的空间是1GB，它会直接显示为1073741824字节。

对于普通用户来说，human-readable 更易于理解；而对于需要进行精确计算或自动化处理的场景，raw 格式则更为合适。

如果未设置该参数，则对象大小字节数的显示格式由配置文件中的humanReadableFormat参数决定。

bucket-cname

附加参数，可选

指定桶绑定的自定义域名

config

附加参数，可选

运行当前命令时的自定义配置文件。可支持的配置参数请参考配置参数说明。

e

附加参数，可选

指定终端节点。

i

附加参数，可选

指定用户的AK。

k

附加参数，可选

指定用户的SK。

t

附加参数，可选

指定用户的securitytoken。

Key

对象名称。

LastModified

对象的最后修改时间。

Size

对象的大小。

单位：字节。

StorageClass

对象的存储类别。

支持的值：

• standard：标准存储，访问时延低、吞吐量高，适用于有大量热点文件（平均一个月多次）或小文件（小于1MB）。
• warm：低频访问存储，，可用性略低于standard，适用于不频繁访问（平均一年少于12次）但在需要时也要求快速访问数据的业务场景。
• cold：归档存储，，安全、持久且成本极低，适用于很少访问（平均一年访问一次）数据的业务场景。存储类别为cold的对象，必须先恢复该对象再修改其存储类别，否则无法修改成功。
• deep-archive：深度归档存储，适用于长期不访问（平均几年访问一次）数据的业务场景，其成本相比归档存储更低，但相应的数据恢复时间将更长，一般为数小时。

MD5

对象真实的MD5值。用来确保数据的完整性和验证数据的完整性。

仅当使用cp命令并且配置了-vmd5选项上传对象后，才能查询到该值。

ETag

服务端计算的对象ETag值。

ContentType

对象的文件类型。文件类型决定了浏览器将以什么形式、什么编码读取文件。

常见的ContentType类型，请参见Content-Type介绍。

Type

文件的类型。

Metadata

对象的自定义元数据。对象有自定义元数据后，才能查询到该值。

关于对象的自定义元数据，请参见自定义元数据。