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

关于Service操作

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

关于Bucket操作

分类 API 描述
基础操作 PutBucket 创建Bucket。
DeleteBucket 删除Bucket。
GetBucket(ListObject) 列出Bucket中所有文件(Object)的信息。
GetBucketV2 (ListObjectsV2)
GetBucketInfo 获取Bucket信息。
GetBucketLocation 获得Bucket所属的位置信息。
合规保留策略(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的版本控制状态。
GetBucketVersions(ListObjectVersions) 列举Bucket中所有Object的版本信息。
跨区域复制(Replication) PutBucketReplication 设置Bucket的跨区域复制规则。
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等信息,以决定是否发送真正的请求。

关于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 解冻归档类型(Archive)或冷归档(Cold Archive)的文件(Object)。
SelectObject 对目标文件执行SQL语句,返回执行结果。
分片上传(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。