You need to enable JavaScript to run this app.
导航
调用方式
最近更新时间:2024.05.23 15:15:58首次发布时间:2021.02.23 10:42:38

本文为您介绍在使用视频点播 API 时必须了解的一些信息。

请求结构

服务地址

地域名称地域 ID接入地址
华北cn-north-1vod.volcengineapi.com
亚太东南(柔佛)ap-southeast-1vod.ap-southeast-1.volcengineapi.com

说明

亚太东南(柔佛)地域邀测中,仅针对企业用户开放。如您有相关需求,请联系您的商务经理申请开通。亚太东南(柔佛)地域的功能支持情况详见服务地域

通信协议

视频点播支持通过 HTTPHTTPS 两种方式进行请求通信,推荐使用安全性更高的 HTTPS 方式发送请求。

请求方法

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

方法说明

GET(推荐)

请求服务器返回指定资源。

  • 使用 GET 方式,所有参数均放在 Query String 中的。
  • 使用 GET 方式,所有请求参数均需要做 URL 编码。

POST

请求服务器新增资源或执行特殊操作。

  • 使用 POST 方式,所有参数放在 Request Body 中。
  • 使用 POST 方式,POST 方式无需对参数编码。

注意

  • 公共参数中的 ActionVersion 必须放在 Query String 中。
  • 一般情况下推荐使用 GET,当参数字符串过长时推荐使用 POST。
  • 如无特殊说明,您在调用数据统计接口时,只能使用 POST 方法发送请求。同时,您必须在请求头中指定 Content-Type: application/json

请求参数

在发起请求时,需要包含以下两类参数:

  • 公共请求参数:公共请求参数是用于标识账号和接口签名的参数,所有接口都相同。每次请求都需要携带这些参数才能正常发起请求。具体参数介绍请见公共参数
  • 接口请求参数:接口特有的请求参数请参看具体接口文档。

字符编码

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

签名机制

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

返回结果

HTTP 状态码

响应 HTTP 状态码成功请求的情况下均为 200,部分失败请求会返回 4xx 及 5xx 的错误码。

公共返回参数

视频点播的公共返回参数如下表所示。

ResponseMetadata

参数类型描述
RequestIdString请求 ID
ActionString请求接口
VersionString版本
ServiceString服务
RegionString区域
ErrorResponseError异常信息

ResponseError

参数类型描述
CodeString错误码
MessageString详细错误信息

说明

您可以通过返回结果中 ResponseMetadata 结构体是否存在 Error 字段来判断返回结果是否正常。存在 Error 字段则表示返回结果异常。

返回结果示例

正常返回结果

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetSpace",
        "Version": "2020-08-03",
        "Service": "vod",
        "Region": "cn-north-1"
        },
    "Result": {
       ......
    }
}

异常返回结果

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetSpace",
        "Version": "2020-08-03",
        "Service": "vod",
        "Region": "cn-north-1",
        "Error": {
            "Code": "ResourceNotFound",
            "Message": "resource is not found"
      }
   }
}