更新时间:2024-06-13 GMT+08:00

Go SDK

本章节介绍Go SDK,您可以参考本章节进行快速集成开发。

准备工作

  • 注册华为账号并开通华为云,账号不能处于欠费或冻结状态。
  • 已具备开发环境,Go SDK 支持 go 1.14 及以上版本,可执行 go version 检查当前 Go 的版本信息。
  • 登录“我的凭证 > 访问密钥”页面,依据界面操作指引获取Access Key(AK)和Secret Access Key(SK)。下载的访问密钥为credentials.csv文件,包含AK/SK信息。
    图1 新增访问密钥

  • 登录“我的凭证 ”页面,获取“IAM用户名”“账号名”以及待使用区域的“项目ID”。调用服务时会用到这些信息,请提前保存。
    图2 我的凭证

安装SDK

使用SDK前需要安装华为云Go SDK 库。

// 安装华为云 Go SDK 库
go get github.com/huaweicloud/huaweicloud-sdk-go-v3

开始使用

  1. 导入依赖模块
    import (
    "fmt"
    "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
        ocr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1"
    "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/region"
    )
  2. 配置认证信息

    配置AK、SK信息。华为云通过AK识别用户的身份,通过SK对请求数据进行签名验证,用于确保请求的机密性、完整性和请求者身份的正确性。AK、SK获取方法请参见准备工作

    func main() {
        ak := os.Getenv("HUAWEICLOUD_SDK_AK")
        sk := os.Getenv("HUAWEICLOUD_SDK_SK")
        auth := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            Build()
    }
    • 认证用的 ak 和sk 硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全。
    • 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。
  3. 初始化客户端(二选一)
    • 指定云服务region方式(推荐)
      // 初始化指定云服务的客户端 New{Service}Client,以初始化亚太-曼谷(ap-southeast-2)区域服务为例
      func main() {
          client := ocr.NewOcrClient(
              ocr.OcrClientBuilder().
                  WithRegion(region.ValueOf("ap-southeast-2")).
                  WithCredential(auth).
                  Build())
      }
    • 指定云服务endpoint方式
      func main() {
          // 指定终端节点,以OCR服务亚太-曼谷的endpoint为例
          endpoint:="https://ocr.ap-southeast-2.myhuaweicloud.com"
          // 使用endpoint方式,在认证信息中需新增projectId
          auth := basic.NewCredentialsBuilder().
              WithAk(ak).
              WithSk(sk).
              WithProjectId(projectId).
              Build()
          // 初始化指定云服务的客户端 New{Service}Client
          client := ocr.NewOcrClient(
              ocr.OcrClientBuilder().
                  WithEndpoint(endpoint).
                  WithCredential(auth).
                  Build())
      }

      endpoint是华为云各服务应用区域和各服务的终端节点,详情请查看 地区和终端节点

  4. 发送请求并查看响应
    // 以调用护照识别接口 RecognizePassport 为例
    request := &model.RecognizePassportRequest{}
    urlPassportRequestBody:= "图片的url"
    request.Body = &model.PassportRequestBody{
    	Url: &urlPassportRequestBody,
    }
    response, err := client.RecognizePassport(request)
    if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
  5. 异常处理
    表1 异常处理

    一级分类

    一级分类说明

    ServiceResponseError

    服务响应异常

    url.Error

    url异常

    response, err := client.RecognizePassport(request)
    if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }

详细的SDK介绍请参见SDK中心Go SDK使用指导

代码示例自动生成

API Explorer提供API检索及平台调试,支持全量快速检索、可视化调试、帮助文档查看、在线咨询。

您只需要在API Explorer中修改接口参数,即可自动生成对应的代码示例。

图3 API Explorer