对象存储_API文档

对象存储 - OpenAPI 概览2019-05-17
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
服务
OpenAPI 名称描述操作
ListBucketshot列举请求者拥有的所有存储空间(Bucket)查看文档去调试
地域
OpenAPI 名称描述操作
DescribeRegionshot查询所有支持地域或者指定地域对应的Endpoint信息,包括外网Endpoint、内网Endpoint和传输加速Endpoint查看文档去调试
存储空间
OpenAPI 名称描述操作
基础操作
PutBuckethot创建一个存储空间(Bucket)查看文档去调试
GetBucketStathot获取指定存储空间的存储容量以及文件数量查看文档去调试
ListObjectshot列举存储空间(Bucket)中所有文件(Object)的信息查看文档去调试
ListObjectsV2hot列举存储空间(Bucket)中所有文件(Object)的信息查看文档去调试
GetBucketInfohot查看存储空间(Bucket)的相关信息。只有Bucket的拥有者才能查看Bucket的信息。该请求可以从任何一个OSS的Endpoint发起查看文档去调试
GetBucketLocation查看存储空间(Bucket)的位置信息。只有Bucket的拥有者才能查看Bucket的位置信息查看文档去调试
DeleteBucket删除存储空间(Bucket)查看文档去调试
接入点
PutAccessPointPolicy配置接入点策略查看文档去调试
CreateAccessPoint创建接入点查看文档去调试
ListAccessPoints获取用户级别或Bucket级别的接入点信息查看文档去调试
GetAccessPoint获取接入点信息查看文档去调试
GetAccessPointPolicy获取接入点策略配置查看文档去调试
DeleteAccessPointPolicy删除接入点策略查看文档去调试
DeleteAccessPoint删除接入点查看文档去调试
合规保留策略
InitiateBucketWorm新建一条合规保留策略查看文档去调试
GetBucketWorm获取指定存储空间(Bucket)的合规保留策略信息查看文档去调试
AbortBucketWorm删除指定存储空间(Bucket)未锁定的合规保留策略查看文档去调试
CompleteBucketWorm锁定合规保留策略查看文档去调试
ExtendBucketWorm延长已锁定的合规保留策略对应Bucket中Object的保留天数查看文档去调试
权限控制
GetBucketAcl获取某个存储空间(Bucket)的访问权限(ACL)。只有Bucket的拥有者才能获取Bucket的访问权限查看文档去调试
PutBucketAcl设置或修改存储空间(Bucket)的访问权限(ACL)查看文档去调试
生命周期
GetBucketLifecycle查看存储空间(Bucket)的生命周期规则(Lifecycle)。只有Bucket的拥有者才有权限查看Bucket的生命周期规则查看文档去调试
PutBucketLifecycle设置存储空间的生命周期规则查看文档去调试
DeleteBucketLifecycle删除指定存储空间(Bucket)的生命周期规则查看文档去调试
传输加速
GetBucketTransferAcceleration获取目标存储空间(Bucket)的传输加速配置查看文档去调试
PutBucketTransferAcceleration为存储空间(Bucket)配置传输加速。开启传输加速后,可提升全球各地用户对OSS的访问速度,适用于远距离数据传输、GB或TB级大文件上传和下载的场景查看文档去调试
版本控制
GetBucketVersioning获取指定Bucket的版本控制状态查看文档去调试
ListObjectVersions列出Bucket中包括删除标记(Delete Marker)在内的所有Object的版本信息查看文档去调试
PutBucketVersioning设置指定存储空间(Bucket)的版本控制状态查看文档去调试
授权策略
GetBucketPolicy获取指定存储空间(Bucket)的权限策略(Policy)查看文档去调试
GetBucketPolicyStatus查看当前Bucket Policy是否允许公共访问查看文档去调试
PutBucketPolicy为指定的存储空间(Bucket)设置授权策略(Policy)查看文档去调试
DeleteBucketPolicy删除指定存储空间(Bucket)的权限策略(Policy)查看文档去调试
数据复制
GetBucketReplication获取某个存储空间(Bucket)已设置的数据复制规则查看文档去调试
GetBucketReplicationLocation获取可复制到的目标存储空间(Bucket)所在的地域。您可以根据返回结果决定将源Bucket的数据复制到哪个地域查看文档去调试
GetBucketReplicationProgress获取某个存储空间(Bucket)的数据复制进度查看文档去调试
PutBucketRtc为已有的跨区域复制规则开启或关闭数据复制时间控制(RTC)功能查看文档去调试
PutBucketReplication为存储空间(Bucket)指定数据复制规则。OSS支持跨区域复制(Cross-Region Replication)和同区域复制(Same-Region Replication)查看文档去调试
DeleteBucketReplication停止某个存储空间(Bucket)的数据复制并删除Bucket的复制配置,此时源Bucket中的任何操作都不会被同步到目标Bucket查看文档去调试
清单
GetBucketInventory查看某个存储空间(Bucket)中指定的清单(Inventory)任务查看文档去调试
ListBucketInventory批量获取某个存储空间(Bucket)中的所有清单(Inventory)任务查看文档去调试
PutBucketInventory为指定存储空间(Bucket)配置清单(Inventory)规则查看文档去调试
DeleteBucketInventory删除某个存储空间(Bucket)中指定的清单(Inventory)任务查看文档去调试
日志管理
GetBucketLogging查看存储空间(Bucket)的访问日志配置。只有Bucket的拥有者才能查看Bucket的访问日志配置查看文档去调试
GetUserDefinedLogFieldsConfig获取存储空间(Bucket)实时日志中user_defined_log_fields字段的个性化配置查看文档去调试
PutBucketLogging为存储空间(Bucket)开启日志转存功能,可将OSS的访问日志按照固定命名规则,以小时为单位生成日志文件写入您指定的Bucket查看文档去调试
PutUserDefinedLogFieldsConfig为存储空间(Bucket)实时日志中的user_defined_log_fields字段进行个性化配置。您可以将OSS请求中用户关心的请求头或查询参数信息记录到该字段中去以便后续分析请求查看文档去调试
DeleteBucketLogging关闭存储空间(Bucket)的访问日志记录功能查看文档去调试
DeleteUserDefinedLogFieldsConfig删除存储空间(Bucket)实时日志中user_defined_log_fields字段的个性化配置查看文档去调试
静态网站
GetBucketWebsite查看存储空间(Bucket)的静态网站托管状态以及跳转规则查看文档去调试
PutBucketWebsite将存储空间(Bucket)设置为静态网站托管模式并设置跳转规则(RoutingRule)查看文档去调试
DeleteBucketWebsite关闭存储空间(Bucket)的静态网站托管模式以及跳转规则查看文档去调试
防盗链
GetBucketReferer查看存储空间(Bucket)的防盗链(Referer)相关配置查看文档去调试
PutBucketReferer设置存储空间(Bucket)级别的防盗链(Referer)访问白名单,支持设置是否允许Referer字段为空以及是否允许截断QueryString的请求访问OSS查看文档去调试
标签
GetBucketTags获取存储空间(Bucket)的标签信息查看文档去调试
PutBucketTags给某个存储空间(Bucket)添加或修改标签查看文档去调试
DeleteBucketTags删除存储空间(Bucket)标签查看文档去调试
存储冗余转换
CreateBucketDataRedundancyTransition为Bucket创建存储冗余转换任务查看文档去调试
ListBucketDataRedundancyTransition列举某个Bucket下所有的存储冗余转换任务查看文档去调试
GetBucketDataRedundancyTransition获取存储冗余转换任务查看文档去调试
DeleteBucketDataRedundancyTransition删除存储空间数据冗余类型转换任务查看文档去调试
加密
GetBucketEncryption获取存储空间(Bucket)的加密规则查看文档去调试
PutBucketEncryption配置存储空间(Bucket)的加密规则查看文档去调试
DeleteBucketEncryption删除指定存储空间(Bucket)的加密规则查看文档去调试
请求者付费
GetBucketRequestPayment获取请求者付费模式的配置信息查看文档去调试
PutBucketRequestPayment设置某个存储空间(Bucket)的请求者付费模式查看文档去调试
跨资源共享
GetBucketCors获取指定存储空间(Bucket)当前的跨域资源共享CORS(Cross-Origin Resource Sharing)规则查看文档去调试
OptionObject浏览器在发送跨域请求之前会发送一个preflight请求(Options)给OSS,并带上特定的来源域、HTTP方法和header等信息,以决定是否发送真正的请求查看文档去调试
PutBucketCors设置指定存储空间(Bucket)的跨域资源共享CORS(Cross-Origin Resource Sharing)规则查看文档去调试
DeleteBucketCors关闭指定存储空间(Bucket)的跨域资源共享CORS(Cross-Origin Resource Sharing)功能并清空所有规则查看文档去调试
访问跟踪
GetBucketAccessMonitor获取存储空间(Bucket)的访问追踪功能是否开启查看文档去调试
PutBucketAccessMonitor修改存储空间(Bucket)的访问追踪状态查看文档去调试
数据索引
GetMetaQueryStatus获取指定存储空间(Bucket)的元数据索引库信息查看文档去调试
DoMetaQuery通过存储空间(Bucket)的元数据索引功能,查询满足指定条件的文件(Object),并按照字段和排序方式列出文件信息查看文档去调试
CloseMetaQuery关闭存储空间(Bucket)的元数据管理功能。OSS会自动删除Bucket的元数据索引库,将无法进行元数据索引查看文档去调试
OpenMetaQuery开启元数据管理功能。开启元数据管理功能后,OSS会为Bucket创建元数据索引库并为Bucket中的所有文件(Object)建立元数据索引。元数据索引库创建完成后,OSS会继续对Bucket中新增文件进行准实时的增量追踪扫描并为增量文件建立元数据索引查看文档去调试
高防
InitUserAntiDDosInfo创建高防OSS实例查看文档去调试
InitBucketAntiDDosInfo初始化Bucket防护查看文档去调试
ListBucketAntiDDosInfo获取Bucket防护信息列表查看文档去调试
GetUserAntiDDosInfo查询指定账号下的高防OSS实例信息查看文档去调试
UpdateUserAntiDDosInfo更改高防OSS实例状态查看文档去调试
UpdateBucketAntiDDosInfo更新Bucket防护状态查看文档去调试
资源组
GetBucketResourceGroup获取存储空间(Bucket)所属的资源组ID查看文档去调试
PutBucketResourceGroup修改存储空间(Bucket)所属的资源组ID查看文档去调试
自定义域名
PutCname为某个存储空间(Bucket)绑定自定义域名查看文档去调试
CreateCnameToken创建域名所有权验证所需的CnameToken查看文档去调试
ListCname查询某个存储空间(Bucket)下绑定的所有的自定义域名(Cname)列表查看文档去调试
GetCnameToken获取已创建的CnameToken查看文档去调试
DeleteCname删除某个存储空间(Bucket)已绑定的Cname查看文档去调试
图片样式
PutStyle新增图片样式。一个图片样式中可以包含单个或多个图片处理参数查看文档去调试
ListStyle查询某个Bucket下已创建的所有图片样式查看文档去调试
DeleteStyle删除某个Bucket下指定的图片样式查看文档去调试
GetStyle查询某个Bucket下指定的图片样式信息查看文档去调试
安全传输层协议(TLS)
GetBucketHttpsConfig查看Bucket的TLS版本设置查看文档去调试
PutBucketHttpsConfig为Bucket开启或关闭TLS版本设置查看文档去调试
对象FC接入点
CreateAccessPointForObjectProcess创建对象FC接入点查看文档去调试
GetAccessPointForObjectProcess获取对象FC接入点基础信息查看文档去调试
ListAccessPointsForObjectProcess获取用户级别的对象FC接入点信息查看文档去调试
GetAccessPointConfigForObjectProcess获取对象FC接入点配置信息查看文档去调试
GetAccessPointPolicyForObjectProcess获取对象FC接入点的权限策略配置查看文档去调试
PutAccessPointConfigForObjectProcess修改对象FC接入点的配置查看文档去调试
PutAccessPointPolicyForObjectProcess为对象FC接入点配置权限策略查看文档去调试
DeleteAccessPointForObjectProcess删除对象FC接入点查看文档去调试
DeleteAccessPointPolicyForObjectProcess删除对象FC接入点的权限策略查看文档去调试
阻止公共访问
OSS全局阻止公共访问
GetPublicAccessBlock获取绑定在用户级别的阻止公共访问的配置查看文档去调试
PutPublicAccessBlock修改OSS全局阻止公共访问的配置信息查看文档去调试
DeletePublicAccessBlock删除用户级别的阻止公共访问配置查看文档去调试
Bucket级别阻止公共访问
GetBucketPublicAccessBlock获取存储空间绑定的阻止公共访问配置查看文档去调试
PutBucketPublicAccessBlock获取绑定在存储空间上的阻止公共访问的配置信息查看文档去调试
DeleteBucketPublicAccessBlock删除绑定在存储空间上的组织公共访问配置信息查看文档去调试
接入点级别阻止公共访问
GetAccessPointPublicAccessBlock获取指定接入点的阻止公共访问配置信息查看文档去调试
PutAccessPointPublicAccessBlock修改指定接入点的阻止公共访问的配置信息查看文档去调试
DeleteAccessPointPublicAccessBlock删除指定接入点的阻止公共访问配置信息查看文档去调试
归档直读
GetBucketArchiveDirectRead查看Bucket是否开启归档直读查看文档去调试
PutBucketArchiveDirectRead为Bucket开启或关闭归档直读查看文档去调试
文件
OpenAPI 名称描述操作
基础操作
PutObjecthot上传文件(Object)查看文档去调试
CopyObject拷贝同一地域下相同或不同存储空间(Bucket)之间的文件(Object)查看文档去调试
CreateSelectObjectMeta获取目标文件总的行数,总的列数(对于CSV文件),以及Splits个数。如果该信息不存在,则会扫描整个文件,分析并记录下CSV文件的上述信息。重复调用该API则会保存上述信息而不必重新扫描整个文件查看文档去调试
GetObjecthot获取某个文件(Object)查看文档去调试
HeadObjecthot获取某个文件(Object)的元信息查看文档去调试
GetObjectMeta获取文件(Object)的元数据信息,包括该Object的ETag、Size、LastModified信息,并且不返回该Object的内容查看文档去调试
SelectObject对目标文件执行SQL语句,返回执行结果查看文档去调试
AppendObject以追加写的方式上传文件(Object)查看文档去调试
RestoreObject解冻归档类型(Archive)或冷归档(Cold Archive)的文件(Object)查看文档去调试
DeleteObject删除文件(object)查看文档去调试
CleanRestoredObject清理从冷归档或深度冷归档对象中解冻而来的副本查看文档去调试
分片上传
InitiateMultipartUpload通知OSS初始化一个Multipart Upload事件查看文档去调试
UploadPart根据指定的Object名和uploadId来分块(Part)上传数据查看文档去调试
CompleteMultipartUpload来完成整个文件的分片上传查看文档去调试
UploadPartCopy从一个已存在的Object中拷贝数据来上传一个Part查看文档去调试
ListMultipartUploads列举所有执行中的Multipart Upload事件查看文档去调试
ListParts列举指定Upload ID所属的所有已经上传成功Part查看文档去调试
AbortMultipartUpload用于取消MultipartUpload事件并删除对应的Part数据查看文档去调试
权限控制
GetObjectAcl获取存储空间(Bucket)下某个文件(Object)的访问权限(ACL)查看文档去调试
PutObjectAcl修改文件(Object)的访问权限(ACL)查看文档去调试
软链接
PutSymlink为OSS的目标文件(TargetObject)创建软链接(Symlink)查看文档去调试
GetSymlink获取OSS目标文件(TargetObject)的软链接查看文档去调试
标签
GetObjectTagging获取对象(Object)的标签(Tagging)信息查看文档去调试
PutObjectTagging设置或更新对象(Object)的标签(Tagging)信息查看文档去调试
DeleteObjectTagging删除指定对象(Object)的标签(Tagging)信息查看文档去调试
直播推流
OpenAPI 名称描述操作
PutLiveChannel通过RTMP协议上传音视频数据前,必须先创建一个LiveChannel查看文档去调试
PostVodPlaylist为指定的LiveChannel生成一个点播用的播放列表查看文档去调试
ListLiveChannel列举指定的LiveChannel查看文档去调试
GetLiveChannelInfo获取指定LiveChannel的配置信息查看文档去调试
GetLiveChannelHistory获取指定LiveChannel的推流记录查看文档去调试
GetLiveChannelStat获取指定LiveChannel的推流状态信息查看文档去调试
GetVodPlaylist查看指定LiveChannel在指定时间段内推流生成的播放列表查看文档去调试
PutLiveChannelStatus切换LiveChannel启用(enabled)和禁用(disabled)两种状态查看文档去调试
DeleteLiveChannel删除指定的LiveChannel查看文档去调试
其他
OpenAPI 名称描述操作
PutChannel创建图片处理通道查看文档去调试
PutBucketHash修改存储空间哈希算法配置查看文档去调试
PutBucketCommonHeader设置存储空间的用户自定义响应头配置查看文档去调试
DeleteBucketCommonHeader删除存储空间的用户自定义响应头配置查看文档去调试
PutProcessConfiguration修改存储空间媒体处理配置查看文档去调试
GetBucketEventNotification获取存储空间事件通知配置查看文档去调试