# 获取桶策略(Node.js SDK)
#### 功能介绍
OBS支持对桶操作进行权限控制，您可以为桶设置访问策略，指定某一个用户对某一个桶是否有权行使某一项指定操作。OBS权限控制的方式有IAM、桶策略和ACL三种，本节将对桶策略接口进行详细介绍，更多权限相关内容可参见《对象存储服务权限配置指南》的[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)章节。
桶策略是作用于所配置的OBS桶及桶内对象的，您可以通过桶策略可为IAM用户或其他账号授权桶及桶内对象的操作权限。允许其他账号访问OBS资源，可以使用桶策略的方式授权对应权限。当不同的桶对于不同的IAM用户有不同的访问控制需求时，需使用桶策略分别授权IAM用户不同的权限。
调用获取桶策略接口，您可获取指定桶的桶策略。
#### 接口约束
- 以下两种场景无法使用此接口获取桶策略，系统将返回"404 NoSuchBucketPolicy"的错误：
  - 指定桶的策略不存在
  
  - 指定桶的标准桶策略为私有且未设置高级桶策略
   
- 您必须是桶拥有者或拥有获取桶策略的权限，才能获取桶策略。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketPolicy权限，如果使用桶策略则需授予GetBucketPolicy权限。相关授权方式介绍可参见[OBS权限控制概述](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0001.html)，配置方式详见[使用IAM自定义策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0121.html)、[自定义创建桶策略](https://support.huaweicloud.com/usermanual-obs/obs_03_0123.html)。
- OBS支持的Region与Endpoint的对应关系，详细信息请参见[地区与终端节点](https://console.huaweicloud.com/apiexplorer/#/endpoint/OBS)。
 
#### 方法定义
```
ObsClient.getBucketPolicy(params)
```
#### 请求参数
表1BucketRequestInput 
| **参数名称** | **参数类型** | **是否必选** | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| Bucket   | string   | 必选       | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。  - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。  - 禁止使用IP地址。  - 禁止以"-"或"."开头及结尾。  - 禁止两个"."相邻（如："my..bucket"）。  - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。    - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。   **取值范围：** 长度为3～63个字符。 **默认取值：** 无 |
   
#### 返回结果
表2返回结果 
| **参数类型**                                                                                                                                                | **描述**                                                                                  |
|:---|:---|
| [表3] 说明： 该接口返回是一个Promise类型，需要使用Promise、async/await语法处理。 | **参数解释：** 接口返回信息，详见[表3]。 |
   
 表3Response 
| **参数名称**        | **参数类型**                                       | **描述**                                                                                                                                                                          |
|:---|:---|:---|
| CommonMsg       | [ICommonMsg] | **参数解释：** 接口调用完成后的公共信息，包含HTTP状态码，操作失败的错误码等，详见[ICommonMsg]。                                                        |
| InterfaceResult | [表5]              | **参数解释：** 操作成功后的结果数据，详见[表5]。 **约束限制：** 当Status大于300时为空。 |
   
 表4ICommonMsg 
| **参数名称**  | **参数类型** |                                                                                                                                                                                                       **描述**                                                                                                                                                                                                        |
|---|---|---|
| Status    | number   | **参数解释：** OBS服务端返回的HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 |
| Code      | string   | **参数解释：** OBS服务端返回的错误码。                                                                                                                                                                                                                                                                                                                                    |
| Message   | string   | **参数解释：** OBS服务端返回的错误描述。                                                                                                                                                                                                                                                                                                                                  |
| HostId    | string   | **参数解释：** OBS服务端返回的请求服务端ID。                                                                                                                                                                                                                                                                                                                               |
| RequestId | string   | **参数解释：** OBS服务端返回的请求ID。                                                                                                                                                                                                                                                                                                                                  |
| Id2       | string   | **参数解释：** OBS服务端返回的请求ID2。                                                                                                                                                                                                                                                                                                                               |
| Indicator | string   | **参数解释：** OBS服务端返回的详细错误码。                                                                                                                                                                                                                                                                                                                                |
   
 表5GetBucketPolicyOutput 
| **参数名称**  | **参数类型** | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|
| RequestId | string   | **参数解释：** OBS服务端返回的请求ID。                                                                                                                                                                                                                                                                                                                                                     |
| Policy    | string   | **参数解释：** 策略信息，JSON格式的字符串。 **约束限制：** - Policy中的Resource字段包含的桶名必须和当前设置桶策略的桶名一致。  - Policy具体格式请参考[Policy格式](https://support.huaweicloud.com/perms-cfg-obs/obs_40_0041.html)。   |
   
#### 代码示例
本示例用于获取名为examplebucket的桶策略。
```
// 引入obs库
// 使用npm安装
const ObsClient = require("esdk-obs-nodejs");
// 使用源码安装
// var ObsClient = require('./lib/obs');
// 创建ObsClient实例
const obsClient = new ObsClient({
  // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险
  // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
  access_key_id: process.env.ACCESS_KEY_ID,
  secret_access_key: process.env.SECRET_ACCESS_KEY,
  // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入
  // security_token: process.env.SECURITY_TOKEN,
  // endpoint填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写
  server: "https://obs.cn-north-4.myhuaweicloud.com",
});
async function getBucketPolicy() {
  try {
    const params = {
      // 指定存储桶名称
      Bucket: "examplebucket"
    };
    // 获取桶策略
    const result = await obsClient.getBucketPolicy(params);
    if (result.CommonMsg.Status <= 300) {
      console.log("Get bucket(%s)'s policy successful!", params.Bucket);
      console.log("RequestId: %s", result.CommonMsg.RequestId);
      console.log("Policy: %s", result.InterfaceResult.Policy);
      return;
    };
    console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response.");
    console.log("Status: %d", result.CommonMsg.Status);
    console.log("Code: %s", result.CommonMsg.Code);
    console.log("Message: %s", result.CommonMsg.Message);
    console.log("RequestId: %s", result.CommonMsg.RequestId);
  } catch (error) {
    console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.");
    console.log(error);
  };
};
getBucketPolicy();
```