本文介绍对象存储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下指定的图片样式。 |
|
归档直读(ArchiveDirectRead) |
PutArchiveDirectRead |
开启或关闭归档直读。 |
GetArchiveDirectRead |
查看是否已开启归档直读。 |
|
安全传输层协议(TLS) |
PutBucketHttpsConfig |
为Bucket开启或关闭TLS版本设置。 |
GetBucketHttpsConfig |
查看Bucket的TLS版本设置。 |
|
接入点(AccessPoint) |
CreateAccessPoint |
创建接入点。 |
GetAccessPoint |
获取接入点信息。 |
|
DeleteAccessPoint |
删除接入点。 |
|
ListAccessPoints |
获取用户级别或Bucket级别的接入点信息。 |
|
PutAccessPointPolicy |
配置接入点策略。 |
|
GetAccessPointPolicy |
获取接入点策略配置。 |
|
DeleteAccessPointPolicy |
删除接入点策略。 |
|
对象FC接入点(Object FC AccessPoint) |
CreateAccessPointForObjectProcess |
创建对象FC接入点。 |
GetAccessPointForObjectProcess |
获取对象FC接入点基础信息。 |
|
DeleteAccessPointForObjectProcess |
删除对象FC接入点。 |
|
ListAccessPointsForObjectProcess |
获取用户级别的对象FC接入点信息。 |
|
PutAccessPointConfigForObjectProcess |
修改对象FC接入点配置。 |
|
GetAccessPointConfigForObjectProcess |
获取对象FC接入点配置信息。 |
|
PutAccessPointPolicyForObjectProcess |
为对象FC接入点配置权限策略。 |
|
GetAccessPointPolicyForObjectProcess |
获取对象FC接入点的权限策略配置。 |
|
DeleteAccessPointPolicyForObjectProcess |
删除对象FC接入点的权限策略。 |
|
WriteGetObjectResponse |
自定义返回数据和响应标头。 |
关于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个数。 |
|
分片上传(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。 |
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/159159.html