This topic describes how to add parameters in an object upload or download request to set the limit of upload or download bandwidth. This ensures sufficient bandwidth for other applications.
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, endpoints and open ports.
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 Initialization.
Sample code
The following sample code provides an example on how to configure single-connection bandwidth throttling for simple upload and download:
package main
import (
"log"
"os"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Failed to create credentials provider: %v", err)
}
options := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
options = append(options, oss.Region("yourRegion"))
options = append(options, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", options...)
if err != nil {
log.Fatalf("Failed to create OSS client: %v", err)
}
bucketName := "examplebucket"
bucket, err := client.Bucket(bucketName)
if err != nil {
log.Fatalf("Failed to get bucket '%s': %v", bucketName, err)
}
localFilePath := "D:\\localpath\\examplefile.txt"
fd, err := os.Open(localFilePath)
if err != nil {
log.Fatalf("Failed to open local file '%s': %v", localFilePath, err)
}
defer fd.Close()
var traffic int64 = 41943040
objectName := "exampledir/exampleobject.txt"
err = bucket.PutObject(objectName, fd, oss.TrafficLimitHeader(traffic))
if err != nil {
log.Fatalf("Failed to upload object '%s': %v", objectName, err)
}
downloadFilePath := "D:\\localpath\\exampleobject.txt"
err = bucket.GetObjectToFile(objectName, downloadFilePath, oss.TrafficLimitHeader(traffic))
if err != nil {
log.Fatalf("Failed to download object '%s' to '%s': %v", objectName, downloadFilePath, err)
}
log.Println("Upload and download completed successfully")
}
Common scenarios
Configure single-connection bandwidth throttling for multipart upload
The following code provides an example on how to configure single-connection bandwidth throttling for multipart upload:
package main
import (
"io"
"log"
"os"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Failed to create credentials provider: %v", err)
}
options := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
options = append(options, oss.Region("yourRegion"))
options = append(options, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", options...)
if err != nil {
log.Fatalf("Failed to create OSS client: %v", err)
}
bucketName := "examplebucket"
bucket, err := client.Bucket(bucketName)
if err != nil {
log.Fatalf("Failed to get bucket '%s': %v", bucketName, err)
}
traffic := int64(41943040)
localFilePath := "localFile"
chunks, err := oss.SplitFileByPartNum(localFilePath, 3)
if err != nil {
log.Fatalf("Failed to split file '%s': %v", localFilePath, err)
}
fd, err := os.Open(localFilePath)
if err != nil {
log.Fatalf("Failed to open local file '%s': %v", localFilePath, err)
}
defer fd.Close()
objectName := "exampledir/exampleobject.txt"
imur, err := bucket.InitiateMultipartUpload(objectName)
if err != nil {
log.Fatalf("Failed to initiate multipart upload for '%s': %v", objectName, err)
}
var parts []oss.UploadPart
for _, chunk := range chunks {
_, err := fd.Seek(chunk.Offset, io.SeekStart)
if err != nil {
log.Fatalf("Failed to seek to offset %d in file '%s': %v", chunk.Offset, localFilePath, err)
}
part, err := bucket.UploadPart(imur, fd, chunk.Size, chunk.Number, oss.TrafficLimitHeader(traffic))
if err != nil {
log.Fatalf("Failed to upload part %d of '%s': %v", chunk.Number, objectName, err)
}
parts = append(parts, part)
}
_, err = bucket.CompleteMultipartUpload(imur, parts)
if err != nil {
log.Fatalf("Failed to complete multipart upload for '%s': %v", objectName, err)
}
log.Println("Multipart upload completed successfully")
}
Configure bandwidth throttling for append upload
The following code provides an example on how to configure single-connection bandwidth throttling for append upload:
package main
import (
"log"
"os"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Failed to create credentials provider: %v", err)
}
options := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
options = append(options, oss.Region("yourRegion"))
options = append(options, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", options...)
if err != nil {
log.Fatalf("Failed to create OSS client: %v", err)
}
bucketName := "examplebucket"
bucket, err := client.Bucket(bucketName)
if err != nil {
log.Fatalf("Failed to get bucket '%s': %v", bucketName, err)
}
traffic := int64(41943040)
localFileOne := "localFileOne"
localFileTwo := "localFileTwo"
fd1, err := os.Open(localFileOne)
if err != nil {
log.Fatalf("Failed to open local file '%s': %v", localFileOne, err)
}
defer fd1.Close()
fd2, err := os.Open(localFileTwo)
if err != nil {
log.Fatalf("Failed to open local file '%s': %v", localFileTwo, err)
}
defer fd2.Close()
objectName := "exampledir/exampleobject.txt"
var nextPos int64
nextPos, err = bucket.AppendObject(objectName, fd1, nextPos, oss.TrafficLimitHeader(traffic))
if err != nil {
log.Fatalf("Failed to append object '%s' from file '%s': %v", objectName, localFileOne, err)
}
nextPos, err = bucket.AppendObject(objectName, fd2, nextPos, oss.TrafficLimitHeader(traffic))
if err != nil {
log.Fatalf("Failed to append object '%s' from file '%s': %v", objectName, localFileTwo, err)
}
log.Println("Append upload completed successfully")
}
Configure bandwidth throttling for upload and download that use signed URLs
The following sample code provides an example on how to configure single-connection bandwidth throttling when you use signed URLs to upload or download objects:
package main
import (
"log"
"os"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Failed to create credentials provider: %v", err)
}
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", clientOptions...)
if err != nil {
log.Fatalf("Failed to create OSS client: %v", err)
}
bucketName := "examplebucket"
bucket, err := client.Bucket(bucketName)
if err != nil {
log.Fatalf("Failed to get bucket '%s': %v", bucketName, err)
}
localFilePath := "D:\\localpath\\exampleobject.txt"
fd, err := os.Open(localFilePath)
if err != nil {
log.Fatalf("Failed to open local file '%s': %v", localFilePath, err)
}
defer fd.Close()
traffic := int64(41943040)
objectName := "exampledir/exampleobject.txt"
strURL, err := bucket.SignURL(objectName, oss.HTTPPut, 60, oss.TrafficLimitParam(traffic))
if err != nil {
log.Fatalf("Failed to generate signed URL for uploading '%s': %v", objectName, err)
}
err = bucket.PutObjectWithURL(strURL, fd)
if err != nil {
log.Fatalf("Failed to upload object '%s': %v", objectName, err)
}
strURL, err = bucket.SignURL(objectName, oss.HTTPGet, 60, oss.TrafficLimitParam(traffic))
if err != nil {
log.Fatalf("Failed to generate signed URL for downloading '%s': %v", objectName, err)
}
downloadFilePath := "D:\\localpath\\exampleobject.txt"
err = bucket.GetObjectToFileWithURL(strURL, downloadFilePath)
if err != nil {
log.Fatalf("Failed to download object '%s' to '%s': %v", objectName, downloadFilePath, err)
}
log.Println("Upload and download completed successfully")
}
References
For more information about the API operation that you can call to upload an object, see PutObject.
For more information about the API operation that you can call to download objects, see GetObjectToFile.