本文介绍对象存储OSS提供的相关API接口及其各API接口的用法。

关于Service操作

API描述
ListBuckets(GetService)返回请求者拥有的所有存储空间(Bucket)。

关于Region操作

API描述
DescribeRegions查询所有支持地域或者指定地域对应的Endpoint信息。

关于Bucket操作

分类API描述
基础操作PutBucket创建Bucket。
DeleteBucket删除Bucket。
ListObjects(GetBucket)列出Bucket中所有文件(Object)的信息。
ListObjectsV2(GetBucketV2)
GetBucketInfo获取Bucket信息。
GetBucketLocation获取Bucket所属的位置信息。
GetBucketStat获取Bucket的存储容量以及Object数量。
合规保留策略(WORM)InitiateBucketWorm新建合规保留策略。
AbortBucketWorm删除未锁定的合规保留策略。
CompleteBucketWorm锁定合规保留策略。
ExtendBucketWorm延长已锁定的合规保留策略对应Bucket中Object的保留天数。
GetBucketWorm获取Bucket的合规保留策略信息。
权限控制(ACL)PutBucketAcl设置Bucket访问权限。
GetBucketAcl获取Bucket访问权限。
生命周期(Lifecycle)PutBucketLifecycle设置Bucket中Object的生命周期规则。
GetBucketLifecycle获取Bucket中Object的生命周期规则。
DeleteBucketLifecycle删除Bucket中Object的生命周期规则。
传输加速(TransferAcceleration)PutBucketTransferAcceleration为存储空间(Bucket)配置传输加速。
GetBucketTransferAcceleration获取目标存储空间(Bucket)的传输加速配置。
版本控制(Versioning)PutBucketVersioning设置Bucket的版本控制状态。
GetBucketVersioning获取Bucket的版本控制状态。
ListObjectVersions(GetBucketVersions)列举Bucket中所有Object的版本信息。
数据复制(Replication)PutBucketReplication设置Bucket的数据复制规则。
PutBucketRTC 为已有的跨区域复制规则开启或关闭数据复制时间控制(RTC)功能。
GetBucketReplication查看Bucket已设置的数据复制规则。
GetBucketReplicationLocation查看可复制到的目标Bucket所在的地域。
GetBucketReplicationProgress查看Bucket的数据复制进度。
DeleteBucketReplication停止Bucket的数据复制任务并删除Bucket的复制配置。
授权策略(Policy)PutBucketPolicy设置Bucket Policy。
GetBucketPolicy获取Bucket Policy。
DeleteBucketPolicy删除Bucket Policy。
清单(Inventory)PutBucketInventory设置Bucket清单规则。
GetBucketInventory查看Bucket中指定的清单任务。
ListBucketInventory查看Bucket中所有的清单任务。
DeleteBucketInventory删除Bucket中指定的清单任务。
日志管理(Logging)PutBucketLogging开启Bucket访问日志记录功能。
GetBucketLogging查看Bucket的访问日志配置情况。
DeleteBucketLogging关闭Bucket访问日志记录功能。
静态网站(Website)PutBucketWebsite设置Bucket为静态网站托管模式。
GetBucketWebsite查看Bucket的静态网站托管状态。
DeleteBucketWebsite关闭Bucket的静态网站托管模式。
防盗链(Referer)PutBucketReferer设置Bucket的防盗链规则。
GetBucketReferer查看Bucket的防盗链规则。
标签(Tags)PutBucketTags添加或修改Bucket标签。
GetBucketTags查看Bucket标签信息。
DeleteBucketTags删除Bucket标签。
加密(Encryption)PutBucketEncryption配置Bucket的加密规则。
GetBucketEncryption获取Bucket的加密规则。
DeleteBucketEncryption删除Bucket的加密规则。
请求者付费(RequestPayment)PutBucketRequestPayment设置Bucket为请求者付费模式。
GetBucketRequestPayment查看Bucket请求者付费模式配置信息。
跨域资源共享(CORS)PutBucketCors为指定的存储空间(Bucket)设置跨域资源共享CORS(Cross-Origin Resource Sharing)规则。
GetBucketCors获取指定存储空间(Bucket)当前的跨域资源共享CORS规则。
DeleteBucketCors关闭指定存储空间(Bucket)对应的跨域资源共享CORS功能并清空所有规则。
Options浏览器在发送跨域请求之前会发送一个preflight请求(Options)给OSS,并带上特定的来源域、HTTP方法和header等信息,以决定是否发送真正的请求。
访问追踪(AccessMonitor)PutBucketAccessMonitor配置Bucket的访问追踪状态。
GetBucketAccessMonitor获取Bucket的访问追踪状态。
数据索引(Data Indexing)OpenMetaQuery为Bucket开启元数据管理功能。
GetMetaQueryStatus获取指定Bucket的元数据索引库信息。
DoMetaQuery查询满足指定条件的Object,并按照指定字段和排序方式列出Object信息。
CloseMetaQuery关闭Bucket的元数据管理功能。
高防(DDoS Protection)InitUserAntiDDosInfo创建高防OSS实例。
UpdateUserAntiDDosInfo更改高防OSS实例状态。
GetUserAntiDDosInfo查询指定账号下的高防OSS实例信息。
InitBucketAntiDDosInfo初始化Bucket防护。
UpdateBucketAntiDDosInfo更新Bucket防护状态。
ListBucketAntiDDosInfo获取Bucket防护信息列表。
资源组PutBucketResourceGroup为Bucket配置所属资源组。
GetBucketResourceGroup获取Bucket的资源组ID。
自定义域名(CNAME)CreateCnameToken创建域名所有权验证所需的CnameToken。
GetCnameToken获取已创建的CnameToken。
PutCname为某个Bucket绑定Cname。
ListCname获取某个Bucket下绑定的所有Cname列表。
DeleteCname删除已绑定的Cname。
图片样式(Style)PutStyle新增图片样式。
GetStyle获取某个Bucket下指定的图片样式信息。
ListStyle获取某个Bucket下已创建的所有图片样式。
DeleteStyle删除某个Bucket下指定的图片样式。

