Go SDK使用说明
物联网平台提供Go语言的云端SDK供开发人员使用。本文介绍云端Go SDK的安装和配置,及使用Go SDK调用云端API的示例。
安装SDK
安装Go开发环境。
目前支持Go 1.13.0及以上版本。请访问Go官网获取。
Go安装完毕后,新建系统变量GOPATH,并将其指向您的代码目录。
了解更多GOPATH相关信息,请执行命令
go help gopath
。执行以下命令安装阿里云Go SDK,通过Go mod来管理项目依赖。
说明以下命令默认安装新版本的SDK。如果要指定版本,需在命令后加上版本号,例如
@v3.0.0
。Go SDK的历史版本信息,请参见SDK的Code。了解Go SDK详细信息,请访问alibabacloud-go-sdk。
Go SDK安装路径默认为 $GOPATH/src/github.com/alibabacloud-go/iot-20180120,$GOPATH可以通过命令
go env GOPATH
查看。若Go SDK依赖包缺少,可执行命令
go mod tidy
拉取。
go get github.com/alibabacloud-go/iot-20180120/v3
初始化SDK
创建对象config,存放SDK初始化信息(AccessKey ID、AccessKey Secret、地域ID等)。
通过
iot.NewClient(config)
方法加载SDK信息,创建客户端实例,完成SDK客户端初始化。
以华东2(上海)地域及其服务接入地址为例,初始代码如下。实际场景设置中,需使用您的物联网平台服务所在地域。
import (
iot "github.com/alibabacloud-go/iot-20180120/v3/client"
openapi "github.com/alibabacloud-go/darabonba-openapi/client"
env "github.com/alibabacloud-go/darabonba-env/client"
"github.com/alibabacloud-go/tea/tea"
)
func CreateClient (accessKeyId *string, accessKeySecret *string) (_result *iot.Client, _err error) {
config := &openapi.Config{}
// 您的AccessKey ID。
config.AccessKeyId = accessKeyId
// 您的AccessKey Secret。
config.AccessKeySecret = accessKeySecret
// 您的可用区ID。
config.RegionId = tea.String("cn-shanghai")
_result = &iot.Client{}
_result, _err = iot.NewClient(config)
return _result, _err
}
参数 | 说明 |
AccessKeyId | 您阿里云账号的AccessKey ID。 您可在阿里云官网控制台AccessKey管理中创建或查看您的AccessKey。 |
AccessKeySecret | 您阿里云账号的AccessKey Secret。 |
RegionId | 您的物联网平台服务的地域ID,用于拼接服务接入地址,格式为:iot.${RegionId}.aliyuncs.com。 您可在物联网平台控制台左上方,查看当前服务所在地域。 地域ID的表达方法,请参见支持的地域。 |
SDK客户端的HTTP请求配置、代理配置、超时机制、重试机制等配置方式,请参见阿里云升级版Go SDK使用指南。
发起调用
物联网平台云端SDK为每个API封装两个类,分别命名为${API名称}+"Request"
和${API名称}+"Response"
,分别用于承载API的调用请求和调用结果。
调用步骤
已完成SDK客户端初始化。具体内容,请参见初始化SDK。
创建对应API的调用请求,生成
${API名称}+"Request"
类对象实例request。通过对象实例request,使用
request.${请求参数的名称}
方法,设置API所需的请求参数值。创建
${API名称}+"Response"
类的对象实例response承载响应结果:使用Client对象实例client的${API名称}(request)
方法,获取API对应request的响应结果,包含服务端响应的body和headers。
物联网平台云端API,请参见API列表。有关request中请求参数说明,及response中返回参数说明,请参见对应API文档。
本文以调用Pub接口发布消息到Topic为例。请求参数信息,请参见Pub。
以下代码中${iotInstanceId}
为实例ID值。您可在物联网平台控制台的实例概览页面,查看当前实例的ID值。
若有ID值,必须传入该ID值,否则调用API会失败。
若无实例概览页面或ID值,则无需传入ID值。您需删除IotInstanceId相关的请求代码,或传入空值
""
,否则调用API会失败。
实例的详细说明,请参见实例概述。购买实例方法,请参见购买企业版实例。常见问题,请参见物联网平台实例相关问题。
request := &iot.PubRequest{
// 物联网平台实例ID。
IotInstanceId: tea.String("${iotInstanceId}"),
// 产品ProductKey。
ProductKey: tea.String("${productKey}"),
// 要发送的消息主体,hello world Base64 String。
MessageContent: tea.String(base64.StdEncoding.EncodeToString([]byte("hello world"))),
// 要接收消息的设备的自定义Topic。
TopicFullName: tea.String("/${productKey}/${deviceName}/user/get"),
// 指定消息的发送方式,支持QoS0和QoS1。
Qos: tea.Int32(0),
}
response, _err := client.Pub(request)
if _err != nil {
fmt.Print(_err.Error())
}
fmt.Printf("response is %#v\n", response)
完整代码示例
实际场景中,请参照上文的参数说明,替换对应参数值。
package main
import (
"encoding/base64"
"fmt"
"os"
iot "github.com/alibabacloud-go/iot-20180120/v2/client"
util "github.com/alibabacloud-go/tea-utils/service"
openapi "github.com/alibabacloud-go/darabonba-openapi/client"
console "github.com/alibabacloud-go/tea-console/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* 使用AK&SK初始化账号Client
* @param accessKeyId
* @param accessKeySecret
* @param regionId
* @return Client
* @throws Exception
*/
func CreateClient (accessKeyId *string, accessKeySecret *string) (_result *iot.Client, _err error) {
config := &openapi.Config{}
// 您的AccessKey ID。
config.AccessKeyId = accessKeyId
// 您的AccessKey Secret。
config.AccessKeySecret = accessKeySecret
// 您的可用区ID。
config.RegionId = tea.String("cn-shanghai")
_result = &iot.Client{}
_result, _err = iot.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
client, _err := CreateClient(tea.String("${accessKey}"), tea.String("${accessKeySecret}"))
if _err != nil {
return _err
}
request := &iot.PubRequest{
// 物联网平台实例ID。
IotInstanceId: tea.String("${iotInstanceId}"),
// 产品ProductKey。
ProductKey: tea.String("${productKey}"),
// 要发送的消息主体,hello world Base64 String。
MessageContent: tea.String(base64.StdEncoding.EncodeToString([]byte("hello world"))),
// 要接收消息的设备的自定义Topic。
TopicFullName: tea.String("/${productKey}/${deviceName}/user/get"),
// 指定消息的发送方式,支持QoS0和QoS1。
Qos: tea.Int32(0),
}
response, _err := client.Pub(request)
if _err != nil {
fmt.Print(_err.Error())
}
console.Log(util.ToJSONString(tea.ToMap(response)))
return nil
}()
if tryErr != nil {
var error = &tea.SDKError{}
if _t, ok := tryErr.(*tea.SDKError); ok {
error = _t
} else {
error.Message = tea.String(tryErr.Error())
}
console.Log(error.Message)
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
附录:示例代码
前往物联网平台云端SDK示例中心查看或下载API调用的示例代码。示例代码中包含Java、Python、PHP、Node.js、Go、C++和.NET等版本SDK示例。
阿里云OpenAPI开发者门户提供API在线调试工具。在API调试页面,您可以快速检索和体验调用API。系统会根据您输入的参数同步生成各语言SDK的代码示例。各语言SDK代码示例显示在页面右侧SDK示例页签下供您参考。在调用结果页签下,可查看API调用的真实请求URL和JSON格式的返回结果。