华为云用户手册

返回结果 字段名 类型 说明 HttpStatusCode integer HTTP状态码。 Reason string HTTP文本描述。 RequestId string OBS服务端返回的请求ID。 Location string 桶的区域位置。 Name string 桶名。 Delimiter string 用于对对象名进行分组的字符，与请求中的该参数对应。 Prefix string 对象名的前缀，与请求中的该参数对应。 IsTruncated boolean 表明本次请求是否返回了全部结果，“true”表示没有返回全部结果；“false”表示已返回了全部结果。 KeyMarker string 列举多版本对象的起始位置，与请求中的该参数对应。 VersionIdMarker string 表示列举多版本对象的起始位置（VersionId标识），与请求中的该参数对应。 NextKeyMarker string 下次列举多版本对象请求的起始位置。 NextVersionIdMarker string 下次列举多版本对象请求的起始位置（VersionId标识），与NextKeyMarker配合使用。 MaxKeys integer 列举多版本对象的最大数目，与请求中的该参数对应。 Versions indexed array 多版本对象列表。 ETag string 对象的MD5值。 Size integer 对象的字节数。 Key string 对象名。 VersionId string 对象的版本号。 IsLatest boolean 标识对象是否是最新的版本，true代表是最新的版本。 LastModified string 对象最近一次被修改的时间。 Owner associative array 对象的拥有者。 ID string 对象所有者的DomainId。 StorageClass string 对象的存储类型 DeleteMarkers indexed array 删除标记列表。 Owner associative array 对象的所有者。 ID string 对象所有者的DomainId。 Key string 对象名。 VersionId string 对象的版本号。 IsLatest boolean 标识对象是否是最新的版本，true代表是最新的版本。 LastModified string 对象最近一次被修改的时间。 CommonPrefixes indexed array 当请求中设置了Delimiter分组字符时，返回按Delimiter分组后的对象名称前缀列表。 Prefix string 按Delimiter分组后的对象名称前缀。

请求参数 字段名 类型 约束 说明 Bucket string 必选 桶名。 Objects indexed array 必选 待删除的对象列表。 Key string 必选 待删除对象的名称。 VersionId string 可选 待删除对象的版本号。 Quiet boolean 可选 批量删除对象的响应方式，false表示详细模式，返回删除成功和删除失败的所有结果；true表示简单模式，只返回删除过程中出错的结果。

返回结果 字段名 类型 说明 HttpStatusCode integer HTTP状态码。 Reason string HTTP文本描述。 RequestId string OBS服务端返回的请求ID。 Deleteds indexed array 删除成功的对象列表。 Key string 删除成功的对象名。 VersionId string 删除成功的对象版本号。 DeleteMarker boolean 标识删除的对象是否是删除标记。 DeleteMarkerVersionId string 删除标记的版本号。 Errors indexed array 删除失败的对象列表。 Key string 删除失败的对象名。 VersionId string 删除失败的对象版本号。 Code string 删除失败的错误码。 Message string 删除失败的错误消息。

请求参数 字段名 类型 约束 说明 Bucket string 必选 桶名。 Agency string 如果是设置桶日志配置则必选 委托名。 LoggingEnabled associative array 可选 日志配置信息。 TargetBucket string 必选 生成日志的目标桶。 TargetPrefix string 必选 在目标桶中生成日志对象的对象名前缀。 TargetGrants indexed array 可选 被授权用户权限信息列表。 Grantee associative array 可选 被授权用户。 Type string 必选 被授权的用户类型。 ID string 如果Type为“CanonicalUser”则必选，否则必须为空 被授权用户的DomainId。 URI string 如果Type为“Group”则必选，否则必须为空 被授权的用户组。 Permission string 可选 被授予的权限。

请求参数 字段名 类型 约束 说明 Bucket string 必选 桶名。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用类IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 ACL string 可选 创桶时可指定的预定义访问策略。 StorageClass string 可选 创桶时可指定的桶的存储类型。 LocationConstraint string 如果请求的OBS服务地址所在区域为默认区域，则可为空，否则为必选。 桶所在的区域。 该参数定义了桶将会被创建在哪个区域，如果使用的终端节点归属于默认区域华北-北京一（cn-north-1），可以不携带此参数；如果使用的终端节点归属于其他区域，则必须携带此参数。当前有效的区 域名 称可从这里查询。有关OBS区域和终端节点的更多信息，请参考地区和终端节点。

