Alibaba Cloud SDK for Go

If no client is explicitly created before a request, the SDK automatically attempts to create a default client using the following order of precedence:

1. Environment Credentials: Checks for ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables.
2. Credentials File: Looks for a configuration file at ~/.alibabacloud/credentials (or %UserProfile%\.alibabacloud\credentials on Windows). The file path can be overridden by setting the ALIBABA_CLOUD_CREDENTIALS_FILE environment variable.
3. Instance RAM Role: If ALIBABA_CLOUD_ECS_METADATA is set, the SDK uses that value as a role name to fetch temporary credentials from the ECS metadata service (http://100.100.100.200/latest/meta-data/ram/security-credentials/).

You can control whether the SDK verifies SSL certificates for HTTPS requests. This can be configured at both the individual request level and the global client level.

• Enable verification (Default): Set HTTPSInsecure to false. The SDK will use the CA packages provided by your operating system to verify certificates.
• Disable verification (Insecure): Set HTTPSInsecure to true. This disables certificate validation. Warning: This is insecure and should only be used for testing; in production, you should use valid certificates.

Deprecation Notice

The Alibaba Cloud V1.0 Go SDK entered End-of-Support on March 1, 2025 and is no longer recommended for use.

Actions required:

• New users: Use the V2.0 Go SDK directly.
• Existing users: It is advised to migrate from V1.0 to the V2.0 Go SDK.

The V2.0 Go SDK is available at https://github.com/alibabacloud-go. For usage details, refer to the Alibaba Cloud Help Center Documentation.

Alibaba Cloud V1.0 Go SDK is reaching end-of-life on March 1, 2025, and its use is no longer recommended.

• New users: Please use the V2.0 Go SDK directly.
• Existing users: It is highly recommended to migrate to the V2.0 Go SDK.
• V2.0 Repository: https://github.com/alibabacloud-go

For usage details, refer to the Alibaba Cloud Help Center and the Alibaba Cloud OpenAPI Developer Portal.

The SDK follows a specific hierarchy to resolve which endpoint to use for an API call:

1. User Custom Definition: The highest priority. This includes global mappings, request-level Domain settings, or client-level Domain settings.
2. Endpoint Splicing Rules: If VPC is enabled or the product SDK has an endpoint data file, the SDK uses the client.Network setting to splice the endpoint.
3. SDK Core Data File: The SDK searches for endpoint information in the endpoints_config.go file within the Go SDK Core. This is an internal operation and requires no manual configuration.
4. Remote Location Service: If the product SDK includes a ServiceCode, the SDK can request the endpoint from a remote Location Service API.

You can set default timeouts for all requests sent via a specific client. Note that client-level timeouts only apply if the individual request has not already defined its own timeout.

Use SetReadTimeout(duration) and SetConnectTimeout(duration) on the client instance to configure them, and GetReadTimeout() or GetConnectTimeout() to retrieve the current values.

// 设置客户端超时（对所有通过该客户端发送的请求生效）
client.SetReadTimeout(10 * time.Second)             // 设置客户端读超时为10秒
readTimeout := client.GetReadTimeout()              // 获取客户端读超时
client.SetConnectTimeout(5 * time.Second)           // 设置客户端连接超时为5秒
connectTimeout := client.GetConnectTimeout()        // 获取客户端连接超时

To install the SDK using the standard Go toolchain, use the go get command with the -u flag to ensure dependencies are updated.

$ go get -u github.com/aliyun/alibaba-cloud-sdk-go/sdk

To interact with Alibaba Cloud services, you must first sign up for an account and obtain your credentials. Use sdk.NewClientWithAccessKey to initialize the client with your REGION_ID, ACCESS_KEY_ID, and ACCESS_KEY_SECRET.

package main

import "github.com/aliyun/alibaba-cloud-sdk-go/sdk"

func main() {
  client, err := sdk.NewClientWithAccessKey("REGION_ID", "ACCESS_KEY_ID", "ACCESS_KEY_SECRET")
  if err != nil {
    // Handle error
    panic(err)
  }
}

Install the SDK using go get:

go get -u github.com/aliyun/alibaba-cloud-sdk-go/sdk

Requirements:

• A Go environment newer than 1.13.x.