域名管理--视频直播-火山引擎

文档中心

立即注册

导航

域名管理

最近更新时间：2024.09.14 11:16:50首次发布时间：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__":
    # 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
    # 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
    service = LiveService(
        "live.volcengineapi.com",
        os.environ["VOLC_ACCESSKEY"],
        os.environ["VOLC_SECRETKEY"],
    )

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

    body = {
        # 待添加到视频直播服务进行加速的域名列表信息。
        # note：
        # 一个域名空间下最多包含 10 个域名。
        "Domains": [
            {
                # 域名名称，域名由字母（A - Z、a -z）、数字（0 - 9）和连字符（-） 组成，长度为 1 到 60 个字符。
                "DomainName": "push.example.com",
                # HTTPS 证书链 ID，默认为空表示不为域名绑定 HTTPS 证书。您可以调用 [ListCertV2](https://www.volcengine.com/docs/6469/1126823) 接口或在视频直播控制台的[证书管理](https://console.volcengine.com/live/main/certificate)页面，获取待绑定的证书链 ID。
                "ChainID": "93cb8cf3*******ece5600142",
                # 域名类型，取值及含义如下所示。
                # <li> push：推流域名； </li>
                # <li> pull-flv：拉流域名。 </li>
                "Type": "push",
                # 域名加速区域，取值及含义如下所示。
                # <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": "push.example.com",
        # 为域名空间设置所属项目，默认为空表示归属到 default 项目，
        # 新建域名空间时需要为域名空间绑定项目，您可以在[访问控制-项目列表](https://console.volcengine.com/iam/resourcemanage/project)查看已有项目并对项目进行管理。
        # 项目是火山引擎提供的一种资源管理方式，您可以对不同业务或项目使用的云资源进行分组管理，以实现基于项目的账单查看、子账号授权等功能。
        # <li> 新建域名空间时，需为域名空间设置所属项目。每个域名空间只能属于一个项目，选择已有的域名空间时，项目不可配置； </li>
        # <li> 使用基于项目的账单查看需提前开通分账服务，请前往[账单管理-分账账单](https://console.volcengine.com/finance/bill/split-bill/)进行服务开通； </li>
        # <li> 使用基于项目的子账号授权请参见[使用 IAM 用户进行项目权限划分](https://www.volcengine.com/docs/6469/1166573)。 </li>
        "ProjectName": "default",
        # 为域名空间设置资源标签。您可以通过资源标签从不同维度对云资源进行分类和聚合管理，如资源分账等场景。
        # note：
        # 如需使用标签进行资源分账，可以在可以在[账单管理-费用标签](https://console.volcengine.com/finance/bill/tag/)处管理启用标签，将对应标签运用到账单明细等数据中。
        "Tags": [
            {
                # 标签 Key 值。
                "Key": "key001",
                # 标签 Value 值。
                "Value": "Valuedes",
                # 标签类型，支持以下取值。
                # <li> System：系统内置标签； </li>
                # <li> Custom：自定义标签。 </li>
                "Category": "Custom",
            }
        ],
    }

    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__":
    # 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
    # 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
    service = LiveService(
        "live.volcengineapi.com",
        os.environ["VOLC_ACCESSKEY"],
        os.environ["VOLC_SECRETKEY"],
    )

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

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

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

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

    body = {
        # 待查询域名信息的域名列表。
        "DomainList": ["push.example.com", "pull.example.com"],
    }

    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__":
    # 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
    # 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
    service = LiveService(
        "live.volcengineapi.com",
        os.environ["VOLC_ACCESSKEY"],
        os.environ["VOLC_SECRETKEY"],
    )

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

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