华为云用户手册

  • 响应示例 1 2 3 4 5 HTTP/1.1 200 OK Server: OBS x-obs-request-id: BF26000001643FEBA09B1ED46932CD07 x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAA BCS EZp87iEirC6DggPB5cN49pSvHBWClg Date: Wed, 27 Jun 2018 13:22:50 GMT
  • 错误响应消息 除了公共的错误码外,此接口还会返回一些其他的错误码。下表中列出本接口的一些常见错误,以及可能原因。如下表4 配置对象标签错误码列表。 表4 配置对象标签错误码列表 错误码 描述 HTTP状态码 InvalidTag 配置对象标签时,提供了无效的Tag 400 BadRequest 对象标签个数超过上限 400 MalformedXML 配置对象标签时,提供的xml格式错误 400 EntityTooLarge 请求body体超长 400 AccessDenied 用户无权限设置对象标签 403 MethodNotAllowed 不允许使用该方法(特性开关未开启) 405
  • 请求消息元素 在此请求中,需要在请求的消息体中配置对象的标签。标签的配置信息以XML格式上传。具体的配置元素如下表3 对象的标签配置元素所示。 表3 对象的标签配置元素 消息头名称 描述 是否必选 Tagging TagSet和Tag的根元素 类型:Container 父元素:无 是 TagSet Tag的集合元素 类型:Container 父元素:Tagging 是 Tag Tag的信息元素 类型:Container 父元素:TagSet 是 Key Tag的名字 类型:String 父元素:Tag 是 Value Tag的值 类型:String 父元素:Tag 是
  • 请求消息头 该请求使用的消息头如下表2 请求消息头所示。 表2 请求消息头 消息头名称 描述 是否必选 Content-MD5 按照RFC 1864标准计算出消息体的MD5摘要字符串,即消息体128-bit MD5值经过base64编码后得到的字符串。也支持设置Content-SHA256头域,其值为消息体256-bit SHA256值经过base64编码后得到的字符串,Content-MD5和Content-SHA256二选一。 类型:String 示例:n58IG6hfM7vqI4K0vnWpog== 是
  • 签名不匹配报错处理 如果调用OBS API报如下错误: 状态码:403 Forbidden 错误码:SignatureDoesNotMatch 错误信息:The request signature we calculated does not match the signature you provided. Check your key and signing method. 请参考以下案例进行排查处理:签名不匹配(SignatureDoesNotMatch)如何处理
  • 响应消息元素 在此请求返回的响应消息体中包含的桶级默认WORM策略元素如下表1描述。 表1 桶级默认WORM策略元素 名称 描述 ObjectLockConfiguration 桶级WORM配置的容器 类型:Container ObjectLockEnabled WORM开关状态,只能为Enabled 类型:String 示例:Enabled Rule 桶级默认WORM策略的规则容器,如果从未配置过桶级默认WORM策略,则返回中不会包含此部分 类型:Container DefaultRetention 桶级默认WORM策略的容器 类型:Container Mode 默认的保护策略,当前仅支持合规模式"COMPLIANCE" 类型:String 示例:COMPLIANCE Days 默认的保护天数,取值范围为1-36500天 类型:Integer 示例:1 Years 默认的保护年数,取值范围为1-100年,一年实际上视为保护365天,不会考虑闰年 类型:Integer 示例:1
  • 请求示例 2 打开了桶级WORM开关,且配置了桶级默认WORM策略的情况: GET /?object-lock HTTP/1.1 User-Agent: curl/7.29.0 Host: examplebucket.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: WED, 01 Jul 2015 02:25:05 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:75/Y4Ng1izvzc1nTGxpMXTE6ynw= Content-Length: 0
  • 请求示例 1 打开了桶级WORM开关,未配置桶级默认WORM策略的情况 GET /?object-lock HTTP/1.1 User-Agent: curl/7.29.0 Host: examplebucket.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: WED, 01 Jul 2015 02:25:05 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:75/Y4Ng1izvzc1nTGxpMXTE6ynw= Content-Length: 0
  • 响应示例 1 HTTP/1.1 200 OK Server: OBS x-obs-request-id: BF260000016435CE298386946AE4C482 x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCT9W2tcvLmMJ+plfdopaD62S0npbaRUz Date: WED, 01 Jul 2015 02:25:06 GMT Content-Length: 0
  • 响应示例 2 HTTP/1.1 200 OK Server: OBS x-obs-request-id: BF260000016435CE298386946AE4C482 x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCT9W2tcvLmMJ+plfdopaD62S0npbaRUz Date: WED, 01 Jul 2015 02:25:06 GMT Content-Length: 0
  • 请求消息元素 表1 请求消息元素表 名字 描述 是否必选 ObjectLockConfiguration 桶级WORM配置的容器 类型:Container 是 ObjectLockEnabled 桶级WORM开关状态,只能为Enabled 类型:String 示例:Enabled 否 Rule 桶级默认WORM策略的规则容器 类型:Container 设置桶级默认WORM策略配置时必选,不携带则会清空当前配置的桶级默认WORM策略 DefaultRetention 桶级默认WORM策略的容器 类型:Container 如果有Rule容器则必选 Mode 默认的保护策略,当前仅支持合规模式"COMPLIANCE" 类型:String 示例:COMPLIANCE 如果有DefaultRetention容器则必选 Days 默认的保护天数,取值范围为1-36500天 类型:Integer 示例:1 如果有DefaultRetention容器则和Years二选一,必须选择其中一个且不能同时指定 Years 默认的保护年数,取值范围为1-100年,一年实际上视为保护365天,不会考虑闰年 类型:Integer 示例:1 如果有DefaultRetention容器则和Days二选一,必须选择其中一个且不能同时指定
  • 功能介绍 桶的WORM开关开启后,支持配置默认保护策略和保护期限。 当您在桶内配置了桶级默认WORM策略以后,如果您在上传对象时没有指定保护策略和保护期限,则新上传的对象会自动应用桶级默认WORM策略。和配置对象级WORM保护策略不同的地方在于,对象级WORM保护策略需要您提供一个明确的时间,在这个时间之前对象都会受到保护,桶级默认WORM策略则要求您提供一个保护期限,实际上对象受到保护的时间点为其上传时间+您指定的保护期限。 要正确执行此操作,需要确保执行者有 "PutBucketObjectLockConfiguration"权限。默认情况下只有桶的所有者可以执行此操作,也可以通过设置桶策略或用户策略授权给其他用户。 您可以修改甚至清空桶级默认WORM策略,但这仅对修改后上传的对象生效,修改前上传的对象的保护状态不受影响。 多段上传的对象在合并前不受保护,合并后受桶级默认对象策略保护,您可以在其合并后单独为其配置对象级WORM保护策略。 其它约束如下: 策略目前仅支持设置为合规模式"COMPLIANCE" 支持设置的保留期限为1天-100*365天或1年~100年。
  • 响应示例 HTTP/1.1 200 OK Server: OBS x-obs-request-id: BF260000016435CE298386946AE4C482 x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCT9W2tcvLmMJ+plfdopaD62S0npbaRUz Date: WED, 01 Jul 2015 02:25:06 GMT Content-Length: 0
  • 请求消息元素 名字 描述 是否必选 Retention 对象级WORM保护策略配置的容器 类型:Container 是 Mode 对象的保护策略,当前仅支持合规模式"COMPLIANCE" 类型:String 示例:COMPLIANCE 是 RetainUntilDate 对象的保护期限,时间戳格式,精确到毫秒级,如2015年7月1日13点20分35秒对应的值为1435728035000。 说明: 该字段必须晚于当前时间,且仅可延长不能缩短。 类型:Long 示例:1435728035000 是
  • 功能介绍 用户可以通过本接口删除对象(Object)的标签信息。 如果请求中不携带版本号(versionId),需要确保执行者有DeleteObjectTagging权限。如果请求中携带版本号(versionId),需要确保执行者有DeleteObjectTagging+DeleteObjectVersionTagging权限。缺省情况下只有对象的所有者可以执行此操作,也可以通过设置桶策略或用户策略给其他用户。 默认删除Object当前版本的标签信息。可以通过指定versionId参数来删除指定Object版本的标签信息。如果对应版本为删除标记(Delete Marker),则OBS将返回404 Not Found。
  • 请求示例 1 2 3 4 5 6 DELETE /objectname?tagging&versionId=G001018455096CE600005306000000DD HTTP/1.1 User-Agent: curl/7.19.7 Host: examplebucket.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: Wed, 27 Jun 2018 13:46:58 GMT Authorization: authorization string
  • 响应示例 1 2 3 4 5 6 HTTP/1.1 204 No Content x-obs-request-id: 0002B7532E0000015BEB2C212E53A17L x-obs-id-2: CqT+86nnOkB+Cv9KZoVgZ28pSgMF+uGQBUC68flvkQeq6CxoCz65wWFMNBpXvea4 x-obs-version-id: G001018455096CE600005306000000DD Content-Length: 0 Date: Wed, 27 Jun 2018 13:46:58 GMT
  • 功能介绍 用户可以通过本接口获取对象(Object)的标签信息。 如果请求中不携带版本号(versionId),需要确保执行者有GetObjectTagging权限。如果请求中携带版本号(versionId),需要确保执行者有GetObjectTagging+GetObjectVersionTagging权限。缺省情况下只有对象的所有者可以执行此操作,也可以通过设置桶策略或用户策略给其他用户。 默认获取Object当前版本的标签信息。可以通过指定versionId参数来获取指定Object版本的标签信息。如果对应版本为删除标记(Delete Marker),则OBS将返回404 Not Found。
  • 请求示例 1 2 3 4 5 6 GET /objectname?tagging&versionId=G001018455096CE600005306000000DD HTTP/1.1 User-Agent: curl/7.29.0 Host: bucketname.obs.cn-north-4.myhuaweicloud.com Accept: */* Date: Wed, 27 Jun 2018 13:25:44 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:H1INcyc5i0XlHqYTfuzkPxLZUPM=
  • 响应示例 HTTP/1.1 200 OK Server: OBS Date: Tue, 07 Jul 2020 07:28:46 GMT Content-Type: application/json Content-Length: 497 { "rules": [{ "id": "ruleid", "project": "your project id", "agency": "testagency", "events": ["ObjectCreated:*"], "prefix": "decompress", "suffix": ".zip", "overwrite": 0, "decompresspath": "after-decompress/" }] }
  • 请求消息元素 表1 请求消息元素 名称 描述 是否必选 rules 策略规则数组。 类型:Container 取值范围:数组大小[1, 10] 说明: 同一个桶下的不同策略前缀不能重复和起始包含,委托建议使用同一个。 是 表2 rules参数说明 名称 描述 是否必选 id 解压策略名称。当前桶上配置的解压规则的唯一标识。 类型:String 取值范围:[1, 256],满足“^[a-zA-Z0-9_-]{1, 256}$”,既长度为1~256个字符。只能由大写或小写的英文字母、数字、下划线(_)和连字符(-)组成。例如:event_0001。 是 project 项目ID。 类型:String 是 agency 委托名。客户通过委托赋予OBS服务查询用户桶内指定对象是否存在以及向用户桶内上传对象的权限。 类型:String 是 events 触发事件类型。 类型:String 支持: ["ObjectCreated:*"] ["ObjectCreated:Put"] ["ObjectCreated:Post"] ["ObjectCreated:Copy"] ["ObjectCreated:CompleteMultipartUpload"] 是 prefix 匹配规则前缀。 类型:String 取值范围:[0, 1023] 否 suffix 匹配规则后缀。 类型:String 固定值:.zip 是 overwrite 解压后同名文件的处理方式。 类型:Integer 取值范围:0:不覆盖跳过,1:不覆盖,以文件的CRC32值重命名,2:覆盖。 是 decompresspath 文件解压后存放的路径,不为空时必须以“/”结尾。 类型:String 取值范围:[0, 800] 否 policytype 文件解压策略类型。 类型:String 固定值:decompress 是 请保证解压策略名称、解压路径、 IAM 委托名称长度之和不超过800。
  • 请求示例 PUT /?obscompresspolicy HTTP/1.1 Host: bucketname.obs.cn-north-4.myhuaweicloud.com Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 497 Date: Tue, 21 Jul 2020 15:38:30 GMT { "rules": [{ "id": "ruleid", "project": "your project id", "agency": "testagency", "events": ["ObjectCreated:*"], "prefix": "decompress", "suffix": ".zip", "overwrite": 0, "decompresspath": "after-decompress/", "policytype": "decompress" }] }
  • 请求消息样式 PUT /?obscompresspolicy HTTP/1.1 Host: bucketname.obs.cn-north-4.myhuaweicloud.com Authorization: authorization Content-Type: application/json Content-Length: length Date: date policy json body
  • 响应示例 HTTP/1.1 200 OK Server: OBS Date: Tue, 07 Jul 2020 07:28:46 GMT Content-Type: application/json Content-Length: 1063 { "rules": [{ "id": "event-01", "stream": "stream_name", "project": "project_id", "events": ["ObjectCreated:*", "ObjectRemoved:*"], "prefix": "", "suffix": "", "agency": "agency001" }] }
  • 响应消息元素 表1 响应消息元素 名称 描述 id 规则ID。当前桶上配置的DIS策略规则的唯一标识。 类型:String stream DIS服务通道名称。 类型:String project DIS服务通道所属的项目ID。 类型:String events OBS事件列表。 类型:String数组 prefix 对象名前缀。 类型:String suffix 对象名后缀。 类型:String agency IAM委托名。 类型:String
  • 请求示例 PUT /?disPolicy HTTP/1.1 Host: bucketname.obs.cn-north-4.myhuaweicloud.com Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 1049 Date: Tue, 21 Jul 2020 15:38:30 GMT { "rules": [{ "id":"event-01", "stream": "stream_name", "project": "project_id", "events": ["ObjectCreated:*", "ObjectRemoved:*"], "prefix": "", "suffix": "", "agency": "dis_agency" }] }
  • 请求消息样式 PUT /?disPolicy HTTP/1.1 Host: bucketname.obs.cn-north-4.myhuaweicloud.com Authorization: authorization Content-Type: application/json Content-Length: length Date: date Body: { "rules": [{ "id":"rule_id", "stream": "stream_name", "project": "project_id", "events": ["ObjectCreated:*", "ObjectRemoved:*"], "prefix": "", "suffix": "", "agency": "agency_name" }] }
  • 请求消息元素 表1 请求消息元素 名称 描述 是否必选 rules 策略规则数组。 类型:Container 取值范围:[1, 10] 说明: 同一个桶下的不同策略前缀不能重复和起始包含,委托建议使用同一个。 是 表2 rules参数说明 名称 描述 是否必选 id 规则ID。当前桶上配置的DIS策略规则的唯一标识。 类型:String 取值范围:[1, 256],满足“^[a-zA-Z0-9_-]{1, 256}$” 是 stream DIS服务通道名称。需要先在DIS服务创建此通道。 类型:String 是 project DIS服务通道所属的项目ID。 类型:String 是 events OBS事件列表。 类型:String 有效值:长度[0, 1023],值允许为任意字符,支持如下事件类型: ObjectCreated:* (所有上传操作) ObjectCreated:Put (上传对象) ObjectCreated:Post (使用浏览器上传对象) ObjectCreated:Copy (拷贝对象) ObjectCreated:CompleteMultipartUpload (合并段) ObjectRemoved:* (所有删除操作) ObjectRemoved:Delete (指定对象版本号删除对象) ObjectRemoved:DeleteMarkerCreated (不指定对象版本号删除对象) 是 prefix 对象名前缀,用于指定的对象名关键字,根据定义的前缀,输入需要过滤的对象的关键字信息,字符越长匹配精度越高,最大可支持1024个字符,最小可为空。同时,prefix和suffix加起来长度最大为1024个字符。 类型:String 取值范围:[0, 1024] 否 suffix 对象名后缀。用于指定的对象名关键字,根据定义的后缀,输入需要过滤的对象的关键字信息,字符越长匹配精度越高,最大可支持1024个字符,最小可为空。同时,prefix和suffix加起来长度最大为1024个字符。 类型:String 取值范围:[0, 1024] 否 agency IAM委托名,被委托方必须包含OBS服务,赋予的权限必须是DIS服务的DIS Administrator或DIS User。 类型:String 是
  • 请求示例 DELETE /?obsworkflowtriggerpolicy HTTP/1.1 Host: bucket.obs.cn-north-4.myhuaweicloud.com Date: Thu, 27 Aug 2020 12:38:10 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 0
  • 请求示例 GET /?obsworkflowtriggerpolicy HTTP/1.1 Host: bucket.obs.cn-north-4.myhuaweicloud.com Authorization: OBS H4IPJX0TQTHTHEBQQCEC:sc2PM13Wlfcoc/YZLK0MwsI2Zpo= Content-Type: application/json Content-Length: 0 Date: Thu, 27 Aug 2020 12:38:10 GMT
共100000条