请求参数 字段名 类型 约束 说明 Bucket string 必选 桶名。 Rules indexed array 必选 桶生命周期规则列表。 Transitions indexed array 可选 对象转换策略列表。 StorageClass string 必选 对象转换后的存储类型。 说明： 不支持“标准存储”类型。 Date string 或 \DateTime 如果没有设置Days则必选 表示对象转换的日期。该值必须兼容ISO8601格式（例如：2018-01-01T00:00:00Z），而且必须是UTC午夜0点。 Days integer 如果没有设置Date则必选 表示在对象创建时间后第几天时转换，正整数。 Expiration associative array 可选 对象过期时间配置。 Date string 或 \DateTime 如果没有设置Days则必选 表示对象过期的日期。该值为字符串时必须兼容ISO8601格式（例如：2018-01-01T00:00:00Z），而且必须是UTC午夜0点。 Days integer 如果没有设置Date则必选 表示在对象创建时间后第几天时过期，正整数。 ID string 可选 规则ID，由不超过255个字符的字符串组成。 Prefix string 必选 对象名前缀，用以标识哪些对象可以匹配到当前这条规则。可为空字符串，代表匹配桶内所有对象。 Status string 必选 标识当前这条规则是否启用，支持的值： Enabled Disabled NoncurrentVersionTransitions indexed array 可选 历史版本对象转换策略列表。 StorageClass string 必选 历史版本对象转换后的存储类型。 NoncurrentDays integer 必选 表示对象成为历史版本后第几天时转换，正整数。 NoncurrentVersionExpiration associative array 可选 历史版本对象过期时间配置。 NoncurrentDays integer 必选 表示对象成为历史版本后第几天时过期，正整数。 Transitions、Expiration、NoncurrentVersionTransitions、NoncurrentVersionExpiration不能全为空。

参数描述 字段名 类型 约束 说明 key string 必选 访问密钥中的AK。 secret string 必选 访问密钥中的SK。 endpoint string 必选 连接OBS的服务地址。包含协议类型、域名（或IP）、端口号。示例：https://your-endpoint:443。 您可以从这里查看OBS当前开通的服务地址。 ssl_verify boolean 或 string 可选 验证服务端证书参数。可能的取值： 服务端pem格式根证书文件路径； true：使用默认的CAs验证服务端证书； false：表示不验证服务端证书。 默认为false。 max_retry_count integer 可选 HTTP/HTTPS连接异常时的请求重试次数。默认为3次。 socket_timeout integer 可选 Socket层传输数据的超时时间（单位：秒）。默认为60秒。 connect_timeout integer 可选 建立HTTP/HTTPS连接的超时时间（单位：秒）。默认为60秒。 chunk_size integer 可选 读socket流时的块大小（单位：字节）。默认为65536字节。

返回结果 字段名 类型 说明 HttpStatusCode integer HTTP状态码。 Reason string HTTP文本描述。 RequestId string OBS服务端返回的请求ID。 Owner associative array 桶的所有者。 ID string 桶所有者的DomainId。 Grants indexed array 被授权用户权限信息列表。 Grantee associative array 被授权用户。 ID string 被授权用户的DomainId，当用户类型是Group时为空。 URI string 被授权的用户组，当用户类型是CanonicalUser时为空。 Permission string 被授予的权限。 Delivered boolean 桶内对象ACL是否继承桶的ACL。

