You need to enable JavaScript to run this app.
导航
Go SDK 接入
最近更新时间:2024.09.14 15:40:29首次发布时间:2024.07.10 15:50:05

1.引入Go依赖

环境要求:Go 环境版本必须不低于 1.15
默认获取最新版本,可指定版本号

go get github.com/volcengine/cdp-openapi-sdk-go@version

具体源码及版本号见仓库 GitHub仓库地址(源码更新会有延迟)

2.获取必要参数信息
access_key:BDxxxxx
secret_key:xxxxx
domain:域名
account:绑定的用户名

access_key,secret_key,domain 获取方式见接入须知
注意:使用OpenApi时,CDP资源权限与此绑定账户权限相关联,请勿越权访问

3.构建使用代码

1.STS方式-推荐使用

var accessKeyId = "BDxxxx"
var accessKeySecret = "xxxx"
var account = "account_name"

var basePath = "<域名>/open_platform/openapi"

func main() {
    httpClient := http.Client{}
    cfg := cdpOpenApiSdk.Configuration{
       AccessKeyId:     accessKeyId,
       AccessKeySecret: accessKeySecret,
       BasePath:        basePath,
       HTTPClient:      &httpClient,
       Account:         account,
    }
    client, err := cdpOpenApiSdk.NewAPIClient(&cfg)

2.传统使用方式-已废弃

var accessKeyId = "BDxxxx"
var accessKeySecret = "xxxx"
var basePath = "<域名>/open_platform/openapi"

func main() {
    httpClient := http.Client{}
    cfg := cdpOpenApiSdk.Configuration{
       AccessKeyId:     accessKeyId,
       AccessKeySecret: accessKeySecret,
       BasePath:        basePath,
       HTTPClient:      &httpClient,
    }
    client, err := cdpOpenApiSdk.NewAPIClient(&cfg)

3 .API调用示例

文档中示例代码仅供参考

分群相关API

  1. 分群列表
opts := SegmentationApiLegacyGetSegmentListOpts{Current: optional.NewInt32(1), PageSize: optional.NewInt32(20)}
responseBody, httpRespose, err := client.SegmentationApi.LegacyGetSegmentList(context.Background(), 1, &opts)
  1. 分群详细信息
tenantId := 1
segId : =123
responseBody, httpRespose, err := client.SegmentationApi.LegacyGetSegment(context.Background(), tenantId, segId)

4.使用建议

1.使用STS方式时,请保存 ApiClient,构造器会自动获取Token并保存,不建议每次请求都新构建ApiClient(每次新构建都会触发一次获取Token操作)
2.SDK版本与CDP版本相对应,CDP版本号对应SDK前两位版本号,例如CDP版本1.22,则SDK对应版本为1.22.X
其中X为SDK对应的patch,建议使用相匹配的版本以获得最新功能和最佳使用体验