公共请求头与响应头
更新时间:2024-12-05
公共请求头域
公共请求头域是您调用API时必须填写的HEADER参数。除公共头域外是否还需要填入其他HEADER参数,需要参考具体接口的文档。
公共头域 | 描述 |
---|---|
Authorization | 包含Access Key与请求签名。详见鉴权认证 |
Content-Type | application/json; charset=utf-8。 |
x-bce-date | 表示日期的字符串,符合API规范。具体请参考日期与时间规范 |
HTTP协议的标准头域不在这里列出。公共头域将在每个VOD API中出现,是必需的头域。POST、PUT等请求数据需放在request body中。
公共响应头
公共头域 | 描述 |
---|---|
Content-Type | application/json; charset=utf-8。 |
x-bce-request-id | BCC后端生成,并自动设置到响应头域中。 |
其中,x-bce-request-id 使用UUID version4由VOD服务生成,用于请求链路追踪。
举例说明,下面是获取指定媒资信息时的请求头和响应头示例:
Http
1GET /v2/medias/<mediaId> HTTP/1.1
2accept-encoding: gzip, deflate
3x-bce-date: 2024-03-24T13:04:26Z
4host: vod.bj.baidubce.com
5accept: */*
6connection: keep-alive
7x-bce-request-id: 47281222-f0ff-4f80-9a4d-0140ff77dcd0
8content-type: application/json
9authorization: <authorization>
VOD的API服务采用JSON格式的消息体作为响应返回的格式。下面是一个标准的用户查询指定媒资时的完整的请求返回示例:
Http
1HTTP/1.1 200 OK
2Transfer-Encoding: chunked
3x-bce-request-id: 47281222-f0ff-4f80-9a4d-0140ff77dcd0
4Cache-Control: no-cache
5Server: BWS
6Date: Tue, 24 Mar 2024 13:04:27 GMT
7Content-Type: application/json;charset=UTF-8
8
9{
10 "mediaId": "mda-ehhqq89pi6e15n0y",
11 "name": "demo",
12 "description": "",
13 "banStatus": "NORMAL",
14 "createTime": "2024-03-08T06:52:14Z",
15 "source": {
16 "sourceType": "UPLOAD",
17 "sourceUrl": "https://vod.baidu.com/mda-ehhqq89pi6e15n0y/mda-ehhqq89pi6e15n0y.mp4"
18 },
19 "sourceMetadata": {
20 "fileSizeInByte": 5331627,
21 "type": "video",
22 "container": "mov,mp4,m4a,3gp,3g2,mj2",
23 "durationInSecond": 25,
24 "durationInMillisecond": 24860,
25 "video": {
26 "codec": "h264",
27 "heightInPixel": 720,
28 "widthInPixel": 1280,
29 "bitRateInBps": 1085953,
30 "frameRate": 50.0,
31 "dar": "16:9"
32 },
33 "audio": {
34 "codec": "flac",
35 "channels": 1,
36 "sampleRateInHz": 44100,
37 "bitRateInBps": 623953
38 },
39 "etag": "e2003ba24ed0437e4650a2ac25b70c5c"
40 }
41}