请求参数 字段名 类型 约束 说明 Bucket string 必选 桶名。 Key string 必选 对象名。 ACL string 可选 创建对象时可指定的预定义访问策略。 StorageClass string 可选 创建对象时可指定的对象的存储类型。 Body string 或 resource 或 GuzzleHttp\Psr7\StreamInterface 可选 待上传对象的内容。 SourceFile string 可选 待上传对象的源文件路径。 Metadata associative array 可选 待上传对象的自定义元数据。 WebsiteRedirectLocation string 可选 当桶设置了Website配置，该参数指明对象的重定向地址。 ContentType string 可选 待上传对象的MIME类型。 ContentLength integer 可选 待上传对象数据的长度。 ContentMD5 string 可选 待上传对象数据的MD5值（经过Base64编码），提供给OBS服务端，校验数据完整性。 SseKms string 可选 以SSE-KMS方式加密对象，支持的值： kms SseKmsKey string 可选 SSE-KMS方式下加密的主密钥，可为空。 SseC string 可选 以SSE-C方式加密对象，支持的值： AES256 SseCKey string 可选 SSE-C方式下加密的密钥，由AES256算法得到。 Body与SourceFile不能同时使用。 当Body与SourceFile都为空时，上传对象的大小为0字节。

返回结果 字段名 类型 说明 HttpStatusCode integer HTTP状态码。 Reason string HTTP文本描述。 RequestId string OBS服务端返回的请求ID。 ObjectURL string 对象的地址。 ETag string 对象的ETag值。 VersionId string 对象的版本号。 StorageClass string 对象的存储类型，当对象存储类型是标准存储时，该值为空。 SseKms string SSE-KMS方式的算法。 SseKmsKey string SSE-KMS方式的密钥。 SseC string SSE-C方式的算法。 SseCKeyMd5 string SSE-C方式的密钥的MD5值。

返回结果 字段名 类型 说明 HttpStatusCode integer HTTP状态码。 Reason string HTTP文本描述。 RequestId string OBS服务端返回的请求ID。 VersionId string 对象的版本号。 Owner associative array 对象的所有者。 ID string 对象所有者的DomainId。 Delivered boolean 桶的ACL是否向桶内对象传递。 Grants indexed array 被授权用户权限信息列表。 Grantee associative array 被授权用户。 ID string 被授权用户的DomainId，当用户类型是Group时为空。 URI string 被授权的用户组，当用户类型是CanonicalUser时为空。 Permission string 被授予的权限。

参数描述 字段名 类型 约束 说明 FilePath string 必选 保存日志文件的目录。 FileName string 必选 日志文件名。 MaxFiles integer 必选 最大可保留的日志文件个数。 Level integer 必选 日志级别，SDK内部定义了四个integer类型的常量以对应不同的日志级别，有效值： DEBUG（100） INFO（200） WARN（300） ERROR（400）

请求参数 字段名 类型 约束 说明 Bucket string 必选 桶名。 ACL string 可选 预定义访问策略。 Owner associative array 可选 桶的所有者。 ID string 必选 桶所有者的DomainId。 DisplayName string 可选 桶所有者的名字。 Grants indexed array 可选 被授权用户权限信息列表。 Grantee associative array 必选 被授权用户。 Type string 必选 被授权的用户类型。 ID string 如果Type为“CanonicalUser”则必选，否则必须为空 被授权用户的DomainId。 URI string 如果Type为“Group”则必选，否则必须为空 被授权的用户组。 Permission string 必选 被授予的权限。 Delivered boolean 可选 桶内对象ACL是否继承桶的ACL。 Owner和Grants必须配套使用，且与ACL互斥。当设置了这两个字段时，不能设置ACL；反之，当设置了ACL时，不能设置Owner和Grants。 Owner、Grants与ACL不能全为空。

返回结果 字段名 类型 说明 HttpStatusCode integer HTTP状态码。 Reason string HTTP文本描述。 RequestId string OBS服务端返回的请求ID。 Agency string 委托名。 LoggingEnabled associative array 日志配置信息。 TargetBucket string 生成日志的目标桶。 TargetPrefix string 在目标桶中生成日志对象的对象名前缀。 TargetGrants indexed array 被授权用户权限信息列表。 Grantee associative array 被授权用户。 ID string 被授权用户的DomainId，当用户类型是Group时为空。 URI string 被授权的用户组，当用户类型是CanonicalUser时为空。 Permission string 被授予的权限。

