Obtaining the Region of a Bucket (SDK for Go)
Function
This API returns the region of a bucket.
Restrictions
- To obtain the region of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketLocation in IAM or GetBucketLocation in a bucket policy).
Method
func (obsClient ObsClient) GetBucketLocation(bucketName string) (output *GetBucketLocationOutput, err error)
Request Parameters
|
Parameter |
Type |
Mandatory (Yes/No) |
Description |
|---|---|---|---|
|
bucketName |
string |
Yes |
Explanation: Bucket name Restrictions:
Default value: None |
Responses
|
Parameter |
Type |
Description |
|---|---|---|
|
output |
Explanation: Returned results. For details, see Table 3. |
|
|
err |
error |
Explanation: Error messages returned by the API |
|
Parameter |
Type |
Description |
|---|---|---|
|
StatusCode |
int |
Explanation: HTTP status code Value range: A status code is a group of digits that can be 2xx (indicating successes) or 4xx or 5xx (indicating errors). It indicates the status of a response. Default value: None |
|
RequestId |
string |
Explanation: Request ID returned by the OBS server Default value: None |
|
ResponseHeaders |
map[string][]string |
Explanation: HTTP response headers Default value: None |
|
Location |
string |
Explanation: Region where a bucket is located |
Code Examples
This example returns the region where bucket examplebucket locates.
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 |
package main import ( "fmt" "os" "obs-sdk-go/obs" ) func main() { //Obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways. Using hard coding may result in leakage. //Obtain an AK/SK pair on the management console. ak := os.Getenv("AccessKeyID") sk := os.Getenv("SecretAccessKey") // (Optional) If you use a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding to reduce leakage risks. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways. // securityToken := os.Getenv("SecurityToken") // Enter the endpoint of the region where the bucket locates. endPoint := "https://your-endpoint" // Create an obsClient instance. // If you use a temporary AK/SK pair and a security token to access OBS, use the obs.WithSecurityToken method to specify a security token when creating an instance. obsClient, err := obs.New(ak, sk, endPoint/*, obs.WithSecurityToken(securityToken)*/) if err != nil { fmt.Printf("Create obsClient error, errMsg: %s", err.Error()) } // Specify a bucket name. bucketname := "examplebucket" // Obtain the bucket region. output, err := obsClient.GetBucketLocation(bucketname) if err == nil { fmt.Printf("Get bucket(%s)'s location successful!\n", bucketname) fmt.Printf("RequestId:%s\n", output.RequestId) fmt.Printf("Location:%s\n", output.Location) return } fmt.Printf("Get bucket(%s)'s location fail!\n", bucketname) if obsError, ok := err.(obs.ObsError); ok { fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.") fmt.Println(obsError.Error()) } else { fmt.Println("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.") fmt.Println(err) } } |
Feedback
Was this page helpful?
Provide feedbackThank 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