网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

API概览

更新时间:2025-01-26 GMT+08:00
分享

桶基础操作接口

表1 桶基础操作接口

接口

说明

获取桶列表

查询自己创建的桶列表。

创建桶

创建一个新桶。可以在创建时添加不同的请求消息头来指定桶的区域、权限控制策略、存储类型等信息。

列举桶内对象

获取桶内对象列表。可以在创建时添加不同的请求消息头来获取符合指定前缀、标识符等要求的对象。

获取桶元数据

查询桶元数据是否存在。可以查询桶的区域、存储类型、OBS服务版本号、企业项目id、CORS配置等信息。

获取桶区域位置

获取桶区域位置信息。

删除桶

删除指定的桶。删除之前需要确保桶内无对象。

桶高级配置接口

表2 桶高级配置接口

接口

说明

设置桶策略

创建或者修改一个桶的策略。如果桶已经存在一个策略,那么当前请求中的策略将完全覆盖桶中现存的策略。

获取桶策略

获取指定桶的策略信息。

删除桶策略

删除一个指定桶上的策略。

设置桶ACL

设置一个指定桶的ACL信息。通过ACL可以控制桶的读写权限。

获取桶ACL

获取一个指定桶的ACL信息。

设置桶日志管理配置

开启或关闭桶的日志管理功能。开启后,桶的每次操作将会产生一条日志,并将多条日志打包成一个日志文件存放在指定的位置。

获取桶日志管理配置

获取指定桶的日志管理配置信息。

设置桶的生命周期配置

指定规则来实现定时删除或迁移桶中对象。

获取桶的生命周期配置

获取指定桶已配置的生命周期规则。

删除桶的生命周期配置

删除指定桶的生命周期配置信息。

设置桶的多版本状态

开启或暂停桶的多版本功能。开启后,可以检索和还原各个版本的对象,在意外操作或应用程序故障时快速恢复数据。

获取桶的多版本状态

获取指定桶的多版本功能状态。

设置桶默认存储类型

创建或更新桶的默认存储类型配置信息。

获取桶默认存储类型

获取桶的默认存储类型配置信息。

设置桶的跨区域复制配置

设置桶的跨区域复制功能。通过激活跨区域复制,OBS可将新创建的对象及修改的对象从一个源桶复制到不同区域中的目标桶。

获取桶的跨区域复制配置

获取指定桶的跨区域复制配置信息。

删除桶的跨区域复制配置

删除指定桶的跨区域复制配置信息。

设置桶标签

添加标签至一个已存在的桶。为桶添加标签后,该桶上所有请求产生的计费话单里都会带上这些标签,从而可以针对话单报表做分类筛选,进行更详细的成本分析。

获取桶标签

获取指定桶的标签。

删除桶标签

删除指定桶的标签。

设置桶配额

设置桶的空间配额,用以限制桶的最大存储容量。

获取桶配额

获取桶的空间配额。

获取桶存量信息

获取桶中的对象个数及对象占用空间。

设置桶清单

为一个桶配置清单规则。桶清单可以用来帮助您管理桶内对象,它可以定期列举桶内对象,并将对象元数据的相关信息保存在CSV格式的文件中,上传到您指定的桶中。

获取桶清单

获取指定桶的某个清单规则。

列举桶清单

获取指定桶的所有清单规则。

删除桶清单

删除指定桶的某个清单规则。

设置桶的自定义域名

为桶设置自定义域名。设置成功之后,用户可以通过桶的自定义域名访问桶。

获取桶的自定义域名

查询桶已设置的自定义域名。

删除桶的自定义域名

删除桶已设置的自定义域名。

设置桶的加密配置

为桶创建或更新默认服务端加密配置信息。设置桶加密配置后,在该桶中上传对象时,会采用桶的默认加密配置对数据进行加密。

获取桶的加密配置

查询桶的默认服务端加密配置信息。

删除桶的加密配置

删除桶的默认服务端加密配置信息。

设置桶归档存储对象直读策略

开启或关闭桶的归档存储对象直读功能。开启后,归档存储对象不需要恢复便可以直接下载。

获取桶归档存储对象直读策略

获取指定桶的归档存储对象直读状态。

删除桶归档存储对象直读策略

删除指定桶的归档存储对象直读配置信息。

设置镜像回源规则

设置指定桶的镜像回源规则。

获取镜像回源规则

获取指定桶的镜像回源规则。

删除镜像回源规则

删除指定桶的镜像回源规则。

设置DIS通知策略

设置指定桶的DIS通知策略。

获取DIS通知策略

获取指定桶的DIS通知策略。

删除DIS通知策略

删除指定桶的DIS通知策略。

设置在线解压策略

设置指定桶的ZIP文件解压规则。

获取在线解压策略

获取指定桶的ZIP文件解压规则。

删除在线解压策略

删除指定桶的ZIP文件解压规则。

配置桶级默认WORM策略

桶的WORM开关开启后,支持配置默认保护策略和保护期限。

获取桶级默认WORM策略