修订记录 发布日期 修订记录 2019-03-30 第五次正式发布。 新增章节： 简介。 2019-01-17 第四次正式发布。 修改章节： ObsClient初始化，修改代码样例。 2018-10-31 第三次正式发布。 新增章节： “生成带授权信息的表单上传参数” 修改章节: “预定义常量”，拆分为八个子章节。 2018-01-31 第二次正式发布。 新增章节： “预定义常量” “设置桶存储类型” “获取桶存储类型” 修改章节： “临时鉴权”，修改返回结果参数和示例代码。 设置桶的生命周期配置，新增Transitions字段和NoncurrentVersionTransitions字段。 获取桶的生命周期配置，新增Transitions字段和NoncurrentVersionTransitions字段。 上传对象，新增StorageClass字段。 复制对象，新增StorageClass字段。 初始化分段任务，新增StorageClass字段。 2017-11-30 第一次正式发布。

返回结果 字段名 类型 说明 HttpStatusCode integer HTTP状态码。 Reason string HTTP文本描述。 RequestId string OBS服务端返回的请求ID。 ETag string 合并段后根据各个段的ETag值计算出的结果。 Bucket string 合并段所在的桶。 Key string 合并段后得到的对象名。 Location string 合并段后得到的对象的url。 VersionId string 合并段后得到的对象版本号。 SseKms string SSE-KMS方式的算法。 SseKmsKey string SSE-KMS方式的主密钥。 SseC string SSE-C方式的算法。 SseCKeyMd5 string SSE-C方式的密钥的MD5值。

预定义访问策略 访问方式 类型 说明 ObsClient::AclPrivate string 私有读写。 ObsClient::AclPublicRead string 公共读。 ObsClient::AclPublicReadWrite string 公共读写。 ObsClient::AclPublicReadDelivered string 桶公共读，桶内对象公共读。 ObsClient::AclPublicReadWriteDelivered string 桶公共读写，桶内对象公共读写。 父主题： 预定义常量

请求参数 字段名 类型 约束 说明 Bucket string 必选 桶名。 Key string 必选 对象名。 UploadId string 必选 分段上传任务的ID。 MaxParts integer 可选 列举已上传段的返回结果最大段数目，即分页时每一页中段数目。 PartNumberMarker integer 可选 列举已上传段的起始位置，只有Part Number大于该参数的段会被列出。

返回结果 字段名 类型 说明 HttpStatusCode integer HTTP状态码。 Reason string HTTP文本描述。 RequestId string OBS服务端返回的请求ID。 Bucket string 桶名。 Key string 对象名。 UploadId string 分段上传任务的ID。 PartNumberMarker string 列举已上传段的起始位置，与请求中的该参数对应。 NextPartNumberMarker string 下次列举已上传段请求的起始位置。 MaxParts string 列举已上传段的返回结果最大段数目，与请求中的该参数对应。 IsTruncated boolean 表明本次请求是否返回了全部结果，“true”表示没有返回全部结果；“false”表示已返回了全部结果。 Parts indexed array 已上传段列表。 PartNumber integer 段号。 LastModified string 段的最后上传时间。 ETag string 段的ETag值。 Size integer 段的大小。 Initiator associative array 分段上传任务的创建者。 ID string 创建者的DomainId。 DisplayName string 创建者的名字。 Owner associative array 和Initiator相同，代表分段上传任务的创建者。 ID string 创建者的DomainId。 DisplayName string 创建者的名字。 StorageClass string 待分段上传对象的存储类型。

请求参数 字段名 类型 约束 说明 Method string 必选 HTTP方法类型，支持的值： GET POST PUT DELETE HEAD Bucket string 可选 桶名。 Key string 可选 对象名。 SpecialParam string 可选 特殊操作符，代表要操作的子资源，支持的值： versions uploads location storageinfo quota storagePolicy acl logging policy lifecycle website versioning cors notification tagging delete restore Expires integer 可选 带授权信息的URL的过期时间（单位：秒），默认值：300。 Headers associative array 可选 请求中携带的头域。 QueryParams associative array 可选 请求中携带的查询参数。

