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

域名管理

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

首次发布时间：2023.12.28 21:21:53

我的收藏

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

说明

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

调用说明

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

前提条件

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

调用示例

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

添加域名

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 待添加到视频直播服务进行加速的域名，域名只能由数字（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>
      body["Region"] = "cn"

      resp = service.create_domain(body)
      print(resp)

批量添加域名

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 待添加到视频直播服务进行加速的域名列表信息。
      # note：
      # 一个域名空间下最多包含 10 个域名。
      
      create_domain_v2_body_domains = []

      create_domain_v2_body_domains_item = {} 
 
      # 域名名称，域名由字母（A - Z、a -z）、数字（0 - 9）和连字符（-） 组成，长度为 1 到 60 个字符。
      create_domain_v2_body_domains_item["DomainName"] = "push.example.com"
      
      # 证书链 ID。
      create_domain_v2_body_domains_item["ChainID"] = "93cb8cf3*******ece5600142"
      
      # 域名类型，取值及含义如下所示。
      # <li> `push`：推流域名； </li>
      # <li> `pull-flv`：拉流域名。 </li>
      create_domain_v2_body_domains_item["Type"] = "push"
      create_domain_v2_body_domains.append(create_domain_v2_body_domains_item)
      body["Domains"] = create_domain_v2_body_domains

        
      
      # 域名加速区域，包含以下类型。
      # <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 时需要设置。
      body["ProjectName"] = "default"
      
      # 标签列表，vhost 将归类这个 tag 里。
      
      create_domain_v2_body_tags = []

      create_domain_v2_body_tags_item = {} 
 
      # 标签 Key 值。
      create_domain_v2_body_tags_item["Key"] = "key001"
      
      # 标签 Value 值。
      create_domain_v2_body_tags_item["Value"] = "Valuedes"
      
      # 标签类型，支持以下取值。
      # <li> `System`：系统内置标签； </li>
      # <li> `Custom`：自定义标签。 </li>
      create_domain_v2_body_tags_item["Category"] = "Custom"
      create_domain_v2_body_tags.append(create_domain_v2_body_tags_item)
      body["Tags"] = create_domain_v2_body_tags

      resp = service.create_domain_v2(body)
      print(resp)

更新域名的域名空间

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 待修改所属域名空间的的拉流/推流域名，您可以调用 [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 = service.update_domain_vhost(body)
      print(resp)

删除域名

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 待删除域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面，查看需要待禁用域名的信息。
      body["Domain"] = "push.example.com"

      resp = service.delete_domain(body)
      print(resp)

禁用域名

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 待禁用域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面，查看需要待禁用域名的信息。
      body["Domain"] = "push.example.com"

      resp = service.disable_domain(body)
      print(resp)

启用域名

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 待启用域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面，查看需要待启用域名的信息。
      body["Domain"] = "push.example.com"

      resp = service.enable_domain(body)
      print(resp)

查询域名信息

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 待查询域名信息的域名列表。
      
      describe_domain_body_domain_list = []

      describe_domain_body_domain_list_item = []
      describe_domain_body_domain_list_item.append("push.example.com")
      describe_domain_body_domain_list_item.append("pull.example.com")
      describe_domain_body_domain_list.append(describe_domain_body_domain_list_item)

      body["DomainList"] = describe_domain_body_domain_list

      resp = service.describe_domain(body)
      print(resp)

查询域名列表

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

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

if __name__ == '__main__':
      # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
      # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
      service = LiveService("your_host",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])
  
      body = {}
        
      # 查询数据的页码，取值为 1 时表示查询第一页的数据，取值范围为 [1,1000]。
      body["PageNum"] = 1
      
      # 每页显示的数据条数，取值为 10 时表示每页展示 10 条域名信息，取值范围为 [1, 1000]。
      body["PageSize"] = 10
      
      # 域名空间列表，缺省情况下表示查询全部域名空间下的域名。
      
      list_domain_detail_body_vhost_list = []

      list_domain_detail_body_vhost_list_item = []
      list_domain_detail_body_vhost_list_item.append("push.example.com")
      list_domain_detail_body_vhost_list_item.append("pull.example.com")
      list_domain_detail_body_vhost_list.append(list_domain_detail_body_vhost_list_item)

      body["VhostList"] = list_domain_detail_body_vhost_list

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

      list_domain_detail_body_domain_status_list_item = []
      list_domain_detail_body_domain_status_list_item.append("0")
      list_domain_detail_body_domain_status_list_item.append("2")
      list_domain_detail_body_domain_status_list_item.append("3")
      list_domain_detail_body_domain_status_list.append(list_domain_detail_body_domain_status_list_item)

      body["DomainStatusList"] = list_domain_detail_body_domain_status_list

      
      # 域名类型列表，缺省情况下表示全部类型的域名。支持的取值如下所示。
      # <li> `push`：推流域名； </li>
      # <li> `pull-flv`：拉流域名。 </li>
      
      list_domain_detail_body_domain_type_list = []

      list_domain_detail_body_domain_type_list_item = []
      list_domain_detail_body_domain_type_list_item.append("push")
      list_domain_detail_body_domain_type_list_item.append("pull-flv")
      list_domain_detail_body_domain_type_list.append(list_domain_detail_body_domain_type_list_item)

      body["DomainTypeList"] = list_domain_detail_body_domain_type_list

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

      list_domain_detail_body_domain_region_list_item = []
      list_domain_detail_body_domain_region_list_item.append("cn")
      list_domain_detail_body_domain_region_list.append(list_domain_detail_body_domain_region_list_item)

      body["DomainRegionList"] = list_domain_detail_body_domain_region_list

      
      # 域名名称列表，缺省情况下表示全部域名。
      
      list_domain_detail_body_domain_name_list = []

      list_domain_detail_body_domain_name_list_item = []
      list_domain_detail_body_domain_name_list_item.append("push.example.com")
      list_domain_detail_body_domain_name_list_item.append("pull.example.com")
      list_domain_detail_body_domain_name_list.append(list_domain_detail_body_domain_name_list_item)

      body["DomainNameList"] = list_domain_detail_body_domain_name_list

      resp = service.list_domain_detail(body)
      print(resp)