Transfer acceleration improves access speed to OSS for users around the world. This feature is suitable for long-distance data transfer and for uploading or downloading large files in the gigabyte (GB) or terabyte (TB) range.
Usage notes
In this topic, the public endpoint of the China (Hangzhou) region is used. If you want to access OSS from other Alibaba Cloud services in the same region as OSS, use an internal endpoint. For more information about OSS regions and endpoints, see Regions and endpoints.
In this topic, access credentials are obtained from environment variables. For more information about how to configure access credentials, see Configure access credentials.
In this topic, an OSSClient instance is created by using an OSS endpoint. If you want to create an OSSClient instance by using custom domain names or Security Token Service (STS), see Configure OSSClient instances.
Sample code
Enable transfer acceleration
The following code shows how to enable transfer acceleration for the bucket named examplebucket:
package main
import (
"log"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are set.
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Error: %v", err)
}
// Create an OSSClient instance.
// Set yourEndpoint to the endpoint of the bucket. For example, for a bucket in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. For other regions, use the actual endpoint.
// Set yourRegion to the region where the bucket is located. For example, for a bucket in the China (Hangzhou) region, set the region to cn-hangzhou. For other regions, use the actual region.
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
// Set the signature version.
clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", clientOptions...)
if err != nil {
log.Fatalf("Error: %v", err)
}
// Specify the bucket name.
bucketName := "examplebucket"
// Enable transfer acceleration for the bucket.
// The Enabled parameter specifies whether to enable transfer acceleration. Set the value to true to enable transfer acceleration or false to disable it.
accConfig := oss.TransferAccConfiguration{
Enabled: true,
}
err = client.SetBucketTransferAcc(bucketName, accConfig)
if err != nil {
log.Fatalf("Error: %v", err)
}
// Print a success message.
log.Println("Set bucket transfer accelerate success")
}
Query the transfer acceleration status
The following code shows how to query the transfer acceleration status of the bucket named examplebucket:
package main
import (
"log"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
// Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are set.
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Error: %v", err)
}
// Create an OSSClient instance.
// Set yourEndpoint to the endpoint of the bucket. For example, for a bucket in the China (Hangzhou) region, set the endpoint to https://oss-cn-hangzhou.aliyuncs.com. For other regions, use the actual endpoint.
// Set yourRegion to the region where the bucket is located. For example, for a bucket in the China (Hangzhou) region, set the region to cn-hangzhou. For other regions, use the actual region.
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
// Set the signature version.
clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", clientOptions...)
if err != nil {
log.Fatalf("Error: %v", err)
}
// Specify the bucket name.
bucketName := "examplebucket"
// Query the transfer acceleration status of the destination bucket.
accConfig, err := client.GetBucketTransferAcc(bucketName)
if err != nil {
log.Fatalf("Error: %v", err)
}
// Print the transfer acceleration status.
log.Printf("accConfig.Enabled: %t", accConfig.Enabled)
}
References
For more information about the API operation to enable transfer acceleration, see SetBucketTransferAcc.
For more information about the API operation to query the transfer acceleration status, see GetBucketTransferAcc.