返回结果 字段名 类型 说明 HttpStatusCode integer HTTP状态码。 Reason string HTTP文本描述。 RequestId string OBS服务端返回的请求ID。 Location string 桶的区域位置。 StorageClass string 桶的存储类型，当桶存储类型是标准存储时，该值为空。 AllowOrigin string 如果请求中的Origin满足服务端的CORS规则，则返回服务端CORS配置中的AllowedOrigin。 AllowHeader string 如果请求的RequestHeader满足服务端的CORS规则，则返回服务端CORS配置中的AllowedHeader。 AllowMethod string 服务端CORS规则中的AllowedMethod。 ExposeHeader string 服务端CORS规则中的ExposeHeader。 MaxAgeSeconds integer 服务端CORS规则中的MaxAgeSeconds。

请求参数 字段名 类型 约束 说明 Bucket string 必选 桶名。 Key string 必选 对象名。 PartNumber integer 必选 段号，取值范围：1~10000。 UploadId string 必选 分段上传任务的ID。 ContentMD5 string 可选 待上传段数据的MD5值（经过Base64编码），提供给OBS服务端，校验数据完整性。 Body string 或 resource 或 GuzzleHttp\Psr7\StreamInterface 可选 待上传段的内容。 SourceFile string 可选 待上传段的源文件路径。 Offset integer 可选 源文件中某一分段的起始偏移大小，默认值为0， 单位为字节。 PartSize integer 可选 源文件中某一分段的大小，默认值为文件大小减去Offset的剩下字节数，单位为字节。除最后一段的大小范围是0~5GB外，其他段的大小范围是100KB~5GB。 SseC string 可选 以SSE-C方式加密段，支持的值： AES256 SseCKey string 可选 SSE-C方式下加密的密钥，由AES256算法得到。 Body与SourceFile不能同时使用。 当Body与SourceFile都为空时，上传对象的大小为0字节。 Offset、PartSize和SourceFile配套使用，用于指定上传源文件中的某一分段数据。

返回结果 字段名 类型 说明 HttpStatusCode integer HTTP状态码。 Reason string HTTP文本描述。 RequestId string OBS服务端返回的请求ID。 ETag string 当前上传段的ETag值。 SseKms string SSE-KMS方式的算法。 SseKmsKey string SSE-KMS方式的密钥。 SseC string SSE-C方式的算法。 SseCKeyMd5 string SSE-C方式的密钥的MD5值。

请求参数 字段名 类型 约束 说明 Bucket string 可选 桶名。 Key string 可选 对象名，对应表单中的key字段。 Expires integer 可选 表单上传鉴权参数的过期时间（单位：秒），默认值300。 FormParams associative array 可选 除key、policy、signature外，表单上传时的其他参数，支持的值： acl cache-control content-type content-disposition content-encoding expires

请求参数 字段名 类型 约束 说明 Bucket string 必选 桶名。 Key string 必选 对象名。 VersionId string 可选 对象的版本号。 ACL string 可选 预定义访问策略。 Owner associative array 可选 对象的所有者。 ID string 必选 对象所有者的DomainId。 Delivered boolean 可选 桶的ACL是否向桶内对象传递。 Grants indexed array 可选 被授权用户权限信息列表。 Grantee Object 必选 被授权用户。 Type string 必选 被授权的用户类型。 ID string 如果Type为“CanonicalUser”则必选，否则必须为空 被授权用户的DomainId。 URI string 如果Type为“Group”则必选，否则必须为空 被授权的用户组。 Permission string 必选 被授予的权限。 Owner和Grants必须配套使用，且与ACL互斥。当设置了这两个字段时，不能设置ACL；反之，当设置了ACL时，不能设置Owner和Grants。 Owner、Grants与ACL不能全为空。

返回结果 字段名 类型 说明 HttpStatusCode integer HTTP状态码。 Reason string HTTP文本描述。 RequestId string OBS服务端返回的请求ID。 Bucket string 分段上传任务的桶名。 Key string 分段上传任务的对象名。 UploadId string 分段上传任务的ID。 SseKms string SSE-KMS方式的算法。 SseKmsKey string SSE-KMS方式的密钥。 SseC string SSE-C方式的算法。 SseCKeyMd5 string SSE-C方式的密钥的MD5值。

