On this page

Functions
Request Syntax
Request Parameters
Request Headers
Request Elements
Response Syntax
Response Headers
Response Elements
Error Responses
Sample Request
Sample Response

Show all

Help Center/ Object Storage Service/ API Reference (ME-Abu Dhabi Region)/ APIs/ Static Website Hosting/ Obtaining the CORS Configuration of a Bucket

Obtaining the CORS Configuration of a Bucket

Updated on 2024-01-02 GMT+08:00

View PDF

Functions

You can perform this operation to obtain CORS configuration information about a specified bucket.

To perform this operation, you must have the GetBucketCORS permission. By default, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.

Request Syntax

GET /?cors HTTP/1.1 
Host: bucketname.obs.region.example.com
Date: date
Authorization: authorization

Request Parameters

This request contains no message parameters.

Request Headers

This request uses common headers. For details, see Table 3.

Request Elements

This request involves no elements.

Response Syntax

HTTP/1.1 status_code
Content-Type:  application/xml 
Date: date
Content-Length: length

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<CORSConfiguration xmlns="http://obs.region.example.com/doc/2015-06-30/">
    <CORSRule> 
        ... 
    </CORSRule> 
</CORSConfiguration>

Response Headers

The response to the request uses common headers. For details, see Table 1.

Response Elements

This response contains elements to detail the configuration. Table 1 describes the elements.

**Table 1** CORS configuration elements
Element	Description
CORSConfiguration	Root node of CORSRules and its capacity cannot exceed 64 KB. Type: container Ancestor: none
CORSRule	CORS rule. CORSConfiguration can contain a maximum of 100 rules. Type: container Ancestor: CORSConfiguration
ID	Unique identifier of a rule. The value can contain a maximum of 255 characters. Type: string Ancestor: CORSRule
AllowedMethod	Method allowed by a CORS rule. Type: string Value options: GET, PUT, HEAD, POST, DELETE Ancestor: CORSRule
AllowedOrigin	Indicates an origin that is allowed by a CORS rule. It is a character string and can contain a wildcard (), and allows one wildcard character () at most. Type: string Ancestor: CORSRule
AllowedHeader	Indicates which headers are allowed in a PUT Bucket CORS request via the Access-Control-Request-Headers header. If a request contains Access-Control-Request- Headers, only a CORS request that matches the configuration of AllowedHeader is considered as a valid request. Each AllowedHeader can contain at most one wildcard (*) and cannot contain spaces. Type: string Ancestor: CORSRule
MaxAgeSeconds	Response time of CORS that can be cached by a client. It is expressed in seconds. Each CORSRule can contain only one MaxAgeSeconds. It can be set to a negative value. Type: integer Ancestor: CORSRule
ExposeHeader	Indicates a supplemented header in CORS responses. The header provides additional information for clients. It cannot contain spaces. Type: string Ancestor: CORSRule

Error Responses

Table 2 describes possible special errors in this request.

**Table 2** Special error
Error Code	Description	HTTP Status Code
NoSuchCORSConfiguration	Indicates that the CORS configuration of buckets does not exist.	404 Not Found

For other errors, see Table 2.

Sample Request

GET /?cors HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.region.example.com
Accept: */*
Date: WED, 01 Jul 2015 03:54:36 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:WJGghTrPQQXRuCx5go1fHyE+Wwg=

Sample Response

HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BF2600000164363593F10738B80CACBE
x-obs-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSpngvwC5TskcLGh7Fz5KRmCFIayuY8p
Content-Type: application/xml
Date: WED, 01 Jul 2015 03:54:36 GMT
Content-Length: 825

<?xml version="1.0" encoding="utf-8"?> 
<CORSConfiguration xmlns="http://obs.region.example.com/doc/2015-06-30/">
  <CORSRule> 
    <ID>783fc6652cf246c096ea836694f71855</ID>  
    <AllowedMethod>POST</AllowedMethod>  
    <AllowedMethod>GET</AllowedMethod>  
    <AllowedMethod>HEAD</AllowedMethod>  
    <AllowedMethod>PUT</AllowedMethod>  
    <AllowedMethod>DELETE</AllowedMethod>  
 
    <AllowedOrigin>obs.example.com</AllowedOrigin>  
    <AllowedOrigin>www.example.com</AllowedOrigin>  
    <AllowedHeader>AllowedHeader_1</AllowedHeader>  
    <AllowedHeader>AllowedHeader_2</AllowedHeader>  
    <MaxAgeSeconds>100</MaxAgeSeconds>  
    <ExposeHeader>ExposeHeader_1</ExposeHeader>  
    <ExposeHeader>ExposeHeader_2</ExposeHeader> 
  </CORSRule>
</CORSConfiguration>

Parent topic: Static Website Hosting

Previous topic: Configuring Bucket CORS

Next topic: Deleting the CORS Configuration of a Bucket

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

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.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot