You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /视频直播/服务端 SDK/Golang SDK/域名管理
域名管理
最近更新时间：2024.05.21 14:57:29首次发布时间：2023.12.28 21:21:52
我的收藏

阅读本文，您可以获取 Go SDK 域名管理的接口调用示例，实现快速开发。

说明

本文的调用示例包含接口的部分参数。由于参数间可能存在互斥关系，在调用时，请您参考注释，进行调整。

调用说明

  • 本文提供的接口调用示例均通过 AK 和 SK 初始化实例。
  • 接口的参数说明和错误码等信息可通过接口文档或打开 API Explorer 的文档说明页签查看。

前提条件

调用接口前，请先完成 Go SDK 的安装及初始化操作。

调用示例

本节为您介绍域名管理相关接口的功能和调用示例。

添加域名

您可以调用 CreateDomain 接口添加域名。详细的参数说明可参见 CreateDomain 接口文档。

接口调用示例如下所示。

package main
import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
    live "github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func StringPtr(v string) *string {
  return &v
}

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live.NewInstance()

  service.SetCredential(base.Credentials{
      AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
      SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live.CreateDomainBody{  
      // 待添加到视频直播服务进行加速的域名，域名只能由数字（0 - 9）、字母（A - Z、a -z）和连字符（-） 组成。 
      Domain: `push.example.com`, 
      // 域名类型，包含两种类型。 
      // <li> `push`：推流域名； </li> 
      // <li> `pull-flv`：拉流域名，包含 RTMP、FLV、HLS 格式。 </li> 
      Type: `push`, 
      // 域名加速区域，默认值为 `cn`，包含以下类型。 
      // <li> `cn`：中国内地； </li> 
      // <li> `cn-global`：全球加速； </li> 
      // <li> `cn-oversea`：海外及港澳台。 </li> 
      Region: StringPtr(`cn`), 
  }
  
  
  resp, err := service.CreateDomain(context.Background(), body)

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

批量添加域名

您可以调用 CreateDomainV2 接口批量添加域名。详细的参数说明可参见 CreateDomainV2 接口文档。

接口调用示例如下所示。

package main
import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
    live "github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func StringPtr(v string) *string {
  return &v
}

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live.NewInstance()

  service.SetCredential(base.Credentials{
      AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
      SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live.CreateDomainV2Body{  
      // 域名加速区域，包含以下类型。 
      // <li> `cn`：中国内地； </li> 
      // <li> `cn-global`：全球加速； </li> 
      // <li> `cn-oversea`：海外及港澳台。 </li> 
      Region: `cn`, 
      // 域名空间，是一组关联域名的集合，由字母（A - Z、a -z）、数字（0 - 9）和连字符（-） 组成。您可以自定义新的域名空间或调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口查看已有域名使用的域名空间。 
      Vhost: `vhost`, 
      // 项目名称，vhost 将归类这个项目里，仅在新创建 vhost 时需要设置。 
      ProjectName: StringPtr(`default`), 
  }
  
  
  // 待添加到视频直播服务进行加速的域名列表信息。 
  // note： 
  // 一个域名空间下最多包含 10 个域名。 
  Domains1 := live.CreateDomainV2BodyDomainsItem{  
      // 域名名称，域名由字母（A - Z、a -z）、数字（0 - 9）和连字符（-） 组成，长度为 1 到 60 个字符。 
      DomainName: `push.example.com`, 
      // 证书链 ID。 
      ChainID: StringPtr(`93cb8cf3*******ece5600142`), 
      // 域名类型，取值及含义如下所示。 
      // <li> `push`：推流域名； </li> 
      // <li> `pull-flv`：拉流域名。 </li> 
      Type: `push`, 
  }
   
  body.Domains = append(body.Domains,  Domains1)
  
  // 标签列表，vhost 将归类这个 tag 里。 
  Tags1 := live.CreateDomainV2BodyTagsItem{  
      // 标签 Key 值。 
      Key: `key001`, 
      // 标签 Value 值。 
      Value: `Valuedes`, 
      // 标签类型，支持以下取值。 
      // <li> `System`：系统内置标签； </li> 
      // <li> `Custom`：自定义标签。 </li> 
      Category: `Custom`, 
  }
   
  body.Tags = append(body.Tags,  &Tags1)
  
  resp, err := service.CreateDomainV2(context.Background(), body)

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

更新域名的域名空间

您可以调用 UpdateDomainVhost 接口更新域名的域名空间。详细的参数说明可参见 UpdateDomainVhost 接口文档。

接口调用示例如下所示。

package main
import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
    live "github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live.NewInstance()

  service.SetCredential(base.Credentials{
      AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
      SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live.UpdateDomainVhostBody{  
      // 待修改所属域名空间的的拉流/推流域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看域名信息。 
      Domain: `push.example.com`, 
      // 目的域名空间，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看域名所属的域名空间信息。 
      Vhost: `push.example.com`, 
  }
  
  
  resp, err := service.UpdateDomainVhost(context.Background(), body)

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

删除域名

您可以调用 DeleteDomain 接口删除域名。详细的参数说明可参见 DeleteDomain 接口文档。

接口调用示例如下所示。

package main
import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
    live "github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live.NewInstance()

  service.SetCredential(base.Credentials{
      AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
      SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live.DeleteDomainBody{  
      // 待删除域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看需要待删除域名的信息。 
      Domain: `push.example.com`, 
  }
  
  
  resp, err := service.DeleteDomain(context.Background(), body)

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

禁用域名

您可以调用 DisableDomain 接口禁用域名。详细的参数说明可参见 DisableDomain 接口文档。

接口调用示例如下所示。

package main
import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
    live "github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live.NewInstance()

  service.SetCredential(base.Credentials{
      AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
      SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live.DisableDomainBody{  
      // 待禁用域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看需要待禁用域名的信息。 
      Domain: `push.example.com`, 
  }
  
  
  resp, err := service.DisableDomain(context.Background(), body)

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

启用域名

您可以调用 EnableDomain 接口启用域名。详细的参数说明可参见 EnableDomain 接口文档。

接口调用示例如下所示。

package main
import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
    live "github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live.NewInstance()

  service.SetCredential(base.Credentials{
      AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
      SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live.EnableDomainBody{  
      // 待启用域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看需要待启用域名的信息。 
      Domain: `push.example.com`, 
  }
  
  
  resp, err := service.EnableDomain(context.Background(), body)

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

查询域名信息

您可以调用 DescribeDomain 接口查询域名信息。详细的参数说明可参见 DescribeDomain 接口文档。

接口调用示例如下所示。

package main
import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
    live "github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live.NewInstance()

  service.SetCredential(base.Credentials{
      AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
      SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live.DescribeDomainBody{} 
  
  
  // 待查询域名信息的域名列表。 
  DomainList := []string{"push.example.com","pull.example.com"} 
  
  body.DomainList = DomainList 
  
  
  resp, err := service.DescribeDomain(context.Background(), body)

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

查询域名列表

您可以调用 ListDomainDetail 接口查询域名列表。详细的参数说明可参见 ListDomainDetail 接口文档。

接口调用示例如下所示。

package main
import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
    live "github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func StringPtrs(vals []string) []*string {
	ptrs := make([]*string, len(vals))
	for i := 0; i < len(vals); i++ {
		ptrs[i] = &vals[i]
	}
	return ptrs
}

func Int32Ptrs(vals []int32) []*int32 {
	ptrs := make([]*int32, len(vals))
	for i := 0; i < len(vals); i++ {
		ptrs[i] = &vals[i]
	}
	return ptrs
}

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live.NewInstance()

  service.SetCredential(base.Credentials{
      AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
      SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live.ListDomainDetailBody{  
      // 查询数据的页码，取值为 1 时表示查询第一页的数据，取值范围为 [1,1000]。 
      PageNum: 1, 
      // 每页显示的数据条数，取值为 10 时表示每页展示 10 条域名信息，取值范围为 [1, 1000]。 
      PageSize: 10, 
  }
  
  
  // 域名空间列表，缺省情况下表示查询全部域名空间下的域名。 
  VhostList := []string{"push.example.com","pull.example.com"} 
  
  body.VhostList = StringPtrs(VhostList) 
  
  
  // 域名状态列表，缺省情况下表示查询全部状态的域名。支持的取值如下所示。 
  // <li> `0`：正常； </li> 
  // <li> `1`：审核中； </li> 
  // <li> `2`：禁用，禁止使用，此时 domain 不生效； </li> 
  // <li> `3`：删除； </li> 
  // <li> `4`：审核被驳回。审核不通过，需要重新创建并审核； </li> 
  // <li> `5`：欠费关停。 </li> 
  DomainStatusList := []int32{0,2,3} 
  
  body.DomainStatusList = Int32Ptrs(DomainStatusList) 
  
  
  // 域名类型列表，缺省情况下表示全部类型的域名。支持的取值如下所示。 
  // <li> `push`：推流域名； </li> 
  // <li> `pull-flv`：拉流域名。 </li> 
  DomainTypeList := []string{"push","pull-flv"} 
  
  body.DomainTypeList = StringPtrs(DomainTypeList) 
  
  
  // 域名加速区域列表，缺省情况下表示查看全部。支持的取值如下所示。 
  // <li> `cn`：中国内地； </li> 
  // <li> `cn-global`：全球加速； </li> 
  // <li> `cn-oversea`：海外及港澳台。 </li> 
  DomainRegionList := []string{"cn"} 
  
  body.DomainRegionList = StringPtrs(DomainRegionList) 
  
  
  // 域名名称列表，缺省情况下表示全部。 
  DomainNameList := []string{"push.example.com","pull.example.com"} 
  
  body.DomainNameList = StringPtrs(DomainNameList) 
  
  
  resp, err := service.ListDomainDetail(context.Background(), body)

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