返回结果 字段名 类型 说明 HttpStatusCode integer HTTP状态码。 Reason string HTTP文本描述。 RequestId string OBS服务端返回的请求ID。 Buckets indexed array 桶列表。 Name string 桶名。 CreationDate string 桶的创建时间。 Location string 桶的区域位置。 Owner associative array 桶的所有者。 ID string 桶所有者的DomainId。

请求参数 字段名 类型 约束 说明 Bucket string 必选 桶名。 Key string 必选 对象名。 ACL string 可选 预定义访问策略。 StorageClass string 可选 对象的存储类型。 Metadata associative array 可选 对象的自定义元数据信息。 WebsiteRedirectLocation string 可选 当桶设置了Website配置，该参数指明对象的重定向地址。 ContentType string 可选 对象的MIME类型。 SseKms string 可选 以SSE-KMS方式加密对象，支持的值： kms SseKmsKey string 可选 SSE-KMS方式下加密的主密钥，可为空。 SseC string 可选 以SSE-C方式加密对象，支持的值： AES256 SseCKey string 可选 SSE-C方式下加密的密钥，由AES256算法得到。

请求参数 字段名 类型 约束 说明 Bucket string 必选 桶名。 RedirectAllRequestsTo associative array 可选 所有请求重定向规则。 HostName string 必选 重定向请求时使用的站点名。 Protocol string 可选 重定向请求时使用的协议，支持的值： http（默认） https ErrorDocument associative array 可选 错误页面配置。 Key string 可选 指定当4XX错误出现时返回的页面。 IndexDocument associative array 可选 默认页面配置。 Suffix string 必选 该字段被追加在对文件夹的请求的末尾（例如：配置的是“index.html”，请求的是“samplebucket/images/”，返回的数据将是“samplebucket”桶内名为“images/index.html”的对象的内容）。该字段不能为空或者包含“/”字符。 RoutingRules indexed array 可选 重定向规则列表。 Condition associative array 可选 重定向规则的匹配条件。 HttpErrorCodeReturnedEquals string 可选 重定向规则生效需要匹配的HTTP错误码。 KeyPrefixEquals string 可选 重定向规则生效需要匹配的对象名前缀。 Redirect associative array 必选 重定向请求时的具体信息。 Protocol string 可选 重定向请求时使用的协议，支持的值： http https HostName string 可选 重定向请求时使用的站点名。 ReplaceKeyPrefixWith string 可选 重定向请求时使用的对象名前缀。 ReplaceKeyWith string 可选 重定向请求时使用的对象名。不可与ReplaceKeyPrefixWith同时存在。 HttpRedirectCode string 可选 重定向请求时响应中的HTTP状态码。 ErrorDocument，IndexDocument和RoutingRules必须配套使用，且与RedirectAllRequestsTo互斥。当设置了这三个字段时，不能设置RedirectAllRequestsTo；反之，当设置了RedirectAllRequestsTo时，不能设置ErrorDocument，IndexDocument和RoutingRules。 当ErrorDocument，IndexDocument和RoutingRules三个字段一起使用时，RoutingRules可为空。 ErrorDocument，IndexDocument、RoutingRules与RedirectAllRequestsTo不能全为空。

返回结果 字段名 类型 说明 HttpStatusCode integer HTTP状态码。 Reason string HTTP文本描述。 RequestId string OBS服务端返回的请求ID。 CorsRules indexed array 桶的CORS规则列表。 ID string CORS规则ID。 AllowedMethod indexed array of strings CORS规则允许的HTTP方法。 AllowedOrigin indexed array of strings CORS规则允许的请求来源（表示域名的字符串）。 AllowedHeader indexed array of strings CORS规则允许请求中可携带的头域。 MaxAgeSecond integer CORS规则允许客户端可以对跨域请求返回结果的缓存时间，以秒为单位。 ExposeHeader indexed array of strings CORS规则允许响应中可返回的附加头域。