You need to enable JavaScript to run this app.
导航
Python SDK 概述
最近更新时间:2023.09.18 20:30:22首次发布时间:2023.09.18 20:30:22

本文介绍了如何安装 Python SDK。

前提条件

安装步骤

使用 PIP 安装SDK for python

pip install --user volcengine

如果已安装 volcengine 包,使用下述命令进行更新

pip install --upgrade volcengine

相关配置

安全凭证配置

火山引擎 SDK for Go 支持以下几种方式进行安全凭证配置:

//方式一:在Client中设置 AK/SK(推荐)
verender = VerenderService()
verender.set_ak("your ak")
verender.set_sk("your sk")       

//方式二:从环境变量加载 AK/SK
VOLC_ACCESSKEY="your ak"
VOLC_SECRETKEY="your sk"
verender = VerenderService()

//方式三:从 HOME 文件加载 AK/SK
//在本地的 ~/.volc/config 中添加如下内容:
  {
    "ak": "Your AK",
    "sk": "Your SK"
  }

初始化配置

边缘渲染客户端的所有 API 均封装在 service/verender/VerenderService.py
所有的接口在使用前都需要初始化 VerenderService 对象,方法如下:

from volcengine.verender.VerenderService import VerenderService

v = VerenderService(ftrans_client_addr="127.0.0.1:8899", ftrans_proxy_addr="127.0.0.1:30001")
v.set_ak("your ak")
v.set_sk("your sk")

示例代码

您可以通过下面的表格查看 Go SDK 的示例代码。
具体的参数解释,请参考相应 SDK 文档。

说明

Go SDK 的示例代码存放于 example 目录下。如需设置 Access Key,请使用 example 目录下的 init.go 文件。如需获取账号的 Access Key,请参考 Access Key(密钥)管理

功能

示例代码(GitHub 链接)

参数解释

传输

上传文件

upload_file_demo.py

上传文件

上传文件夹

upload_folder_demo.py

上传文件夹

下载文件

download_file_demo.py

下载文件

获取文件列表

list_file_demo.py

获取文件列表

获取文件详情

stat_file_demo.py

获取文件详情

删除文件

remove_file_demo.py

删除文件

账号

获取当前登录账号信息

get_current_user_demo.py

获取当前登录账号信息

工作区

获取工作区列表

list_workspace_demo.py

获取工作区列表

渲染配置

获取规格列表

list_cell_specs_demo.py

获取规格列表

创建渲染配置

add_render_setting_demo.py

创建渲染配置

更新渲染配置

update_render_setting_demo.py

更新渲染配置

删除渲染配置

delete_render_setting_demo.py

删除渲染配置

获取渲染配置列表

list_render_setting_demo.py

获取渲染配置列表

获取渲染配置详情

get_render_setting_demo.py

获取渲染配置详情

获取 DCC 软件列表

list_dcc_demo.py

获取 DCC 软件列表

获取插件列表

list_account_dcc_plugins_demo.py

获取插件列表

渲染任务

创建渲染任务

create_render_job_demo.py

创建渲染任务

获取渲染任务列表

list_render_job_demo.py

获取渲染任务列表

获取渲染任务详情

get_render_job_demo.py

获取渲染任务详情

重试渲染任务

retry_render_job_demo.py

重试渲染任务

停止渲染任务

stop_render_jobs_demo.py

停止渲染任务

开始渲染任务

resume_render_jobs_demo.py

开始渲染任务

删除渲染任务

delete_render_jobs_demo.py

删除渲染任务

全速渲染任务

full_speed_render_jobs_demo.py

全速渲染任务

自动全速渲染任务

auto_full_speed_render_jobs_demo.py

自动全速渲染任务

更新渲染任务优先级

update_render_jobs_demo.py

更新渲染任务优先级

获取渲染结果列表

list_job_output_demo.py

获取渲染结果列表

获取单个渲染结果列表

get_job_output_demo.py

获取单个渲染结果列表

更新渲染结果下载状态

update_job_output_demo.py

更新渲染结果下载状态