获取指定桶设置的桶级默认WORM策略。

静态网站托管接口

表3 静态网站托管接口

接口

说明

设置桶的网站配置

创建或更新桶的网站配置信息。OBS允许在桶内保存静态的网页资源,如.html网页文件、flash文件、音视频文件等,当客户端通过桶的Website接入点访问这些对象资源时,浏览器可以直接解析出这些支持的网页资源,呈现给最终用户。

获取桶的网站配置

获取桶的网站配置信息。

删除桶的网站配置

删除桶的网站配置信息。

设置桶的CORS配置

设置桶的跨域资源共享配置信息。OBS允许在桶内保存静态的网页资源,在正确的使用下,OBS的桶可以成为网站资源。只有进行了适当的CORS配置,OBS中的网站才能响应另一个网站的跨域请求。

获取桶的CORS配置

获取桶的跨域资源共享配置信息。

删除桶的CORS配置

删除桶的跨域资源共享配置信息。

OPTIONS桶

检测客户端是否具有对服务端进行操作的权限。通常用于跨域访问之前。

OPTIONS对象

检测客户端是否具有对服务端进行操作的权限。通常用于跨域访问之前。

对象操作接口

表4 对象操作接口

接口

说明

PUT上传

上传简单对象到指定的桶。

POST上传

基于表单上传对象到指定的桶。

复制对象

为OBS上已经存在的对象创建一个副本。

下载对象

下载对象。

获取对象元数据

获取对象的元数据信息。包括对象的过期时间、版本号、CORS配置等信息。

删除对象

删除指定的对象。也可以携带versionId删除指定版本的对象。

批量删除对象

将一个桶内的一部分对象一次性删除,删除后不可恢复。

恢复归档存储或深度归档存储对象

归档存储和深度归档(受限公测)存储对象的内容恢复,恢复后才能下载。

追加写对象

在指定桶内的一个对象尾追加上传数据,不存在相同对象键值的对象则创建新对象。

设置对象ACL

设置一个指定对象的ACL信息。通过ACL可以控制对象的读写权限。

获取对象ACL

获取一个指定对象的ACL信息。

修改对象元数据

添加、修改或删除桶中已经上传的对象的元数据。

修改写对象

将指定并行文件系统内的一个对象从指定位置起修改为其他内容。

截断对象

将指定并行文件系统内的一个对象截断到指定大小。

重命名对象

将指定并行文件系统内的一个对象重命名为其他对象名。

回调

用户可以在上传对象请求中设置回调参数,OBS在对象上传成功之后,将上传结果回调特定服务器,并将回调结果返回给用户。

设置对象标签

设置一个指定对象的标签信息

获取对象标签

获取一个指定对象的标签信息

删除对象标签

删除一个指定对象的标签信息

配置对象级WORM保护策略

开启了WORM开关的桶,上传的对象支持配置或修改对象保护期限。

多段操作接口

表5 多段操作接口

接口

说明

列举桶中已初始化多段任务

查询一个桶中所有的初始化后还未合并以及未取消的多段上传任务。

初始化上传段任务

使用多段上传特性时,必须首先调用此接口初始化上传段任务,获取全局唯一的多段上传任务号,用于后续的上传段、合并段、列举段等操作。

上传段

为特定的任务上传段。

拷贝段

将已上传对象的一部分或全部拷贝为段。

列举已上传未合并的段

查询一个任务所属的所有段信息。

合并段

将指定的段合并成一个完整的对象。

取消多段上传任务

取消一个多段上传的任务。

Data+接口

表6 Data+接口

接口

说明

创建工作流

本接口用于直接创建Data+工作流。

查询工作流详情

本接口用于根据工作流名称查询工作流详细信息。

删除工作流

本接口用于标记删除工作流。

更新工作流

本接口用于更新工作流参数值。

查询工作流列表

本接口用于查询工作流列表。

API异步启动工作流

本接口用于API方式异步启动已有工作流,产生工作流实例。

查询工作流实例列表

本接口用于查询用户工作流的实例列表。

查询工作流实例

本接口用于查询指定工作流实例详细。

恢复失败状态的工作流实例

本接口用于恢复一个执行失败状态的工作流实例。恢复后,工作流实例将从上次失败的状态处继续执行,而工作流步骤中已经执行成功的状态不会再执行。

开通授权

本接口用于开通授权,由OBS服务自动帮助用户创建工作流运行时需要的函数服务权限,以及函数服务运行时的权限。

查询授权

本接口用于查询授权,查询由OBS服务自动帮助用户创建工作流运行时需要的函数服务权限,以及函数服务运行时的权限。

查询华为云算子模板详情

本接口用于按名称查询Action模板。

查询华为云算子模板列表

本接口用于查询已有预置Action模板列表。

配置桶触发器

本接口用于在桶上绑定工作流触发器。

查询桶触发器

本接口用于查询桶上绑定工作流触发器。

删除桶触发器

本接口用于删除在桶上绑定工作流触发器。

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容