文档中心

企业直播

API 参考

使用 HTTP 请求调用

您可使用 API 向直播质检的服务端地址发送请求，并按照接口说明在请求中加入相应请求参数。系统会根据请求的处理情况，返回处理结果。本文介绍了直播质检 API 的调用方法，包括请求结构、签名机制和公共错误码。

请求结构

服务地址

API 的服务接入地址，如下表所示。

区域	服务地址
中国大陆	livesaas.volcengineapi.com

通信协议

直播质检支持通过 HTTP 和 HTTPS 两种方式进行请求通信，推荐使用安全性更高的 HTTPS 方式发送请求。

字符编码

请求及返回结果使用 UTF-8 字符集进行编码。

请求方法

根据各个接口的具体需求，选择 GET 或 POST 方式发起请求。

方法	说明
GET	请求服务器返回指定资源。支持将公共信息放置在 header 和 query string 中
POST	请求服务器新增资源或执行特殊操作。仅支持将公共信息放置在 header 中

例如，CreateTask 的请求方法为 POST，则其请求 URI 为：

POST https://livesaas.volcengineapi.com/?Action=CreateTask&Version=2024-08-01

构造 URI

请求 URI 的组成结构：{URI-scheme}://{Domain}/?{query-string}。
参数说明如下表所示。

参数	描述
URI-scheme	表示用于传输请求的协议，支持通过 HTTP 和 HTTPS 2 种方式进行请求通信。
Domain	API 的服务接入地址，直播质检的接入地址为 livesaas.volcengineapi.com，适用于中国大陆。
query-string	查询字符串，包含公共参数和 GET 请求中的查询参数。公共参数：需要包含 Action 和 Version 参数；参数前面需要带一个“?”，公共参数之间用“&”相连。查询参数(GET)：从具体的 OpenAPI 接口文档中获取；查询参数前面需要带一个“?”，形式为“参数名=参数取值”，参数之间用“&”相连。

参数

描述

URI-scheme

表示用于传输请求的协议，支持通过 HTTP 和 HTTPS 2 种方式进行请求通信。

Domain

API 的服务接入地址，直播质检的接入地址为 livesaas.volcengineapi.com，适用于中国大陆。

query-string

查询字符串，包含公共参数和 GET 请求中的查询参数。

公共参数：需要包含 Action 和 Version 参数；参数前面需要带一个“?”，公共参数之间用“&”相连。
查询参数(GET)：从具体的 OpenAPI 接口文档中获取；查询参数前面需要带一个“?”，形式为“参数名=参数取值”，参数之间用“&”相连。

公共请求参数

在发起请求时，必须携带公共参数，否则请求将无法通过合法性验证。详见公共参数。
有关如何配置直播质检对应的公共请求参数值，详见下表。

名称	类型	是否必填	描述	示例值
Action	String	是	接口名称。实际调用时请参考直播质检对应的 API 文档取值。	CreateTask
Version	String	是	接口版本。实际调用时请参考直播质检对应的 API 文档取值。	2024-08-01
Region	String	是	请求的地域。直播质检的地域固定为 `cn-north-1`。	cn-north-1
Service	String	是	请求的服务名。直播质检的服务名固定为 `livesaas`。	livesaas

签名机制

详细的签名机制和签名示例，请参见签名方法。

公共错误码

详细的公共错误码，请参见公共错误码和错误码文档。

最近更新时间：2025.04.15 20:51:42

这个页面对您有帮助吗？

有用

无用

企业直播

请求结构 #

服务地址 #

通信协议 #

字符编码 #

请求方法 #

构造 URI #

公共请求参数 #

签名机制 #

公共错误码 #