查询桶策略公开状态(Java SDK)
接口约束
- 您必须是桶拥有者或拥有获取桶策略公开状态的权限,才能获取桶策略公开状态。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:GetBucketPolicyPublicStatus权限,如果使用桶策略则需授予GetBucketPolicyPublicStatus权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、自定义创建桶策略。
- OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点。
方法定义
obsClient.getBucketPolicyPublicStatus(GetBucketPolicyPublicStatusRequest request)
获取桶策略公开状态请求参数说明
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| request | 是 | 参数解释: 获取OBS桶策略的公开状态的请求参数,详见GetBucketPolicyPublicStatusRequest。 |
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| bucketName | String | 必选 | 参数解释: 桶名。 约束限制:
默认取值: 无 |
返回结果说明
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| statusCode | int | 参数解释: HTTP状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。 完整的状态码列表请参见状态码。 默认取值: 无 |
| responseHeaders | Map<String, Object> | 参数解释: HTTP响应消息头列表,由多个元组构成。元组中String代表响应消息头的名称,Object代表响应消息头的值。 默认取值: 无 |
| bucketPolicyStatus | 参数解释: 桶策略的公开状态。 默认取值: 无 |
代码示例
获取example-bucket-name桶的桶策略的公开状态。
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.bpa.BucketPolicyStatus;
import com.obs.services.model.bpa.GetBucketPolicyPublicStatusRequest;
import com.obs.services.model.bpa.GetBucketPolicyPublicStatusResult;
import java.util.Map;
public class GetBucketPolicyPublicStatusDemo {
public static void main(String[] args) {
// 您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。
// 您可以登录访问管理控制台获取访问密钥AK/SK
String ak = System.getenv("ACCESS_KEY_ID");
String sk = System.getenv("SECRET_ACCESS_KEY_ID");
// 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。
// 您可以通过环境变量获取访问密钥AK/SK/SecurityToken,也可以使用其他外部引入方式传入。
// String securityToken = System.getenv("SECURITY_TOKEN");
// endpoint填写桶所在的endpoint, 此处以华北-北京四为例,其他地区请按实际情况填写。
String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
// 您可以通过环境变量获取endPoint,也可以使用其他外部引入方式传入。
// String endPoint = System.getenv("ENDPOINT");
// 创建ObsClient实例
// 使用永久AK/SK初始化客户端
ObsClient obsClient = new ObsClient(ak, sk, endPoint);
// 使用临时AK/SK和SecurityToken初始化客户端
// ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);
try {
String bucketName = "example-bucket-name";
GetBucketPolicyPublicStatusRequest getBucketPolicyPublicStatusRequest =
new GetBucketPolicyPublicStatusRequest();
getBucketPolicyPublicStatusRequest.setBucketName(bucketName);
GetBucketPolicyPublicStatusResult getBucketPolicyPublicStatusResult =
obsClient.getBucketPolicyPublicStatus(getBucketPolicyPublicStatusRequest);
BucketPolicyStatus bucketPolicyStatus =
getBucketPolicyPublicStatusResult.getPolicyStatus();
if (bucketPolicyStatus != null) {
Boolean bucketPolicyStatusIsPublic = bucketPolicyStatus.getIsPublic();
if (bucketPolicyStatusIsPublic != null) {
System.out.println("GetBucketPolicyPublicStatus BucketPolicyStatusIsPublic:" + bucketPolicyStatusIsPublic);
}
} else {
System.out.println("GetBucketPolicyPublicStatus bucketPublicAccessBlock is null.");
}
System.out.println("GetBucketPolicyPublicStatus successfully");
} catch (ObsException e) {
System.out.println("GetBucketPolicyPublicStatus failed");
// 请求失败,打印http状态码
System.out.println("HTTP Code:" + e.getResponseCode());
// 请求失败,打印服务端错误码
System.out.println("Error Code:" + e.getErrorCode());
// 请求失败,打印详细错误信息
System.out.println("Error Message:" + e.getErrorMessage());
// 请求失败,打印请求id
System.out.println("Request ID:" + e.getErrorRequestId());
System.out.println("Host ID:" + e.getErrorHostId());
Map<String, String> headers = e.getResponseHeaders();// 遍历Map的entry,打印所有报错相关头域
if(headers != null){
for (Map.Entry<String, String> header : headers.entrySet()) {
System.out.println(header.getKey()+":"+header.getValue());
}
}
e.printStackTrace();
} catch (Exception e) {
System.out.println("GetBucketPolicyPublicStatus failed");
// 其他异常信息打印
e.printStackTrace();
}
}
} 相关链接
- 关于查询桶策略公开状态的API说明,请参见获取桶策略公共状态。
- 查询桶策略公开状态过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
- 桶和对象相关常见问题请参见桶和对象相关常见问题。