集成SDK

更新时间:

在调用OpenAPI时,建议采用在项目中集成SDK的方式。使用SDK可以简化开发流程,实现功能的快速集成,同时有效降低维护成本。集成阿里云SDK主要包括三个步骤:引入阿里云SDK、设置访问凭据以及使用SDK。本文将详细介绍SDK集成的具体流程。

环境要求

  • Go环境版本 >= 1.10.x。

引入SDK

  1. 登录SDK中心,选择将要使用产品,例如您将要调用短信服务 SMS(Short Message Service)API。

  2. 安装页面SDK 代系选择V2.0所有语言选择Go。然后在快速入门页签中,您可以获取短信服务 SMS(Short Message Service)SDK安装方式。image

设置访问凭据

调用阿里云OpenAPI通常需要设置访问凭据,常见凭据类型为AccessKey(简称:AK)临时安全令牌STS Token。为防止凭据泄露,常用的方案是将其存储到环境变量中,更多安全方案请参见访问凭据的安全使用方案。本文以设置环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET为例:

LinuxmacOS系统配置方法

通过export命令配置环境变量

重要

使用export命令配置的临时环境变量仅当前会话有效,当会话退出之后所设置的环境变量将会丢失。若需长期保留环境变量,可将export命令配置到对应操作系统的启动配置文件中。

  • 配置AccessKey ID并按回车。

    # 将<ACCESS_KEY_ID>替换为您自己的AccessKey ID。
    export ALIBABA_CLOUD_ACCESS_KEY_ID=yourAccessKeyID
  • 配置AccessKey Secret并回车。

    # 将<ACCESS_KEY_SECRET>替换为您自己的AccessKey Secret。
    export ALIBABA_CLOUD_ACCESS_KEY_SECRET=yourAccessKeySecret
  • 验证是否配置成功。

    执行echo $ALIBABA_CLOUD_ACCESS_KEY_ID命令,如果返回正确的AccessKey ID,则说明配置成功。

Windows系统配置方法

通过图形用户界面GUI

  • 操作步骤

    以下为Windows 10中通过图形用户界面设置环境变量的步骤。

    在桌面右键单击此电脑,选择属性>高级系统设置>环境变量>系统变量/用户变量>新建,完成以下配置:

    变量

    示例值

    AccessKey ID

    • 变量名:ALIBABA_CLOUD_ACCESS_KEY_ID

    • 变量值:LTAI****************

    AccessKey Secret

    • 变量名:ALIBABA_CLOUD_ACCESS_KEY_SECRET

    • 变量值:yourAccessKeySecret

  • 测试设置是否成功

    单击开始(或快捷键:Win+R)> 运行(输入 cmd)> 确定(或按 Enter 键),打开命令提示符,执行echo %ALIBABA_CLOUD_ACCESS_KEY_ID%echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%命令。若返回正确的AccessKey,则说明配置成功。

通过命令行提示符CMD

  • 操作步骤

    以管理员身份打开命令提示符,并使用以下命令在系统中新增环境变量。

    setx ALIBABA_CLOUD_ACCESS_KEY_ID yourAccessKeyID /M
    setx ALIBABA_CLOUD_ACCESS_KEY_SECRET yourAccessKeySecret /M

    其中/M表示系统级环境变量,设置用户级环境变量时可以不携带该参数。

  • 测试设置是否成功

    单击开始(或快捷键:Win+R)> 运行(输入 cmd)> 确定(或按 Enter 键),打开命令提示符,执行echo %ALIBABA_CLOUD_ACCESS_KEY_ID%echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%命令。若返回正确的AccessKey,则说明配置成功。

通过Windows PowerShell

PowerShell中,设置新的环境变量(对所有新会话都有效):

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'yourAccessKeyID', [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'yourAccessKeySecret', [System.EnvironmentVariableTarget]::User)

为所有用户设置环境变量(需要管理员权限):

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'yourAccessKeyID', [System.EnvironmentVariableTarget]::Machine)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'yourAccessKeySecret', [System.EnvironmentVariableTarget]::Machine)

设置临时的环境变量(仅当前会话有效):

$env:ALIBABA_CLOUD_ACCESS_KEY_ID = "yourAccessKeyID"
$env:ALIBABA_CLOUD_ACCESS_KEY_SECRET = "yourAccessKeySecret"

