阅读本文，您可以获取 Python SDK 离线转码的接口调用示例，实现快速开发。

调用说明

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

前提条件

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

调用示例

本节为您介绍离线转码相关接口的功能和调用示例。

创建任务队列

您可以调用 CreateImageTranscodeQueue 接口在指定服务下创建离线转码任务队列。详细的参数说明可参见 CreateImageTranscodeQueue 接口文档。

接口调用示例如下所示。

# coding:utf-8
from volcengine.imagex.v2.imagex_service import ImagexService

if __name__ == '__main__':
    service = ImagexService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    service.set_ak('ak')
    service.set_sk('sk')

    body = {
    	"Name": "offline",
    	"IsStart": true,
    }

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

删除任务队列

您可以调用 DeleteImageTranscodeQueue 接口删除指定的任务队列。详细的参数说明可参见 DeleteImageTranscodeQueue 接口文档。

接口调用示例如下所示。

# coding:utf-8
from volcengine.imagex.v2.imagex_service import ImagexService

if __name__ == '__main__':
    service = ImagexService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    service.set_ak('ak')
    service.set_sk('sk')

    body = {
    	"QueueId": "649a9dbc32**64d44cf5b0",
    }

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

更新任务队列

您可以调用 UpdateImageTranscodeQueue 接口更新指定任务队列的离线转码配置，如队列名称、队列描述和回调配置等。详细的参数说明可参见 UpdateImageTranscodeQueue 接口文档。

接口调用示例如下所示。

# coding:utf-8
from volcengine.imagex.v2.imagex_service import ImagexService

if __name__ == '__main__':
    service = ImagexService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    service.set_ak('ak')
    service.set_sk('sk')

    body = {
    	"Name": "offline",
    	"EnableCallback": true,
    }

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

更新任务队列状态

您可以调用 UpdateImageTranscodeQueueStatus 接口更新指定任务队列的状态，如队列名称、队列描述和回调配置等。详细的参数说明可参见 UpdateImageTranscodeQueueStatus 接口文档。

接口调用示例如下所示。

# coding:utf-8
from volcengine.imagex.v2.imagex_service import ImagexService

if __name__ == '__main__':
    service = ImagexService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    service.set_ak('ak')
    service.set_sk('sk')

    body = {
    	"Id": "649a9dbc32**64d44cf5b0",
    	"Status": "Pnding",
    }

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

获取任务队列

您可以调用 GetImageTranscodeQueues 接口获取当前账号下已创建的任务队列详情。详细的参数说明可参见 GetImageTranscodeQueues 接口文档。

接口调用示例如下所示。

# coding:utf-8
from volcengine.imagex.v2.imagex_service import ImagexService

if __name__ == '__main__':
    service = ImagexService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    service.set_ak('ak')
    service.set_sk('sk')

    query = {
    	"Limit": "100",
    }

    resp = service.get_image_transcode_queues(query)
    print(resp)

提交转码任务

您可以调用 CreateImageTranscodeTask 接口向状态为运行中的任务队列，提交以一条或多条 URL/URI 资源转码执行任务组成的转码任务。详细的参数说明可参见 CreateImageTranscodeTask 接口文档。

接口调用示例如下所示。

# coding:utf-8
from volcengine.imagex.v2.imagex_service import ImagexService

if __name__ == '__main__':
    service = ImagexService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    service.set_ak('ak')
    service.set_sk('sk')

    body = {
    	"QueueId":"649a9dbc3***64d44cf5b0",
		  "DataType":"uri",
      "ServiceId":"5s****fo",
      "DataList":[],
      "FileList":[
         "tos-cn-i-5s***fo/a.txt",
      ],
      "Template":"tplv-5s****fo-33.jpeg",
    }

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

获取任务执行详情

您可以调用 GetImageTranscodeDetails 接口获取指定时间段内的指定队列的转码任务详情。详细的参数说明可参见 GetImageTranscodeDetails 接口文档。

接口调用示例如下所示。

# coding:utf-8
from volcengine.imagex.v2.imagex_service import ImagexService

if __name__ == '__main__':
    service = ImagexService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    service.set_ak('ak')
    service.set_sk('sk')

    query = {
    	"QueueId": "649a9dbc32**064d44cf5b0",
    	"StartTime": 168****599,
    	"EndTime": 168****599,
    	"Limit": 100,
    }

    resp = service.get_image_transcode_details(query)
    print(resp)

手动触发回调

您可以调用 CreateImageTranscodeCallback 接口指定任务条目 ID，手动向该任务队列配置的回调 URL 发送回调信息。详细的参数说明可参见 CreateImageTranscodeCallback 接口文档。

接口调用示例如下所示。

# coding:utf-8
from volcengine.imagex.v2.imagex_service import ImagexService

if __name__ == '__main__':
    service = ImagexService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    service.set_ak('ak')
    service.set_sk('sk')

    body = {
    	"EntryId": "649a9332***0e9cc0a0ed",
    }

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

删除任务执行详情

您可以调用 DeleteImageTranscodeDetail 接口通过指定任务条目 ID，删除提交任务内对应的该条 URL/URI。详细的参数说明可参见 DeleteImageTranscodeDetail 接口文档。

接口调用示例如下所示。

# coding:utf-8
from volcengine.imagex.v2.imagex_service import ImagexService

if __name__ == '__main__':
    service = ImagexService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    service.set_ak('ak')
    service.set_sk('sk')

    body = {
    	"EntryId": "649a9332***80e9cc0a0ec",
    }

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