English | 简体中文 | 日本語

Alibaba Cloud SDK for Go

The Alibaba Cloud V1.0 Go SDK has entered End-of-Support (March 1, 2025) and is no longer recommended for use. New users should directly use the V2.0 Go SDK; users who have already integrated the V1.0 Go SDK are also advised to migrate to the V2.0 Go SDK. V2.0 Go SDK is available here: https://github.com/alibabacloud-go, for usage, please refer to Help Center Documentation and [Alibaba Cloud OpenAPI Developer Portal][open-api-portal].

Troubleshoot

Troubleshoot Provide OpenAPI diagnosis service to help developers locate quickly and provide solutions for developers through RequestID or error message.

Online Demo

[Alibaba Cloud OpenAPI Developer Portal][open-api-portal] provides the ability to call the cloud product OpenAPI online, and dynamically generate SDK Example code and quick retrieval interface, which can significantly reduce the difficulty of using the cloud API.

Requirements

• It's necessary for you to make sure your system meet the [Requirements][Requirements], such as installing a Go environment which is new than 1.13.x.

Installation

Use go get to install SDK：

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

Quick Examples

Before you begin, you need to sign up for an Alibaba Cloud account and retrieve your Credentials.

Create Client

package main
import "github.com/aliyun/alibaba-cloud-sdk-go/sdk"
func main() {   client, err := sdk.NewClientWithAccessKey("REGIONID", "ACCESSKEYID", "ACCESSKEY_SECRET")   if err != nil {     // Handle exceptions     panic(err)   } }

ROA Request

package main
import "github.com/aliyun/alibaba-cloud-sdk-go/sdk/requests"
func main() {   request := requests.NewCommonRequest()        // Make a common request   request.Method = "GET"                        // Set request method   request.Product = "CS"                        // Specify product   request.Domain = "cs.aliyuncs.com"            // Location Service will not be enabled if the host is specified. For example, service with aCertification     type-Bearer Token should be specified   request.Version = "2015-12-15"                // Specify product version   request.PathPattern = "/clusters/[ClusterId]" // Specify path rule with ROA-style   request.Scheme = "https"                      // Set request scheme. Default: http   request.ApiName = "DescribeCluster"           // Specify product interface   request.QueryParams["ClusterId"] = "123456"   // Assign values to parameters in the path   request.QueryParams["RegionId"] = "region_id" // Specify the requested regionId, if not specified, use the client regionId, then default regionId   request.TransToAcsRequest()                   // Trans commonrequest to acsRequest, which is used by client. }

RPC Request

package main
import "github.com/aliyun/alibaba-cloud-sdk-go/sdk/requests"
func main() {   request := requests.NewCommonRequest()                // Make a common request   request.Method = "POST"                               // Set request method   request.Product = "Ecs"                               // Specify product   request.Domain = "ecs.aliyuncs.com"                   // Location Service will not be enabled if the host is specified. For example, service with a   Certification type-Bearer Token should be specified   request.Version = "2014-05-26"                        // Specify product version   request.Scheme = "https"                              // Set request scheme. Default: http   request.ApiName = "CreateInstance"                    // Specify product interface   request.QueryParams["InstanceType"] = "ecs.g5.large"  // Assign values to parameters in the path   request.QueryParams["RegionId"] = "region_id"         // Specify the requested regionId, if not specified, use the client regionId, then default regionId   request.TransToAcsRequest()                           // Trans commonrequest to acsRequest, which is used by client. }

Documentation

• Requirements
• Installation
• Client & Credentials
• SSL Verify
• Proxy
• Timeout
• Debug
• Logger
• Concurrent
• Asynchronous Call
• Package Management
• Endpoint

Issues

[Opening an Issue][issue], Issues not conforming to the guidelines may be closed immediately.

Contribution

Please make sure to read the Contributing Guide before making a pull request.

References

• [Alibaba Cloud Regions & Endpoints][endpoints]
• [Alibaba Cloud OpenAPI Developer Portal][open-api-portal]
• [Go][go]
• [Latest Release][latest-release]

License

[SDK]: https://github.com/aliyun/alibaba-cloud-sdk-go [issue]: https://github.com/aliyun/alibaba-cloud-sdk-go/issues/new [open-api-portal]: https://api.alibabacloud.com/ [latest-release]: https://github.com/aliyun/alibaba-cloud-sdk-go/releases [go]: https://golang.org/dl/ [endpoints]: https://developer.aliyun.com/endpoints [Requirements]: docs/0-Requirements-EN.md