PowerShell中,执行Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_IDGet-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_SECRET命令。若返回正确的AccessKey,则说明配置成功。

使用SDK

本文以调用短信服务 SMS(Short Message Service)SendSms接口为例,关于SendSms接口的API文档,请参见SendSms

1. 初始化请求客户端

V2.0 SDK中,所有的OpenAPI均通过SDK提供的请求客户端(Client)发起调用。因此,在调用OpenAPI之前,需要先对请求客户端进行初始化。请求客户端支持多种方式初始化,本示例以使用AK进行初始化为例,更多初始化方式请参见管理访问凭证

重要
  • 客户端实例是线程安全的,能够在多线程环境中安全使用,无需为每个线程单独创建实例。

  • 在实际开发中,不建议频繁创建客户端对象,这会导致资源浪费和性能下降。推荐采用单例模式封装客户端,确保在整个应用程序生命周期中针对相同的访问凭据和Endpoint仅初始化一个客户端对象。

import (
  "os"

  openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  dysmsapi20170525 "github.com/alibabacloud-go/dysmsapi-20170525/v4/client"
  "github.com/alibabacloud-go/tea/tea"
)

func CreateClient () (_result *dysmsapi20170525.Client, _err error) {
  config := &openapi.Config{
    // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
    AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
    // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
    AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
  }
  config.Endpoint = tea.String("dysmsapi.aliyuncs.com")
  _result = &dysmsapi20170525.Client{}
  _result, _err = dysmsapi20170525.NewClient(config)
  return _result, _err
}

2. 创建Request结构体实例

在调用OpenAPI进行参数传递时,需使用SDK提供的Request结构体来实现参数的传递。OpenAPI Request结构体的命名格式为<OpenAPI名称>Request,例如SendSms该接口的请求对象为SendSmsRequest。关于请求参数的详细信息,请查阅相应的API文档,本示例API文档请参见SendSms

说明

OpenAPI不支持请求参数,则无需创建请求对象。例如,在调用DescribeCdnSubList时,该接口不支持请求参数。

// 创建请求对象并设置入参
sendSmsRequest := &dysmsapi20170525.SendSmsRequest{
  // 需替换成为您的短信模板code
  TemplateCode: tea.String("<YOUR_VALUE>"),
  // 需替换成为您的短信模板变量对应的实际值,示例值:{"code":"1234"}
  TemplateParam: tea.String("<YOUR_VALUE>"),
  // 需替换成为您的接收手机号码
  PhoneNumbers: tea.String("<YOUR_VALUE>"),
  // 需替换成为您的短信签名
  SignName: tea.String("<YOUR_VALUE>"),
}

3. 发起请求

通过请求客户端调用OpenAPI时,建议使用函数<接口名称>WithOptions。该函数包含两个参数:第一个参数为指向API Request结构体的指针,第二个参数为指向运行时参数结构体的指针。运行时参数用于配置请求的行为,例如超时设置、代理配置等。更多信息,请参见进阶配置

说明

OpenAPI不支持请求参数,则在发起请求时无需传递请求对象。例如,在调用DescribeCdnSubList时,该接口只需传入运行时参数。

//  需要在import中添加  util "github.com/alibabacloud-go/tea-utils/v2/service"

func _main() (_result *dysmsapi20170525.SendSmsResponse, _err error) {
  client, _err := CreateClient()
  if _err != nil {
    return nil, _err
  }
  // 创建SendSmsRequest结构体实例
  sendSmsRequest := &dysmsapi20170525.SendSmsRequest{
    // 需替换成为您的短信模板code
    TemplateCode: tea.String("<YOUR_VALUE>"),
    // 需替换成为您的短信模板变量对应的实际值,示例值:{"code":"1234"}
    TemplateParam: tea.String("<YOUR_VALUE>"),
    // 需替换成为您的接收手机号码
    PhoneNumbers: tea.String("<YOUR_VALUE>"),
    // 需替换成为您的短信签名
    SignName: tea.String("<YOUR_VALUE>"),
  }
  // 创建运行时参数结构体实例
  runtime := &util.RuntimeOptions{}
  response, _err := client.SendSmsWithOptions(sendSmsRequest, runtime)
  if _err != nil {
    return nil, _err
  }
  return response, nil
}

4. 异常处理

V2.0 Go SDK将异常进行了细致的分类,主要划分为errorSDKError。

  • error:非业务报错的error,比如SDK源文件被修改导致的校验error,解析失败导致的error等。

  • SDKError:主要以业务报错为主的异常。

