You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

域名管理

最近更新时间：2024.04.15 11:37:00

首次发布时间：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"
   	"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_v20230101.NewInstance()

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

  body := &live_v20230101.CreateDomainBody{}
     
  //待添加到视频直播服务进行加速的域名，域名只能由数字（0 - 9）、字母（A - Z、a -z）和连字符（-） 组成。
  body.Domain = "push.example.com"
    
  //域名类型，包含两种类型。
  // <li> `push`：推流域名； </li>
  // <li> `pull-flv`：拉流域名，包含 RTMP、FLV、HLS 格式。 </li>
  body.Type = "push"
    
  //域名加速区域，默认指为 `cn`，包含以下类型。
  // <li> `cn`：中国大陆； </li>
  // <li> `cn-global`：全球； </li>
  // <li> `cn-oversea`：海外及港澳台。 </li>
  var bodyRegion *string 

  var bodyRegionValue string = "cn" 

  bodyRegion = &bodyRegionValue 

  body.Region = bodyRegion
  
  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"
   	"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_v20230101.NewInstance()

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

  body := &live_v20230101.CreateDomainV2Body{}
     
  //待添加到视频直播服务进行加速的域名列表信息。
  // note：
  // 一个域名空间下最多包含 10 个域名。
  createDomainV2BodyDomainsItem := live_v20230101.CreateDomainV2BodyDomainsItem{}
 
  //域名名称，域名由字母（A - Z、a -z）、数字（0 - 9）和连字符（-） 组成，长度为 1 到 60 个字符。
  createDomainV2BodyDomainsItem.DomainName = "push.example.com"
    
  //证书链 ID。
  var createDomainV2BodyDomainsItemChainID *string 

  var createDomainV2BodyDomainsItemChainIDValue string = "93cb8cf3*******ece5600142" 

  createDomainV2BodyDomainsItemChainID = &createDomainV2BodyDomainsItemChainIDValue 

  createDomainV2BodyDomainsItem.ChainID = createDomainV2BodyDomainsItemChainID 
    
  //域名类型，取值及含义如下所示。
  // <li> `push`：推流域名； </li>
  // <li> `pull-flv`：拉流域名。 </li>
  createDomainV2BodyDomainsItem.Type = "push"
    
  body.Domains = append(body.Domains,createDomainV2BodyDomainsItem)
    
  //域名加速区域，包含以下类型。
  // <li> `cn`：中国大陆； </li>
  // <li> `cn-global`：全球； </li>
  // <li> `cn-oversea`：海外及港澳台。 </li>
  body.Region = "cn"
    
  //域名空间，是一组关联域名的集合，由字母（A - Z、a -z）、数字（0 - 9）和连字符（-） 组成。您可以自定义新的域名空间或调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口查看已有域名使用的域名空间。
  body.Vhost = "vhost"
    
  //项目名称，vhost 将归类这个项目里，仅在新创建 vhost 时需要设置。
  var bodyProjectName *string 

  var bodyProjectNameValue string = "default" 

  bodyProjectName = &bodyProjectNameValue 

  body.ProjectName = bodyProjectName 
    
  //标签列表，vhost 将归类这个 tag 里。
  createDomainV2BodyTagsItem := &live_v20230101.CreateDomainV2BodyTagsItem{}
 
  //标签 Key 值。
  createDomainV2BodyTagsItem.Key = "key001"
    
  //标签 Value 值。
  createDomainV2BodyTagsItem.Value = "Valuedes"
    
  //标签类型，支持以下取值。
  // <li> `System`：系统内置标签； </li>
  // <li> `Custom`：自定义标签。 </li>
  createDomainV2BodyTagsItem.Category = "Custom"
    
  body.Tags = append(body.Tags,createDomainV2BodyTagsItem)
  
  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"
   	"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_v20230101.NewInstance()

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

  body := &live_v20230101.UpdateDomainVhostBody{}
     
  //待修改所属域名空间的的拉流/推流域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面，查看域名信息。
  body.Domain = "push.example.com"
    
  //目的域名空间，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面，查看域名所属的域名空间信息。
  body.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"
   	"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_v20230101.NewInstance()

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

  body := &live_v20230101.DeleteDomainBody{}
     
  //待删除域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面，查看需要待禁用域名的信息。
  body.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"
   	"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_v20230101.NewInstance()

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

  body := &live_v20230101.DisableDomainBody{}
     
  //待禁用域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面，查看需要待禁用域名的信息。
  body.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"
   	"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_v20230101.NewInstance()

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

  body := &live_v20230101.EnableDomainBody{}
     
  //待启用域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面，查看需要待启用域名的信息。
  body.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"
   	"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_v20230101.NewInstance()

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

  body := &live_v20230101.DescribeDomainBody{}
     
  //待查询域名信息的域名列表。
  bodyDomainList := []string{}

  var bodyDomainList0 string 

  var bodyDomainList0Value string  = "push.example.com" 

  bodyDomainList0 = bodyDomainList0Value 

  bodyDomainList = append(bodyDomainList, bodyDomainList0)    

   var bodyDomainList1 string 

  var bodyDomainList1Value string  = "pull.example.com" 

  bodyDomainList1 = bodyDomainList1Value 

  bodyDomainList = append(bodyDomainList, bodyDomainList1)    

  body.DomainList = bodyDomainList
  
  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"
   	"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_v20230101.NewInstance()

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

  body := &live_v20230101.ListDomainDetailBody{}
     
  //查询数据的页码，取值为 1 时表示查询第一页的数据，取值范围为 [1,1000]。
  body.PageNum = 1
    
  //每页显示的数据条数，取值为 10 时表示每页展示 10 条域名信息，取值范围为 [1, 1000]。
  body.PageSize = 10
    
  //域名空间列表，缺省情况下表示查询全部域名空间下的域名。
  bodyVhostList := []*string{}

  var bodyVhostList0 *string 

  var bodyVhostList0Value string  = "push.example.com" 

  bodyVhostList0 = &bodyVhostList0Value 

  bodyVhostList = append(bodyVhostList, bodyVhostList0)    

   var bodyVhostList1 *string 

  var bodyVhostList1Value string  = "pull.example.com" 

  bodyVhostList1 = &bodyVhostList1Value 

  bodyVhostList = append(bodyVhostList, bodyVhostList1)    

  body.VhostList = bodyVhostList
    
  //域名状态列表，缺省情况下表示查询全部状态的域名。支持的取值如下所示。
  // <li> `0`：正常； </li>
  // <li> `1`：审核中； </li>
  // <li> `2`：禁用，禁止使用，此时 domain 不生效； </li>
  // <li> `3`：删除； </li>
  // <li> `4`：审核被驳回。审核不通过，需要重新创建并审核； </li>
  // <li> `5`：欠费关停。 </li>
  bodyDomainStatusList := []*int32{}

  var bodyDomainStatusList0 *int32 

  var bodyDomainStatusList0Value int32  = 0 

  bodyDomainStatusList0 = &bodyDomainStatusList0Value 

  bodyDomainStatusList = append(bodyDomainStatusList, bodyDomainStatusList0)    

   var bodyDomainStatusList1 *int32 

  var bodyDomainStatusList1Value int32  = 2 

  bodyDomainStatusList1 = &bodyDomainStatusList1Value 

  bodyDomainStatusList = append(bodyDomainStatusList, bodyDomainStatusList1)    

   var bodyDomainStatusList2 *int32 

  var bodyDomainStatusList2Value int32  = 3 

  bodyDomainStatusList2 = &bodyDomainStatusList2Value 

  bodyDomainStatusList = append(bodyDomainStatusList, bodyDomainStatusList2)    

  body.DomainStatusList = bodyDomainStatusList
    
  //域名类型列表，缺省情况下表示全部类型的域名。支持的取值如下所示。
  // <li> `push`：推流域名； </li>
  // <li> `pull-flv`：拉流域名。 </li>
  bodyDomainTypeList := []*string{}

  var bodyDomainTypeList0 *string 

  var bodyDomainTypeList0Value string  = "push" 

  bodyDomainTypeList0 = &bodyDomainTypeList0Value 

  bodyDomainTypeList = append(bodyDomainTypeList, bodyDomainTypeList0)    

   var bodyDomainTypeList1 *string 

  var bodyDomainTypeList1Value string  = "pull-flv" 

  bodyDomainTypeList1 = &bodyDomainTypeList1Value 

  bodyDomainTypeList = append(bodyDomainTypeList, bodyDomainTypeList1)    

  body.DomainTypeList = bodyDomainTypeList
    
  //域名加速区域列表，缺省情况下表示查看全部。支持的取值如下所示。
  // <li> `cn`：中国大陆； </li>
  // <li> `cn-global`：全球； </li>
  // <li> `cn-oversea`：海外及港澳台。 </li>
  bodyDomainRegionList := []*string{}

  var bodyDomainRegionList0 *string 

  var bodyDomainRegionList0Value string  = "cn" 

  bodyDomainRegionList0 = &bodyDomainRegionList0Value 

  bodyDomainRegionList = append(bodyDomainRegionList, bodyDomainRegionList0)    

  body.DomainRegionList = bodyDomainRegionList
    
  //域名名称列表，缺省情况下表示全部域名。
  bodyDomainNameList := []*string{}

  var bodyDomainNameList0 *string 

  var bodyDomainNameList0Value string  = "push.example.com" 

  bodyDomainNameList0 = &bodyDomainNameList0Value 

  bodyDomainNameList = append(bodyDomainNameList, bodyDomainNameList0)    

   var bodyDomainNameList1 *string 

  var bodyDomainNameList1Value string  = "pull.example.com" 

  bodyDomainNameList1 = &bodyDomainNameList1Value 

  bodyDomainNameList = append(bodyDomainNameList, bodyDomainNameList1)    

  body.DomainNameList = bodyDomainNameList
  
  resp, err := service.ListDomainDetail(context.Background(), body)

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