Creating a Signed URL (SDK for Go)
Function
This API creates a URL whose Query parameters are carried with authentication information by specifying the AK and SK, HTTP method, and request parameters. You can provide other users with this URL for temporary access. When generating a URL, you need to specify the validity period of the URL to restrict the access duration of visitors.
If you want to grant other users the permission to perform other operations on buckets or objects (for example, upload or download objects), generate a URL with the corresponding request (for example, to upload an object using the URL that generates the PUT request) and provide the URL for other users.
Restrictions
- If a CORS or signature mismatch error occurs, refer to the following steps to troubleshoot the issue:
- If CORS is not configured, you need to configure CORS rules on OBS Console. For details, see Configuring CORS.
- If the signatures do not match, check whether signature parameters are correct. For details, see Authentication of Signature in a URL. For example, during an object upload, the backend uses Content-Type to calculate the signature and generate an authorized URL, but if Content-Type is not set or is set to an incorrect value when the frontend uses the authorized URL, a CORS error occurs. To avoid this issue, ensure that Content-Type fields at both the frontend and backend are kept consistent.
Method
func (obsClient ObsClient) CreateSignedUrl(input *CreateSignedUrlInput) (output *CreateSignedUrlOutput, err error)
Request Parameters
Parameter |
Type |
Mandatory (Yes/No) |
Description |
---|---|---|---|
input |
Yes |
Explanation: Input parameters for creating a signed URL. For details, see Table 2. |
Parameter |
Type |
Mandatory (Yes/No) |
Description |
---|---|---|---|
Method |
Yes |
Explanation: HTTP method. For details, see Table 3. |
|
Bucket |
string |
No |
Explanation: Bucket name Restrictions:
Default value: None |
Key |
string |
No |
Explanation: Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name. For example, if the address for accessing the object is examplebucket.obs.eu-west-101.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt. Value range: The value must contain 1 to 1,024 characters. Default value: None |
SubResource |
No |
Explanation: Type of the subresource to access. For details, see Table 4. |
|
Expires |
int |
No |
Explanation: Expiration time of the signed URL Value range: 0 to (231 – 1), in seconds Default value: 300 |
Headers |
map[string]string |
No |
Explanation: Headers in the request Default value: None |
QueryParams |
map[string]string |
No |
Explanation: Query parameters in the request Default value: None |
Constant |
Default Value |
Description |
---|---|---|
HttpMethodGet |
GET |
HTTP GET request |
HttpMethodPut |
POST |
HTTP POST request |
HttpMethodPost |
PUT |
HTTP PUT request |
HttpMethodDelete |
DELETE |
HTTP DELETE request |
HttpMethodHead |
HEAD |
HTTP HEAD request |
HttpMethodOptions |
OPTIONS |
HTTP OPTIONS request |
Constant |
Default Value |
Applicable API |
---|---|---|
SubResourceStoragePolicy |
storagePolicy |
Sets or obtains bucket storage classes. |
SubResourceQuota |
quota |
Sets or obtains bucket quotas. |
SubResourceStorageInfo |
storageinfo |
Obtains bucket storage information. |
SubResourceLocation |
location |
Obtains bucket locations. |
SubResourceAcl |
acl |
Sets or obtains bucket ACLs or object ACLs. |
SubResourcePolicy |
policy |
Sets, obtains, or deletes bucket policies. |
SubResourceCors |
cors |
Sets, obtains, or deletes bucket CORS configurations. |
SubResourceVersioning |
versioning |
Sets or obtains bucket version statuses. |
SubResourceWebsite |
website |
Sets, obtains, or deletes bucket website configurations. |
SubResourceLogging |
logging |
Sets or obtains bucket logging settings. |
SubResourceLifecycle |
lifecycle |
Sets, obtains, or deletes lifecycle rules of buckets. |
SubResourceNotification |
notification |
Sets or obtains the notification configuration of buckets. |
SubResourceTagging |
tagging |
Sets, obtains, or deletes bucket tags. |
SubResourceDelete |
delete |
Batch deletes objects. |
SubResourceVersions |
versions |
Lists versioning objects in buckets. |
SubResourceUploads |
uploads |
Lists or initializes multipart uploads in buckets. |
SubResourceRestore |
restore |
Restores Archive objects. |
Responses
Parameter |
Type |
Description |
---|---|---|
output |
Explanation: Returned results. For details, see Table 6. |
|
err |
error |
Explanation: Error messages returned by the API |
Code Example
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 |
package main import ( "fmt" "net/http" "os" obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/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. For details, see https://support.huaweicloud.com/eu/usermanual-ca/ca_01_0003.html. 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 corresponding to the bucket. EU-Dublin is used here as an example. Replace it with the one currently in use. endPoint := "https://obs.eu-west-101.myhuaweicloud.eu" // 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()) } putObjectInput := &obs.CreateSignedUrlInput{} putObjectInput.Method = obs.HttpMethodPut putObjectInput.Bucket = "examplebucket" putObjectInput.Key = "example/objectname" putObjectInput.Expires = 3600 // Create a signed URL for uploading an object. putObjectOutput, err := obsClient.CreateSignedUrl(putObjectInput) if err != nil { fmt.Println(err) return } fmt.Printf("SignedUrl:%s\n", putObjectOutput.SignedUrl) fmt.Printf("ActualSignedRequestHeaders:%v\n", putObjectOutput.ActualSignedRequestHeaders) // Call the signed URL. payload := strings.NewReader("hello OBS!") req, err := http.NewRequest("PUT", putObjectOutput.SignedUrl, payload) req.Header = putObjectOutput.ActualSignedRequestHeaders if err != nil { fmt.Printf("Create request error, errMsg: %s", err.Error()) return } response, err := http.DefaultClient.Do(req) if err == nil { fmt.Printf("Use signed-url successful!\n") fmt.Printf("Status:%s,Etag:%s\n", response.Status, response.Header.Get("Etag")) return } fmt.Printf("Use signed-url successful!\n") 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) } |
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 59 60 61 62 63 64 65 |
package main import ( "fmt" "net/http" "os" obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/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. For details, see https://support.huaweicloud.com/eu/usermanual-ca/ca_01_0003.html. 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 corresponding to the bucket. EU-Dublin is used here as an example. Replace it with the one currently in use. endPoint := "https://obs.eu-west-101.myhuaweicloud.eu" // 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()) } getObjectInput := &obs.CreateSignedUrlInput{} getObjectInput.Method = obs.HttpMethodGet getObjectInput.Bucket = "examplebucket" getObjectInput.Key = "example/objectname" getObjectInput.Expires = 3600 // Create a signed URL for downloading an object. getObjectOutput, err := obsClient.CreateSignedUrl(getObjectInput) if err != nil { fmt.Println(err) return } fmt.Printf("SignedUrl:%s\n", getObjectOutput.SignedUrl) fmt.Printf("ActualSignedRequestHeaders:%v\n", getObjectOutput.ActualSignedRequestHeaders) // Call the signed URL. req, err := http.NewRequest("GET", getObjectOutput.SignedUrl, nil) req.Header = getObjectOutput.ActualSignedRequestHeaders if err != nil { fmt.Printf("Create request error, errMsg: %s", err.Error()) return } response, err := http.DefaultClient.Do(req) if err == nil { fmt.Printf("Use signed-url successful!\n") fmt.Printf("Status:%s,Etag:%s\n", response.Status, response.Header.Get("Etag")) p := make([]byte, 1024) var readErr error var readCount int // Read the object content. for { readCount, readErr = response.Body.Read(p) if readCount > 0 { fmt.Printf("%s", p[:readCount]) } if readErr != nil { break } } return } fmt.Printf("Use signed-url successful!\n") 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) } |
This example creates a signed URL for deleting an object.
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 |
package main import ( "fmt" "net/http" "os" obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/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. For details, see https://support.huaweicloud.com/eu/usermanual-ca/ca_01_0003.html. 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 corresponding to the bucket. EU-Dublin is used here as an example. Replace it with the one currently in use. endPoint := "https://obs.eu-west-101.myhuaweicloud.eu" // 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()) } // Create a signed URL for deleting an object. deleteObjectInput := &obs.CreateSignedUrlInput{} deleteObjectInput.Method = obs.HttpMethodDelete deleteObjectInput.Bucket = "examplebucket" deleteObjectInput.Key = "example/objectname" deleteObjectInput.Expires = 3600 deleteObjectOutput, err := obsClient.CreateSignedUrl(deleteObjectInput) if err != nil { fmt.Println(err) return } fmt.Printf("SignedUrl:%s\n", deleteObjectOutput.SignedUrl) fmt.Printf("ActualSignedRequestHeaders:%v\n", deleteObjectOutput.ActualSignedRequestHeaders) // Call the signed URL. req, err := http.NewRequest("DELETE", deleteObjectOutput.SignedUrl, nil) req.Header = deleteObjectOutput.ActualSignedRequestHeaders if err != nil { fmt.Printf("Create request error, errMsg: %s", err.Error()) return } response, err := http.DefaultClient.Do(req) if err == nil { fmt.Printf("Use signed-url successful!\n") fmt.Printf("Status:%s\n", response.Status) return } fmt.Printf("Use signed-url successful!\n") 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.