更多关于异常处理的介绍,请参见异常处理

重要

建议采取合理的措施来处理异常,比如合理地传播异常、记录日志、尝试恢复等,以确保系统的健壮性和稳定性。

点击查看完整代码示例

SendSms接口调用示例

package main

import (
  "fmt"
  "os"

  openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  dysmsapi20170525 "github.com/alibabacloud-go/dysmsapi-20170525/v4/client"
  util "github.com/alibabacloud-go/tea-utils/v2/service"
  "github.com/alibabacloud-go/tea/tea"
)

func CreateClient() (_result *dysmsapi20170525.Client, _err error) {
  config := &openapi.Config{
    // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
    AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
    // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
    AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
  }
  config.Endpoint = tea.String("dysmsapi.aliyuncs.com")
  _result = &dysmsapi20170525.Client{}
  _result, _err = dysmsapi20170525.NewClient(config)
  return _result, _err
}

func _main() (_result *dysmsapi20170525.SendSmsResponse, _err error) {
  client, _err := CreateClient()
  if _err != nil {
    return nil, _err
  }
  // 创建请求对象并设置入参
  sendSmsRequest := &dysmsapi20170525.SendSmsRequest{
    // 需替换成为您的短信模板code
    TemplateCode: tea.String("<YOUR_VALUE>"),
    // 需替换成为您的短信模板变量对应的实际值,示例值:{\"code\":\"1234\"}
    TemplateParam: tea.String("<YOUR_VALUE>"),
    // 需替换成为您的接收手机号码
    PhoneNumbers: tea.String("<YOUR_VALUE>"),
    // 需替换成为您的短信签名
    SignName: tea.String("<YOUR_VALUE>"),
  }
  runtime := &util.RuntimeOptions{}
  response, _err := client.SendSmsWithOptions(sendSmsRequest, runtime)
  if _err != nil {
    return nil, _err
  }
  return response, nil
}

func main() {
  response, err := _main()
  if err != nil {
    panic(err)
  }
  // 打印返回结果
  fmt.Println(response.String())
}

特殊场景:文件上传Advance接口配置

在使用图像搜索、视觉智能开放平台等云产品处理本地图片或上传图片时,官方文档中提供的OpenAPI接口不支持直接上传文件。若需上传文件,可以使用云产品提供的Advance接口,该接口支持传递文件流对象。其底层实现机制为:云产品会将上传的文件临时存储于阿里云OSS上,默认存储地域为cn-shanghai,并通过读取该OSS中的临时文件来实现相关功能。以阿里云提供的视觉智能开放平台-人脸人体的DetectBodyCount接口为例:

说明

存储在阿里云 OSS 的临时文件会被定时清理。

  1. 初始化请求客户端

    请注意需同时设置RegionId和云产品的Endpoint。其中,RegionId表示临时文件在OSS中所存储的地域。如果未设置RegionId,可能会由于云产品与OSS所在地域不同,导致在调用OpenAPI时出现超时等问题。

    import (
      "os"
    
      openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
      facebody20191230 "github.com/alibabacloud-go/facebody-20191230/v5/client"
      "github.com/alibabacloud-go/tea/tea"
    )
    
    func CreateClient() (_result *facebody20191230.Client, _err error) {
      config := &openapi.Config{
        // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
        AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
        // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
        AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
      }
      // endpoint 和 regionId 需设置为同一地域
      config.RegionId = tea.String("cn-shanghai")
      config.Endpoint = tea.String("facebody.cn-shanghai.aliyuncs.com")
      _result, _err = facebody20191230.NewClient(config)
      return _result, _err
    }
  2. 创建AdvanceRequest结构体实例

    在上传本地文件时,需要通过SDK提供的AdvanceRequest结构体来传递文件流。AdvanceRequest结构体命名格式为<OpenAPI名称>AdvanceRequest,关于传递文件流的参数名,请在相应的AdvanceRequest结构体中查找参数类型为io.Reader的参数。

    // 需替换文件路径
    filePath := `<FILE_PATH>`
    // 打开文件并创建流
    file, err := os.Open(filePath)
    if err != nil {
      return fmt.Errorf("打开文件失败: %v", err)
    }
    defer file.Close() // 关闭文件
    // 创建AdvanceRequest结构体实例
    detectBodyCountAdvanceRequest := &facebody20191230.DetectBodyCountAdvanceRequest{
      ImageURLObject: file,
    }
  3. 发起请求

    调用函数<接口名称>Advance发起请求,入参为指向AdvanceRequest结构体的指针。

    //  需要在import中添加  util "github.com/alibabacloud-go/tea-utils/v2/service"
    
    func _main() (response *facebody20191230.DetectBodyCountResponse, _err error) {
      client, _err := CreateClient()
      if _err != nil {
        return nil, _err
      }
    
      // 需替换文件路径
      filePath := `<FILE_PATH>`
      // 打开文件并创建流
      file, err := os.Open(filePath)
      if err != nil {
        return nil, fmt.Errorf("打开文件失败: %v", err)
      }
      defer file.Close() // 关闭文件
      // 创建请求对象
      detectBodyCountAdvanceRequest := &facebody20191230.DetectBodyCountAdvanceRequest{
        ImageURLObject: file,
      }
      runtime := &util.RuntimeOptions{}
      // 发起请求
      response, _err = client.DetectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime)
    
      if _err != nil {
        return nil, _err
      }
      return response, nil
    }

