更新时间:2026-08-28 GMT+08:00
分享

删除桶级阻止公共访问配置(HarmonyOS SDK)

功能说明

可通过本接口删除桶级BPA配置。

接口约束

  • 您必须是桶拥有者或拥有删除桶级阻止公共访问配置的权限,才能删除桶级阻止公共访问配置。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:bucket:DeleteBucketPublicAccessBlock权限,如果使用桶策略则需授予DeleteBucketPublicAccessBlock权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略自定义创建桶策略
  • OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点

方法定义

1
deleteBucketPublicAccessBlock(input: BucketRequestInput): Response<BaseResponseOutput>

请求参数

表1 请求参数列表

参数名称

参数类型

是否必选

描述

input

BucketRequestInput

必选

参数解释:

删除桶级阻止公共访问接口入参,详见BucketRequestInput

返回结果

表2 返回结果

参数类型

描述

Response

说明:

该接口返回一个Promise类型,需要使用Promise、async/await语法处理。

参数解释:

接口返回信息,详见Response

表3 Response

参数名称

参数类型

描述

CommonMsg

ICommonMsg

参数解释:

接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见ICommonMsg

InterfaceResult

BaseResponseOutput

参数解释:

操作成功后的结果数据,详见BaseResponseOutput

约束限制:

当Status大于300时为空。

表4 ICommonMsg

参数名称

参数类型

描述

Status

number

参数解释:

OBS服务端返回的HTTP状态码。

取值范围:

状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码

Code

string

参数解释:

OBS服务端返回的错误码。

Message

string

参数解释:

OBS服务端返回的错误描述。

HostId

string

参数解释:

OBS服务端返回的请求服务端ID。

RequestId

string

参数解释:

OBS服务端返回的请求ID。

Id2

string

参数解释:

OBS服务端返回的请求ID2。

Indicator

string

参数解释:

OBS服务端返回的详细错误码。

表5 BaseResponseOutput

参数名称

参数类型

描述

RequestId

string

参数解释:

OBS服务端返回的请求ID。

Id2

string

参数解释:

OBS服务端返回的请求ID2。

代码示例

本示例用于删除 examplebucket 桶的公共访问阻断配置。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
// 引入依赖包
import ObsClient, { BucketRequestInput } from '@obs/esdk-obs-harmony';
import { process } from '@kit.ArkTS';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
const processManager = new process.ProcessManager();

// 创建ObsClient实例
const obsClient = new ObsClient({
  // 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险
  // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
  AccessKeyId: processManager.getEnvironmentVar("ACCESS_KEY_ID"),
  SecretAccessKey: processManager.getEnvironmentVar("SECRET_ACCESS_KEY"),
  // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入
  // SecurityToken: processManager.getEnvironmentVar("SECURITY_TOKEN"),
  // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写
  Server: "https://obs.cn-north-4.myhuaweicloud.com",
});

async function deleteBucketPublicAccessBlock() {
  try {
    const params: BucketRequestInput = { Bucket: "examplebucket" };
    const result = await obsClient.deleteBucketPublicAccessBlock(params);
    if (result.CommonMsg.Status < 300) {
      hilog.info(0x0001, 'OBS-Harmony', "Delete bucket(%s)'s PublicAccessBlock successful!", params.Bucket);
      hilog.info(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId);
      return;
    }
    hilog.error(0x0001, 'OBS-Harmony', "An ObsError was found, which means your request sent to OBS was rejected with an error response.");
    hilog.error(0x0001, 'OBS-Harmony', "Status: %d", result.CommonMsg.Status);
    hilog.error(0x0001, 'OBS-Harmony', "Code: %s", result.CommonMsg.Code);
    hilog.error(0x0001, 'OBS-Harmony', "Message: %s", result.CommonMsg.Message);
    hilog.error(0x0001, 'OBS-Harmony', "RequestId: %s", result.CommonMsg.RequestId);
  } catch (error) {
    const err = error as BusinessError;
    hilog.error(0x0001, 'OBS-Harmony', 'An Exception occurred: code=%d, message: %s', err.code, err.message);
  }
}

deleteBucketPublicAccessBlock();

相关链接

  • 删除桶级阻止公共访问配置过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码

相关文档