You need to enable JavaScript to run this app.
视频点播

视频点播

Copy page
Download PDF
Python SDK
集成 Python SDK
Copy page
Download PDF
集成 Python SDK

本文档旨在指导您快速地将视频点播服务端 SDK 集成到您的项目中,并完成初始化。

环境要求

集成步骤

步骤 1:安装 SDK

视频点播 Python SDK 通过 pip 进行管理。打开您的终端,执行以下命令即可安装。

pip install  --user volcengine

tip

  • 强烈建议您前往 GitHub 版本发布历史页面,获取并使用最新版本号,以确保您能使用全部最新的 API 和功能。请安装 v1.0.103 或之后版本。
  • 如果发现接口或功能在当前版本不存在,请执行 pip install --upgrade volcengine,将 SDK 升级到最新版本。
  • 如果在安装时遇到权限问题,可以尝试在命令前添加 sudo(不推荐)。

步骤 2:配置访问凭证(AK/SK)

为了让 SDK 能够验证您的身份并发起 API 调用,您需要配置访问密钥(Access Key)。

tip

在火山引擎控制台的密钥管理页面创建并获取 AK 和 SK。

方式 1:通过环境变量配置(推荐)

此方式将敏感信息与代码解耦,提升了安全性。您只需在运行程序的服务器环境中设置以下两个环境变量即可,SDK 会自动读取。

export VOLC_ACCESSKEY="Your_AK"
export VOLC_SECRETKEY="Your_SK"

方式 2:通过配置文件配置

您可以在用户主目录(~)下创建一个 .volc/config 文件,并按以下 JSON 格式填入您的 AK 和 SK。SDK 会自动从此路径加载凭证。

{
   "ak":"Your_AK",
   "sk":"Your_SK"
}

方式 3:在代码中显式设置

在某些临时测试或特殊场景下,您也可以在代码中直接设置 AK 和 SK。

danger

安全警告:此方式存在敏感信息硬编码在代码中的风险。请不要在生产环境的代码中直接包含 AK 和 SK,以防源码泄露导致密钥丢失。

from volcengine.vod.VodService import VodService

vod_service = VodService()
vod_service.set_ak('Your_AK')
vod_service.set_sk('Your_SK')

步骤 3:初始化客户端实例

完成 SDK 安装和凭证配置后,您就可以初始化视频点播服务的客户端实例 VodService 了。

场景 1:创建默认地域的实例

最简单的方式是创建一个使用默认地域(华北1 cn-north-1)的实例。

from volcengine.vod.VodService import VodService

# 如果您已通过环境变量或配置文件设置 AK/SK,则无需再调用 set_ak/set_sk
vod_service = VodService()

场景 2:创建指定地域的实例

如果您的业务需要访问特定地域(Region)的服务,可以在初始化时传入地域参数。

tip

  • 亚太东南(柔佛)地域仅针对企业用户开放。功能支持情况详见服务地域
  • 如果您需要同时访问多个不同地域的服务,为每个地域创建一个独立的 VodService 实例。
# 创建一个华北1 (cn-north-1) 地域的实例
vod_service1 = VodService('cn-north-1')    

# 创建一个亚太东南1 (ap-southeast-1) 地域的实例
# 亚太东南(柔佛)请使用 v1.0.126 或之后版本
vod_service2 = VodService('ap-southeast-1')  

步骤 4:发起 API 调用

获取到 vod_service 实例后,您就可以调用 call 方法来发起 API 请求了。不同功能模块的接口调用示例,请参见以下文档:

Last updated: 2025.12.18 19:02:55