获取桶区域位置-GetBucketLocation

功能介绍

调用该接口可以获取指定桶的区域位置信息。

建议使用获取桶元数据-GetBucketMetadata接口来获取桶区域位置。

调用方法

请参见如何调用API。调用前需要先计算API签名，并将签名添加到请求中。

授权信息

您必须是桶拥有者或拥有获取桶区域位置的权限，才能调用本接口，建议使用IAM或桶策略进行授权。了解更多OBS授权方式请参见OBS不同权限控制方式的区别。

• 如果使用IAM授权，那么请在“角色与策略授权”、“身份策略授权”两种IAM授权方式中选择一种，并配置相应权限：
  • 如果使用角色与策略授权（旧版IAM，即IAM v3接口），需具备obs:bucket:GetBucketLocation权限，授权操作请参见创建IAM自定义策略。
  • 如果使用身份策略授权（新版IAM，即IAM v5接口），如下表所示，需具备obs:bucket:getBucketLocation权限，授权操作请参见创建IAM自定义身份策略。

    授权项 Action	访问级别 Access Level	资源类型（*为必须） Resource Type (*: required)	条件键 Condition Key	别名 Alias	依赖的授权项 Dependencies
    obs:bucket:getBucketLocation	Read	bucket *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-
    		-	obs:EpochTime obs:SourceIp obs:TlsVersion obs:CustomDomain

• 如果使用桶策略进行授权，需具备obs:bucket:GetBucketLocation权限，具体操作请参见自定义创建桶策略。

请求消息样式

以下为请求消息样例，请将示例中的BucketName修改为您的桶名，示例中的RegionID可以选择支持区域中任意一个region，不影响接口返回桶的区域位置。

1
2
3
4

GET /?location HTTP/1.1 
Host: BucketName.obs.RegionID.myhuaweicloud.com 
Date: GMT Date
Authorization: SignatureValue

URI参数（URI Parameters）

请求头参数（Request headers）

该请求使用公共消息头，具体参见表3。

请求体参数（Request body）

该请求消息中不带请求体。

响应消息样式

响应体中的Location参数将携带桶的区域位置信息。

1
2
3
4
5
6
7

HTTP/1.1 status_code
Date: date
Content-Type: type
Content-Length: length

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<Location xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/">cn-north-4</Location>

状态码

了解状态码详情请参见状态码。

响应头 (Response Headers)

该请求的响应消息使用公共消息头，具体请参考表1。

响应体 (Response Body)

该响应中将桶的区域信息以消息元素的形式返回，元素的具体含义如表2所示。

请求示例

1
2
3
4
5
6

GET /?location HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.cn-north-4.myhuaweicloud.com
Accept: */*
Date: WED, 01 Jul 2015 02:30:25 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:1DrmbCV+lhz3zV7uywlj7lrh0MY=

响应示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BF260000016435D9F27CB2758E9B41A5
x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSKWoJmaMyRXqofHgapbETDyI2LM9rUw
Content-Type: application/xml
Date: WED, 01 Jul 2015 02:30:25 GMT
Content-Length: 128

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Location xmlns="http://obs.cn-north-4.myhuaweicloud.com/doc/2015-06-30/">cn-north-4</Location>

使用SDK调用接口

建议您使用OBS SDK调用接口。SDK对API进行了封装以简化您的开发工作，直接调用SDK接口函数即可访问OBS，无需手动计算签名。

错误码

无特殊错误，所有错误已经包含在表2中。

相关文档

API操作涉及的计费项参见计费项。