# OBS PHP SDK


## API参考

- [简介](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0001.md): 本文档提供了对象存储服务OBS（Object Storage Service） PHP SDK所有接口的描述、方法定义及参数说明等内容。如果您想了解OBS PHP SDK的端到端使用方法（如安装、初始化、开发、常见问题），以及各接口的具体使用场景，各场景的代码样例等更丰富的信息，请参考《对象存储服务PHP SDK开发指南》 。开发过程中，
- [ObsClient初始化](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0101.md): ObsClient是访问OBS服务的PHP客户端，它为调用者提供一系列与OBS服务进行交互的接口，用于管理、操作桶（Bucket）和对象（Object）等OBS服务上的资源。
- [日志初始化](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0102.md): 通过开启SDK日志功能，可将接口调用过程中产生的日志信息记录到日志文件，用于后续的数据分析或问题定位。
- [请求数组](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0103.md): 调用ObsClient的相关接口均需要传入请求数组（associative array类型）作为输入。对于桶操作接口，请求数组中固定包含Bucket用于指定桶名（ObsClient->listBuckets除外）；对于对象操作接口，请求数组中固定包含Bucket和Key分别用于指定桶名与对象名。
- [SDK公共结果对象](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0104.md): 调用ObsClient的相关接口完成后，没有异常抛出，则会返回SDK公共结果对象，表明操作成功；若抛出异常，则表明操作失败，此时应从SDK自定义异常实例中获取错误信息。
- [SDK自定义异常](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0105.md): SDK自定义异常是由ObsClient统一抛出的异常，继承自\RuntimeException类。通常是OBS服务端错误，包含OBS错误码、错误信息等，便于用户定位问题，并做出适当的处理。
- [异步调用](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0106.md): 桶相关接口和对象相关接口均支持以“Async”结尾的方式进行异步调用（例如，同步方法为ObsClient->putObject，则异步方法为ObsClient->putObjectAsync）。异步调用完成后会将返回结果输出到回调函数中，回调函数依次包含SDK自定义异常和SDK公共结果对象两个参数，如果回调函数中SDK自定义异常参数不为空
- [权限类型](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0201.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [可被授权的用户组](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0202.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [可被授权用户类型](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0203.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [预定义访问策略](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0204.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [存储类型](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0205.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [恢复选项](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0206.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [元数据复制策略](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0208.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [创建桶](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0301.md): 按照用户指定的桶名创建一个新桶。新创建桶的桶名在OBS中必须是唯一的。除同一个用户重复创建同一区域的同名桶外，其他场景重复创建同名桶均会失败。一个用户可以拥有的桶的数量不能超过100个。
- [获取桶列表](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0302.md): 查询桶列表，返回结果按照桶名字典顺序排列。
- [判断桶是否存在](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0303.md): 判断桶是否存在，抛出异常中HTTP状态码为200表明桶存在，否则返回404表明桶不存在。
- [删除桶](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0304.md): 删除桶，待删除的桶必须为空（不包含对象、历史版本对象或分段上传碎片）。
- [列举桶内对象](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0305.md): 列举桶内对象，默认返回最大1000个对象。
- [列举桶内多版本对象](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0306.md): 列举桶内多版本对象，默认返回最大1000个多版本对象。
- [列举桶内分段上传任务](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0307.md): 列举指定桶中所有的初始化后还未合并或还未取消的分段上传任务。
- [获取桶元数据](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0308.md): 对桶发送HEAD请求，获取桶的存储类型，CORS规则（若已设置）等信息。
- [获取桶区域位置](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0309.md): 获取桶所在的区域位置。
- [获取桶存量信息](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0310.md): 获取桶的存量信息，包含桶的空间大小以及对象个数。
- [设置桶配额](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0311.md): 设置桶的配额值，单位为字节，支持的最大值为263-1，配额值设为0表示桶的配额没有上限。
- [获取桶配额](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0312.md): 获取桶的配额值，0代表配额没有上限。
- [设置桶存储类型](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0313.md): 设置桶的存储类型，桶中对象的存储类型默认将与桶的存储类型保持一致。
- [获取桶存储类型](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0314.md): 获取桶的存储类型。
- [设置桶ACL](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0315.md): 设置桶的访问权限。Owner和Grants必须配套使用，且与ACL互斥。当设置了这两个字段时，不能设置ACL；反之，当设置了ACL时，不能设置Owner和Grants。Owner、Grants与ACL不能全为空。
- [获取桶ACL](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0316.md): 获取桶的访问权限。
- [设置桶日志管理配置](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0317.md): 设置桶的访问日志配置。
- [获取桶日志管理配置](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0318.md): 获取桶的访问日志配置。
- [设置桶策略](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0319.md): 配置桶的策略，如果桶已经存在一个策略，那么当前请求中的策略将完全覆盖桶中现存的策略。Policy中的Resource字段包含的桶名必须和当前设置桶策略的桶名一致。
- [获取桶策略](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0320.md): 获取桶的策略。
- [删除桶策略](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0321.md): 删除桶的策略。
- [设置桶的生命周期配置](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0322.md): 配置桶的生命周期规则，实现定时删除桶中对象的功能。Transitions、Expiration、NoncurrentVersionTransitions、NoncurrentVersionExpiration不能全为空。
- [获取桶的生命周期配置](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0323.md): 获取桶的生命周期规则。
- [删除桶的生命周期配置](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0324.md): 删除桶所有的生命周期规则。
- [设置桶的Website配置](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0325.md): 设置桶的Website配置。ErrorDocument，IndexDocument和RoutingRules必须配套使用，且与RedirectAllRequestsTo互斥。当设置了这三个字段时，不能设置RedirectAllRequestsTo；反之，当设置了RedirectAllRequestsTo时，不能设置ErrorDocumen
- [获取桶的Website配置](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0326.md): 获取桶的Website配置。
- [删除桶的Website配置](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0327.md): 删除指定桶的Website配置。
- [设置桶的多版本状态](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0328.md): 设置桶的多版本状态。
- [获取桶的多版本状态](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0329.md): 获取桶的多版本状态。
- [设置桶的CORS配置](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0330.md): 设置桶的跨域资源共享规则，以允许客户端浏览器进行跨域请求。
- [获取桶的CORS配置](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0331.md): 获取指定桶的跨域资源共享规则。
- [删除桶的CORS配置](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0332.md): 删除指定桶的跨域资源共享规则。
- [设置桶标签](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0335.md): 设置桶的标签。
- [获取桶标签](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0336.md): 获取指定桶的标签。
- [删除桶标签](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0337.md): 删除指定桶的标签。
- [上传对象](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0401.md): 上传单个对象到指定桶中。Body与SourceFile不能同时使用。当Body与SourceFile都为空时，上传对象的大小为0字节。
- [下载对象](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0402.md): 下载指定桶中的对象。当SaveAsStream为true时不能与SaveAsFile或FilePath一起使用。SaveAsFile与FilePath不能一起使用。如果包含IfUnmodifiedSince并且不符合或者包含IfMatch并且不符合，抛出异常中HTTP状态码为：412 precondition failed。如果包含IfM
- [复制对象](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0403.md): 为指定桶中的对象创建一个副本。如果包含CopySourceIfUnmodifiedSince并且不符合，或者包含CopySourceIfMatch并且不符合，或者包含CopySourceIfModifiedSince并且不符合，或者包含CopySourceIfNoneMatch并且不符合，抛出异常中HTTP状态码为：412 precond
- [删除对象](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0404.md): 删除指定桶中的对象。
- [批量删除对象](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0405.md): 批量删除指定桶中的多个对象。
- [获取对象元数据](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0406.md): 对指定桶中的对象发送HEAD请求，获取对象的元数据信息。
- [设置对象ACL](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0407.md): 设置指定桶中对象的访问权限。Owner和Grants必须配套使用，且与ACL互斥。当设置了这两个字段时，不能设置ACL；反之，当设置了ACL时，不能设置Owner和Grants。Owner、Grants与ACL不能全为空。
- [获取对象ACL](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0408.md): 获取指定桶中对象的访问权限。
- [初始化分传段任务](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0409.md): 在指定桶中初始化分段上传任务。
- [上传段](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0410.md): 初始化分段上传任务后，通过分段上传任务的ID，上传段到指定桶中。除了最后一段以外，其他段的大小范围是100KB~5GB；最后一段的大小范围是0~5GB。上传的段号也有范围限制，其范围是1~10000。Body与SourceFile不能同时使用。当Body与SourceFile都为空时，上传对象的大小为0字节。Offset、PartSize
- [复制段](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0411.md): 初始化分段上传任务后，通过分段上传任务的ID，复制段到指定桶中。
- [列举已上传的段](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0412.md): 通过分段上传任务的ID，列举指定桶中已上传的段。
- [合并段](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0413.md): 通过分段上传任务的ID，合并指定桶中已上传的段。
- [取消分段上传任务](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0414.md): 通过分段上传任务的ID，取消指定桶中的分段上传任务。
- [恢复归档存储对象](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0415.md): 恢复指定桶中的归档存储对象。
- [设置对象标签](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0416.md): 为指定桶中的对象设置标签信息。文件桶不支持该功能每个对象最多能设置10个标签。
- [获取对象标签](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0417.md): 获取指定桶中的对象标签。
- [删除对象标签](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0418.md): 删除指定桶中的对象的标签。
- [生成带授权信息的URL](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0501.md): 通过访问密钥、请求方法类型、请求参数等信息生成一个在Query参数中携带鉴权信息的URL，以对OBS服务进行特定操作。
- [生成带授权信息的表单上传参数](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0502.md): 生成用于鉴权的请求参数，以进行基于浏览器的POST表单上传。使用SDK生成用于鉴权的请求参数包括两个：Policy，对应表单中policy字段。Signature，对应表单中的signature字段。
- [修订记录](https://support.huaweicloud.com/api-obs_php_sdk_api_zh/obs_38_0601.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。