文档中心

请求结构

最近更新时间：2023.08.02 11:53:37

首次发布时间：2021.11.10 10:29:44

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

如果想获得更加便捷的接入体验，推荐您使用服务端 SDK 来调用 API。

服务地址

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

地域（Region）	服务名（Service）	服务地址
cn-north-1	live	live.volcengineapi.com

通信协议

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

字符编码

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

请求方法

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

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

例如，删除域名的请求方法为 POST，则其请求 URI 为：

POST http://live.volcengineapi.com/?Action=DeleteDomain&Version=2020-08-01

构造 URI

请求 URI 的组成结构：{URI-scheme}://{Endpoint}/?{Query-string}。

alt
参数说明如下表所示。

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

参数

描述

URI-scheme

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

Endpoint

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

Query-string

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

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

请求示例

POST http://live.volcengineapi.com/?Action=CreateDomain&Version=2020-08-01
{
    "Domain":"push-rtmp.yewu.com",
    "Type":"push"
}

返回结果

{
  "ResponseMetadata":{
    "RequestId":"201806041104200100100232280022D30",
    "Action":"CreateDomain",
    "Version":"2020-08-01",
    "Service":"live",
    "Region": "cn-north-1"
  },
}

服务地址

通信协议

字符编码

请求方法

构造 URI