Object Storage Service:Error handling (Go SDK V1)

Client-side errors

If a call made by the Go SDK fails, it returns an error interface. This interface is defined as follows:

type error interface {
    Error() string
}

Other errors inherit from this interface. For example, the error that is returned when an HTTP request fails is defined as follows:

//net.Error 
type Error interface {
    error
    Timeout() bool   // Is the error a timeout
    Temporary() bool // Is the error temporary
}

Server-side errors

If a request made by the OSS Go SDK fails, an error is returned. For issues such as HTTP request or I/O errors, a custom Go error is returned. If an error occurs on the OSS server, the following error is returned. This error implements the Error interface.

type ServiceError struct {
    Code       string    // The error code returned by OSS.
    Message    string    // The detailed error message from OSS.
    RequestId  string    // The universally unique identifier (UUID) that uniquely identifies the request.
    HostId     string    // The ID of the OSS cluster that is accessed.
    StatusCode int       // The HTTP status code.
}

If the HTTP status code returned by OSS does not match the expected code, the following error is returned. This error also implements the Error interface.

type UnexpectedStatusCodeError struct {
    allowed []int    // The expected HTTP status codes from OSS.
    got     int      // The actual HTTP status code returned by OSS.
}

Error handling example

The following code shows how to handle errors:

package main

import (
	"fmt"
	"os"
	"strings"

	"github.com/aliyun/aliyun-oss-go-sdk/oss"
)

// The error handling function.
func HandleError(err error) {
	fmt.Println("Error:", err)
	os.Exit(-1)
}
func main() {
	/// Obtain access credentials from environment variables. Before you run this 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 {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}

	// Create an OSSClient instance.
	// Set yourEndpoint to the endpoint of the bucket. For example, for the China (Hangzhou) region, use 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 the China (Hangzhou) region, use cn-hangzhou. For other regions, use the actual region ID.
	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 {
		HandleError(err)
	}
	// Specify the bucket name, for example, examplebucket.
	bucketName := "examplebucket"
	// Specify the object name, for example, exampleobject.txt.
	objectName := "exampleobject.txt"

	bucket, err := client.Bucket(bucketName)
	if err != nil {
		HandleError(err)
	}
	// Upload a string.
	err = bucket.PutObject(objectName, strings.NewReader("Hello OSS"))
	if err != nil {
		HandleError(err)
	}
}

OSS error codes

The following table lists the OSS error codes.