README_zh.md 5.9 KB

English | 简体中文

Alibaba Cloud Client for Go

Latest Stable Version License
codecov Travis Build Status Appveyor Build Status Codacy Badge Go Report Card

Alibaba Cloud Client for Go 是帮助 Go 开发者管理凭据、发送请求的客户端工具, Alibaba Cloud SDK for Go 由本工具提供底层支持。

在线示例

API Explorer 提供在线调用阿里云产品,并动态生成 SDK 代码和快速检索接口等能力,能显著降低使用云 API 的难度。

环境要求

  • 您的系统需要达到 [环境要求][Requirements], 例如,安装了不低于 1.10.x 版本的 Go 环境。

Installation

使用 go get 下载安装 SDK

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

如果您使用了 glide 管理依赖,您也可以使用 glide 来安装阿里云GO SDK

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

另外,阿里云 Go SDK 也会发布在 https://develop.aliyun.com/tools/sdk#/go 这个地址。

快速使用

在您开始之前,您需要注册阿里云帐户并获取您的凭证

创建客户端

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 exceptions
		panic(err)
	}
}

ROA 请求

package main

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

func main() {
	request := requests.NewCommonRequest()        // 构造一个公共请求
	request.Method = "GET"                        // 设置请求方式
	request.Product = "CS"                        // 指定产品
	request.Domain = "cs.aliyuncs.com"            // 指定域名则不会寻址,如认证方式为 Bearer Token 的服务则需要指定
	request.Version = "2015-12-15"                // 指定产品版本
	request.PathPattern = "/clusters/[ClusterId]" // 指定ROA风格路径规则
	request.ApiName = "DescribeCluster"           // 指定接口名
	request.QueryParams["ClusterId"] = "123456"   // 设置参数值
	request.QueryParams["RegionId"] = "region_id" // 指定请求的区域,不指定则使用客户端区域、默认区域
	request.TransToAcsRequest()                   // 把公共请求转化为acs请求
}

RPC 请求

package main

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

func main() {
	request := requests.NewCommonRequest()                // 构造一个公共请求
	request.Method = "POST"                               // 设置请求方式
	request.Product = "Ecs"                               // 指定产品
	request.Domain = "ecs.aliyuncs.com"                   // 指定域名则不会寻址,如认证方式为 Bearer Token 的服务则需要指定
	request.Version = "2014-05-26"                        // 指定产品版本
	request.ApiName = "CreateInstance"                    // 指定接口名
	request.QueryParams["InstanceType"] = "ecs.g5.large"  // 设置参数值
	request.QueryParams["RegionId"] = "region_id"         // 指定请求的区域,不指定则使用客户端区域、默认区域
	request.TransToAcsRequest()                           // 把公共请求转化为acs请求
}

文档

问题

提交 Issue 不符合指南的问题可能会立即关闭。

贡献

提交 Pull Request 之前请阅读贡献指南

相关

许可证

FOSSA Status