# OPTIONS桶(Java SDK)
#### 功能介绍
OPTIONS，称为预请求，是客户端发送给服务端的一种请求，通常被用于检测客户端是否具有对服务端进行操作的权限。只有当预请求成功返回，客户端才开始执行后续的请求。
OBS允许在桶内保存静态的网页资源，在正确的使用下，OBS的桶可以成为网站资源。在这种使用场景下，OBS中的桶作为服务端，需要处理客户端发送的OPTIONS预请求。
要处理OPTIONS，OBS的桶必须已经配置CORS，关于CORS的使用说明，请参见章节 [设置跨域资源共享规则(Java SDK)](https://support.huaweicloud.com/sdk-java-devg-obs/obs_21_1402.html)。
![](https://support.huaweicloud.com/sdk-java-devg-obs/public_sys-resources/notice_3.0-zh-cn.png)
开发过程中，您有任何问题可以在Github上[提交issue](https://github.com/huaweicloud/huaweicloud-sdk-java-obs/issues)，或者在[华为云对象存储服务论坛](https://bbs.huaweicloud.com/forum/forum-620-1.html)中发帖求助。
#### 接口约束
- OBS支持的region以及region与endPoint的对应关系，详细信息请参见[地区与终端节点](https://developer.huaweicloud.com/endpoint?OBS)。
 
#### 方法定义
obsClient.optionsBucket(OptionsInfoRequest request)
#### 请求参数说明
表1OptionsInfoRequest 
| **参数名称**       | **参数类型**       | **是否必选** | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| bucketName     | String         | 必选       | **参数解释** **：** 桶名。 **约束限制：** - 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。  - 桶命名规则如下： - 3～63个字符，数字或字母开头，支持小写字母、数字、"-"、"."。  - 禁止使用IP地址。  - 禁止以"-"或"."开头及结尾。  - 禁止两个"."相邻（如："my..bucket"）。  - 禁止"."和"-"相邻（如："my-.bucket"和"my.-bucket"）。    - 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。   **默认取值：** 无 |
| origin         | BucketCors     | 必选       | **参数解释：** 预请求指定的跨域请求Origin（通常为域名）。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| requestMethod  | List\<String\> | 必选       | **参数解释：** 实际请求可以带的HTTP方法，可以带多个方法头域。 **约束限制：** 不涉及 **取值范围：** GET、PUT、HEAD、POST 、DELETE 默认取值： 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| requestHeaders | List\<String\> | 可选       | **参数解释：** 实际请求可以带的HTTP头域，可以带多个头域。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
   
#### 返回结果说明
表2OptionsInfoResult 
| **参数名称**        | **参数类型**              | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|
| statusCode      | int                   | **参数解释：** HTTP状态码。 **取值范围：** 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。 完整的状态码列表请参见[状态码](https://support.huaweicloud.com/api-obs/obs_04_0114.html)。 **默认取值：** 无 |
| responseHeaders | Map\<String, Object\> | **参数解释：** HTTP响应消息头列表，由多个元组构成。元组中String代表响应消息头的名称，Object代表响应消息头的值。 **默认取值：** 无                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| allowOrigin     | String                | **参数解释：** 如果请求的Origin满足服务端的CORS配置，则在响应中包含这个Origin。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| allowHeaders    | List\<String\>        | **参数解释：** 如果请求的headers满足服务端的CORS配置，则在响应中包含这个headers。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| maxAge          | int                   | **参数解释：** 服务端CORS配置中的MaxAgeSeconds。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| allowMethods    | List\<String\>        | **参数解释：** 如果请求的Access-Control-Request-Method满足服务端的CORS配置，则在响应中包含这条rule中的Methods。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| exposeHeaders   | List\<String\>        | **参数解释：** 服务端CORS配置中的ExposeHeader。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
   
#### 代码示例
本示例用于预请求examplebucket桶。
```
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.OptionsInfoRequest;
import com.obs.services.model.OptionsInfoResult;
import java.util.Arrays;
import java.util.Collections;
public class OptionsBucket {
    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 exampleBucket = "examplebucket";
            OptionsInfoRequest request = new OptionsInfoRequest(exampleBucket);
            // 预请求指定的跨域请求Origin（通常为域名）
            request.setOrigin("http://www.example.com");
            // 实际请求可以带的HTTP方法，可以带多个方法头域            
            request.setRequestMethod(Arrays.asList("GET", "PUT"));
            // 实际请求可以带的HTTP头域，可以带多个头域
            request.setRequestHeaders(Collections.singletonList("Authorization"));
            OptionsInfoResult result = obsClient.optionsBucket(request);
            System.out.println("OptionsBucket successfully");
            System.out.println("\tAllowOrigin: " + result.getAllowOrigin());
            System.out.println("\tAllowMethods: " + result.getAllowMethods());
            System.out.println("\tAllowHeaders: " + result.getAllowHeaders());
            System.out.println("\tExposeHeaders: " + result.getExposeHeaders());
            System.out.println("\tMaxAge: " + result.getMaxAge());
        } catch (ObsException e) {
            System.out.println("OptionsBucket 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());
            e.printStackTrace();
        } catch (Exception e) {
            System.out.println("OptionsBucket failed");
            // 其他异常信息打印
            e.printStackTrace();
        }
    }
}
```