点击查看完整代码示例

package main

import (
  "fmt"
  "os"

  openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  facebody20191230 "github.com/alibabacloud-go/facebody-20191230/v5/client"
  util "github.com/alibabacloud-go/tea-utils/v2/service"
  "github.com/alibabacloud-go/tea/tea"
)

func CreateClient() (_result *facebody20191230.Client, _err error) {

  config := &openapi.Config{
    // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
    AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
    // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
    AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
  }
  config.RegionId = tea.String("cn-shanghai")
  config.Endpoint = tea.String("facebody.cn-shanghai.aliyuncs.com")
  _result, _err = facebody20191230.NewClient(config)
  return _result, _err
}

func _main() (response *facebody20191230.DetectBodyCountResponse, _err error) {
  client, _err := CreateClient()
  if _err != nil {
    return nil, _err
  }

  // 需替换文件路径
  filePath := `<FILE_PATH>`
  // 打开文件并创建流
  file, err := os.Open(filePath)
  if err != nil {
    return nil, fmt.Errorf("打开文件失败: %v", err)
  }
  defer file.Close() // 关闭文件
  // 创建请求对象
  detectBodyCountAdvanceRequest := &facebody20191230.DetectBodyCountAdvanceRequest{
    ImageURLObject: file,
  }
  runtime := &util.RuntimeOptions{}
  // 发起请求
  response, _err = client.DetectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime)

  if _err != nil {
    return nil, _err
  }
  return response, nil
}
func main() {
  response, err := _main()
  if err != nil {
    panic(err)
  }
  fmt.Println(response)
}

常见问题

  1. 调用OpenAPI时报错,提示“You are not authorized to perform this operation”。

    问题原因及解决方法

    问题原因:您所使用的AccessKey对应的RAM用户没有权限调用该API。

    解决方法:请为该RAM用户授予相应OpenAPI权限。关于如何为RAM用户进行授权,请参见RAM用户授权

    例如,当您在调用SendSms时提示“You are not authorized to perform this operation”,您可以创建如下所示的自定义权限策略,并为该RAM用户授予相应的权限。

    {
      "Version": "1",
      "Statement": [
        {
          "Effect": "Allow",
          "Action": "dysms:SendSms",
          "Resource": "*"
        }
      ]
    }
  2. 调用OpenAPI时报错,提示 "SDKError:Message:Post "https://ecs-cn-XX.aliyuncs.com": dial tcp: lookup ecs-cn-XX.aliyuncs.com: no such host"。

    问题原因及解决方法

    问题原因:您所调用的OpenAPI不支持在初始化请求客户端时填写的Endpoint。

    解决方法:请查看Endpoint配置,修改Endpoint后重新调用OpenAPI。

  3. 调用OpenAPI时报错,提示:“SDKError: StatusCode: 404 Code:InvalidAccessKeyId.NotFound Message: code: 404, Specified access key is not found. ”。

    问题原因及解决方法

    问题原因:您的AccessKey未正确传递。

    解决方法:在初始化请求客户端时,检查是否正确传递AccessKey。请注意os.Getenv("XXX")表示从环境变量中获取XXX的值。

更多SDK使用过程中的报错问题解决方案,请参见常见问题