关于Object的操作

分类APi描述
基础操作PutObject上传Object。
GetObject获取Object。
CopyObject拷贝Object。
AppendObject以追加写的方式上传Object。
DeleteObject删除单个Object。
DeleteMultipleObjects删除多个Object。
HeadObject只返回某个Object的meta信息,不返回文件内容。
GetObjectMeta返回Object的基本meta信息,包括该Object的ETag、Size(文件大小)以及LastModified等,不返回文件内容。
PostObject通过HTML表单上传的方式上传Object。
Callback您只需在发送给OSS的请求中携带相应的Callback参数即能实现回调。
RestoreObject解冻归档存储、冷归档存储类型的Object。
SelectObject对目标文件执行SQL语句,返回执行结果。
CreateSelectObjectMeta获取目标文件总行数,总列数(对于CSV文件),以及Splits个数。
目录管理CreateDirectory创建目录(Directory)。
Rename重命名目录(Directory)或者文件(Object)。
DeleteDirectory删除目录。
分片上传(MultipartUpload)InitiateMultipartUpload初始化一个Multipart Upload事件。
UploadPart根据指定的Object名和uploadId来分块(Part)上传数据。
UploadPartCopy通过在UploadPart请求的基础上增加一个请求头x-oss-copy-source来调用UploadPartCopy接口,实现从一个已存在的Object中拷贝数据来上传一个Part。
CompleteMultipartUpload在将所有数据Part都上传完成后,您必须调用CompleteMultipartUpload接口来完成整个文件的分片上传。
AbortMultipartUpload取消Multipart Upload事件并删除对应的Part数据。
ListMultipartUploads列举所有执行中的Multipart Upload事件,即已经初始化但还未完成(Complete)或者还未中止(Abort)的Multipart Upload事件。
ListParts列举指定uploadId所属的所有已经上传成功Part。
权限控制(ACL)PutObjectACL修改Object的访问权限。
GetObjectACL查看Object的访问权限。
软链接(Symlink)PutSymlink创建软链接。
GetSymlink获取软链接。
标签(Tagging)PutObjectTagging设置或更新对象标签。
GetObjectTagging获取对象标签信息。
DeleteObjectTagging删除指定的对象标签。

关于Live Channel的操作

API描述
PutLiveChannelStatus切换LiveChannel的状态。
PutLiveChannel创建LiveChannel。
GetVodPlaylist获取播放列表。
PostVodPlaylist生成播放列表。
GetLiveChannelStat获取LiveChannel的推流状态信息。
GetLiveChannelInfo获取LiveChannel的配置信息。
GetLiveChannelHistory获取LiveChannel的推流记录。
ListLiveChannel列举LiveChannel。
DeleteLiveChannel删除LiveChannel。