Sending an OPTIONS Request to a Bucket (SDK for Java)
Function
OPTIONS refers to pre-requests that clients send to servers. A client usually sends such requests to check whether it has permissions to perform operations on a server. Only after a pre-request is successfully responded, the client starts to execute subsequent requests.
OBS can store static website resources in buckets to make buckets website resources. In this case, OBS buckets serve as servers that process pre-requests from clients.
OBS can process OPTIONS pre-requests only after CORS is configured for buckets in OBS. For details about CORS, see Configuring a CORS Rule (SDK for Java).
If you have any questions during development, post them on the Issues page of GitHub.
Restrictions
- The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.
Method
obsClient.optionsBucket(OptionsInfoRequest request)
Request Parameters
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| bucketName | String | Yes | Explanation: Bucket name Restrictions:
Default value: None |
| origin | BucketCors | Yes | Explanation: Origin of the cross-domain request specified in the pre-request. It is usually a domain name. Restrictions: N/A Value range: N/A Default value: None |
| requestMethod | List<String> | Yes | Explanation: HTTP methods that can be contained in a request. The request can contain multiple method headers. Restrictions: N/A Value range: GET, PUT, HEAD, POST, and DELETE Default value: None |
| requestHeaders | List<String> | No | Explanation: HTTP headers that can be contained in a request. The request can contain multiple headers. Restrictions: N/A Value range: N/A Default value: None |
Responses
| Parameter | Type | Description |
|---|---|---|
| statusCode | int | Explanation: HTTP status code Value range: A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors). For more information, see Status Code. Default value: None |
| responseHeaders | Map<String, Object> | Explanation: HTTP response header list, composed of tuples. In a tuple, the String key indicates the name of the header, and the Object value indicates the value of the header. Default value: None |
| allowOrigin | String | Explanation: If the origin of a request meets server CORS configuration requirements, the response contains the origin. |
| allowHeaders | List<String> | Explanation: If the headers of a request meet server CORS configuration requirements, the response contains the headers. |
| maxAge | int | Explanation: MaxAgeSeconds in the CORS configuration of a server |
| allowMethods | List<String> | Explanation: If the Access-Control-Request-Method of a request meets server CORS configuration requirements, the response contains the methods in the rule. |
| exposeHeaders | List<String> | Explanation: ExposeHeader in the CORS configuration of a server |
Sample Code
This example pre-requests the bucket 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 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 | import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.OptionsInfoRequest; import com.obs.services.model.OptionsInfoResult; public class OptionsBucket { public static void main(String[] args) { // Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage. // Obtain an AK/SK pair on the management console. String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // (Optional) If you are using a temporary AK/SK pair and a security token to access OBS, you are not advised to use hard coding, which may result in information leakage. // Obtain an AK/SK pair and a security token using environment variables or import them in other ways. // String securityToken = System.getenv("SECURITY_TOKEN"); // Enter the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use. String endPoint = "https://obs.ap-southeast-1.myhuaweicloud.com"; // Obtain an endpoint using environment variables or import it in other ways. //String endPoint = System.getenv("ENDPOINT"); // Create an ObsClient instance. // Use a permanent AK/SK pair to initialize the client. ObsClient obsClient = new ObsClient(ak, sk, endPoint); // Use a temporary AK/SK pair and security token to initialize the client. // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); try { String exampleBucket = "exampleBucket"; OptionsInfoRequest request = new OptionsInfoRequest(exampleBucket); // Specify the origin (usually a domain name) of the cross-origin request. request.setOrigin("http://www.example.com"); // HTTP methods allowed in the request. Multiple methods are allowed. request.setRequestMethod(Arrays.asList("GET", "PUT")); // HTTP header allowed in the request. Multiple headers are allowed. 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"); // Request failed. Print the HTTP status code. System.out.println("HTTP Code:" + e.getResponseCode()); // Request failed. Print the server-side error code. System.out.println("Error Code:" + e.getErrorCode()); // Request failed. Print the error details. System.out.println("Error Message:" + e.getErrorMessage()); // Request failed. Print the request 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"); // Print other error information. e.printStackTrace(); } } } |
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot