You need to enable JavaScript to run this app.
导航
安装及初始化
最近更新时间:2024.09.26 21:17:10首次发布时间:2024.09.26 21:12:56
复制全文
我的收藏
有用
有用
无用
无用

运行 Go SDK 前,您需要先安装 SDK,本文提供 SDK 的运行环境要求及安装方式。

前提条件

  • 已注册火山引擎账号,完成实名认证,并开通云手机服务。
  • 已安装 Golang 1.14 及以上版本。
  • 已获取访问云手机服务所需的安全凭证,即 Access Key ID(简称为 AK)和 Secret Access Key(简称为 SK)。由于主账号 AK/SK 一旦泄漏,将有严重的安全风险,推荐您参考获取指定IAM用户的 Access Key使用子账号 AK/SK 访问产品服务。

安装 SDK

执行以下命令,安装或更新最新版本的 SDK 至您的主目录下。

go get github.com/volcengine/volc-sdk-golang@latest

如需安装指定版本,可执行以下命令(以 v1.0.174 为例)。版本发布记录参看 Changelog

go get github.com/volcengine/volc-sdk-golang@v1.0.174

配置安全凭证

可选择以下任意一种方式设置 AK/SK。

方法一:在代码中设置

service := ACEP.NewInstance()

service.SetCredential(base.Credentials{
    AccessKeyID:     "ak",
    SecretAccessKey: "sk",
})

方法二:在环境变量中设置

VOLC_ACCESSKEY="ak"
VOLC_SECRETKEY="sk"
  • 在 Linux 或 macOS 系统中配置
    请在命令行终端执行以下命令,并传入已准备好的 AK 和 SK。注意:请将代码中的 "ak" 及 "sk" 分别替换为您的 AK 及 SK。
export VOLC_ACCESSKEY="ak"
export VOLC_SECRETKEY="sk"
  • 在 Windows 系统中配置
    新建系统环境变量,添加环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,并传入已准备好的 AK 和 SK。

方法三:在文件中设置

在本地的 ~/.volc/config 中添加的内容如下所示。

{
    "ak":"Your-AK",
    "sk":"Your-SK"
}

调用示例

以下为完整初始化及接口调用示例,以 DetailPod 为例:

package main

import (
        "context"
        "fmt"
        "os"

        "github.com/volcengine/volc-sdk-golang/base"
        ACEP "github.com/volcengine/volc-sdk-golang/service/acep"
)

func main() {
        // 若通过方式二或者方式三方式设置ak、sk会自动读取,不用直接指定设置ak、sk
        service := ACEP.NewInstance()

        // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
        // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
        ak := os.Getenv("VOLC_ACCESSKEY")
        sk := os.Getenv("VOLC_SECRETKEY")

        //如果需直接指定ak、sk,则通过以下代码设置
        service.SetCredential(base.Credentials{
                AccessKeyID:     ak,
                SecretAccessKey: sk,
        })

        query := &ACEP.DetailPodQuery{
                // 实例所归属的业务 ID,可在**云手机控制台 > 业务管理 > 业务详情**中获取。
                ProductID: `163571455047xxxx`,
                // 实例 ID,可通过调用 [ListPod](https://www.volcengine.com/docs/6394/1221468) 接口获取。
                PodID: `163571455047xxxx`,
        }

        resp, err := service.DetailPod(context.Background(), query)

        if err != nil {
                fmt.Printf("error %v", err)
        } else {
                fmt.Printf("success %+v", resp)
        }
}