API参考

服务端API

API概述

术语表

接口说明

1）视频点播 API 的服务接入地址-华北三：vod.cn-north-3.inspurcloudapi.com

2）通信协议：支持通过 HTTP 或 HTTPS 通道进行请求通信。为了获得更高的安全性，推荐您使用HTTPS 通道发送请求

3）请求方法：支持 HTTP GET 方法发送请求，这种方式下请求参数需要包含在请求的 URL 中

4）请求参数：每个请求都需要指定要执行的操作，即 Action 参数，以及每个请求都需要包含的公共请求参数和指定操作所特有的请求参数

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

6）返回format：JOSN格式

7）时间参数时区说明：接口中所有时间参数（包括输入参数及输出参数）均为东八区时间

公共请求头

公共参数

调用OpenAPI使用说明

1. 添加依赖：compile ('com.inspur.iam:iam-sdk-java:0.0.1-SNAPSHOT')
2. 调用 SecretUtil.signRequest ( String secretKey, String uri, String httpMethod, Map headers, Map queryParams, String body ) 方法，对请求进行签名。方法入参含义如下： （1）secretKey ：密钥值（由浪潮云颁发） （2）uri：原始HTTP请求uri ( httpRequest.getRequestURI() ) （3）httpMethod：原始HTTP请求方法，如：GET、POST （4）headers：HTTP请求头（必须包含x-sign-algorithm、x-random、x-time。含义见下文） （5）queryParams：原始HTTP请求Query参数（包含form表单参数） （6）body：原始HTTP请求Body体（非form表单请求参数）MD5加密后的字符串 得到签名signatrue。
3. 使用签名发起请求，请求参数需与参与签名的保持一致。向header中追加参数：x-secret-id、x-sign。其中，请求头（header）参数含义如下： （1）x-sign-algorithm，采用的加密方式（支持MD5、SHA256、SHA1） （2）x-random，一组随机数 （3）x-time，当前时间戳（精确到毫秒） （4）x-sign，按照步骤2得到的签名值signatrue （5）x-secret-id，密钥键（由浪潮云颁发）

示例

GET请求，无body参数，java调用示例如下：

  // 组装签名的header参数
  Map headers = new HashMap<>();
  headers.put("x-sign-algorithm", Algorithm.md5.toString());
  headers.put("x-time", String.valueOf(new Date().getTime()));
  headers.put("x-random", UUID.randomUUID().toString().replaceAll("-", ""));
  // 组装查询及表单参数
  Map queryAndFormParams = new HashMap<>();
  queryAndFormParams.put("policyContent", "1");
  // 调用工具方法，进行签名
  String sign = SecretUtil.signRequest("MDg4MzA5OWItYmMzMi00YzU4LWI4NTUtMWNjNzE4NjhjMTdl", "/auth/v1/policies/page/1/20", "GET", headers, queryAndFormParams, null);
  // 将签名值及密钥ID放入header
  headers.put("x-secret-id", "YWYxMjRmZDAtNjQ5ZS00ZjMwLTgyNTYtNTU5MWJhZjIxNjVl");
  headers.put("x-sign", sign);
  // 调用rest接口
  HttpResponse rsp = HttpClientUtil.get("http://localhost:9101/auth/v1/policies/
  page/1/20?policyContent=1", headers, "utf-8")

获取视频上传凭证

接口说明

获取用户上传视频文件的地址，访问接口凭证等信息，同时将用户的文件信息初始化显示到视频点播界面，搭配回调视频详情接口/上传并转码接口使用。fileName(文件名称)长度大小限制200字符以内。

注：该接口不支持fileName（文件名称）参数:包含特殊字符（汉字等等），获取文件上传凭证接口支持。

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? Action=applyUpload
&region=cn-north-3
&fileName=a.mp4
&classId=43124713241
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
"code": "200",
"message": "保存成功",
"data": {
    "bucketRegionName": "cn-north-3",
    "endpoint": "oss.cn-north-3.inspurcloudoss.com",
    "userData": "inspur",
    "secretKey": "MTRkYjZmODktMTJmMS00MGM4LWI4NDgtNGRkMjQ1MjBjYTE2",
    "accessKey": "YTFhZTk4ZTQtMzIwNi00OWU2LTk5OTctMjYyNTZlN2RjOWQx",
    "combinationBucketName": "vod-cn-north-3-fed73505-cc30-42da-943e-6ce0cc2bdcb0",
    "mediaId": "302365657428852736"
    }
}

获取上传凭证

接口说明

只是获取上传的凭证信息，包括上传文件的地址以及访问接口的凭证信息。该接口须搭配媒资信息处理接口使用。

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? Action=applyMediaCertificateUpload
&region=cn-north-3
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
  "code": "200",
  "message": "上传凭证信息获取成功",
  "data": {
      "bucketRegionName": "cn-north-3",
      "endpoint": "oss.cn-north-3.inspurcloudoss.com",
      "userData": "inspur","secretKey": "MTRkYjZmODktMTJmMS00MGM4LWI4NDgtNGRkMjQ1MjBjYTE2",
      "accessKey": "YTFhZTk4ZTQtMzIwNi00OWU2LTk5OTctMjYyNTZlN2RjOWQx",
      "combinationBucketName": "vod-cn-north-3-fed73505-cc30-42da-943e-6ce0cc2bdcb0",
  }
}

获取文件上传凭证

接口说明

该接口是获取视频上传凭证接口的修复版，该接口新增的功能点是支持参数fileName包含特殊字符，文件名称长度大小为200字符以内。具体功能描述参见获取视频上传凭证接口。

注意：fileName参数需要进行Base64加密安全传输，加密方式详见参数说明。

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? Action=applyUpload
&region=cn-north-3
&fileName=a.mp4
&fileSource=apiUpload
&classId=43124713241
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
  "code": "200",
  "message": "保存成功",
  "data": {
      "bucketRegionName": "cn-north-3",
      "endpoint": "oss.cn-north-3.inspurcloudoss.com",
      "userData": "inspur",
      "secretKey": "MTRkYjZmODktMTJmMS00MGM4LWI4NDgtNGRkMjQ1MjBjYTE2",
      "accessKey": "YTFhZTk4ZTQtMzIwNi00OWU2LTk5OTctMjYyNTZlN2RjOWQx",
      "combinationBucketName": "vod-cn-north-3-fed73505-cc30-42da-943e-6ce0cc2bdcb0",
      "mediaId": "302365657428852736"
  }
}

媒资信息处理接口

接口说明

该接口用于将上传的文件信息同步到视频点播界面，并支持对视频文件进行转码，配合获取上传凭证接口使用。查询转码任务可配合查询转码任务接口使用。

注意：fileName参数需要进行Base64加密安全传输，加密方式详见参数说明。

请求

响应

mediaCallBackInfo 文件详情信息

taskInfo 转码详情

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? Action= mediaMessageProcess
&region=cn-north-3
&fileName=a.mp4
&fileSource=apiUpload
&classId=43124713241
&convertTemplateId = 302379581704437760
&watermarkTemplateId = 302379477685698560
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
"code": "200",
"message": "提交转码任务成功",
"data": {
    "codeDesc": "success",
    "code": "200",
    "userData": "",
    "mediaCallBackInfo": {
        "approveStatus": "toApprove",
        "bucketName": "vod-cn-north-3-fed73505-cc30-42da-943e-6ce0cc2bdcb0",
        "updatedTime": "2020-04-14 10:04:00",
        "fileName": "videoTest.mp4",
        "userData": "",
        "fileSuffix": "mp4",
        "filePath": "videoTest.mp4",
        "updatedUserName": "tjlei",
        "fileSource": "apiUpload",
        "memo": null,
        "duration": "0.48",
        "classId": "277859102553735168",
        "deleted": "0",
        "createdUserName": "tjlei","fileSize": "5.0MiB",
        "approveResult": "toApprove",
        "imageUrl": "http://123.56.138.1:8080/group1/M00/00/00/eziKAV6VGg-ASDN3AAElwSHlkFA362.png",
        "createdTime": "2020-04-14 08:53:10",
        "fileUrl": "https://vod-cn-north-3-fed73505-cc30-42da-943e-6ce0cc2bdcb0.oss.cn-north-3.inspurcloudoss.com/videoTest.mp4",
        "id": "302365657428852736",
        "uploadMode": "upload",
        "region": "cn-north-3",
        "durationFormat": "00:00:29"
    },
    "taskInfo": [
        {
            "convertTemplateId": 302379581704437760,
            "inputFileName": "https://vod-cn-north-3-fed73505-cc30-42da-943e-6ce0cc2bdcb0.oss.cn-north-3.inspurcloudoss.com/videoTest.mp4",
            "subTaskId": 302383482675593218,
            "watermarkTemplateId": 302379477685698560
        }
    ],
    "taskId": 302383482675593217
}
}

上传并转码接口

接口说明

该接口用于将文件信息同步到视频点播界面并对视频文件进行转码，配合视频上传凭证/获取文件上传凭证接口使用。

请求

响应

mediaCallBackInfo 文件详情信息

taskInfo 转码详情

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com?action=uploadTranscode
&region=cn-north-3
&mediaId=299912632352190464
&convertTemplateId=283275090279596032
&waterMarkTemplateId=302379477685698560
&userData=inspur

响应示例

{
"code": "200", "message": "新增成功",
"data": {
    "codeDesc": "success",
    "code": "200",
    "userData": "",
    "mediaCallBackInfo": {
        "approveStatus": "toApprove",
        "bucketName": "vod-cn-north-3-fed73505-cc30-42da-943e-6ce0cc2bdcb0",
        "updatedTime": "2020-04-14 10:04:00",
        "fileName": "videoTest.mp4",
        "userData": "",
        "fileSuffix": "mp4",
        "filePath": "videoTest.mp4",
        "updatedUserName": "tjlei",
        "fileSource": "apiUpload",
        "memo": null,
        "duration": "0.48",
        "classId": "277859102553735168",
        "deleted": "0",
        "createdUserName": "tjlei",
        "fileSize": "5.0MiB",
        "approveResult": "toApprove",
        "imageUrl": "http://123.56.138.1:8080/group1/M00/00/00/eziKAV6VGg-ASDN3AAElwSHlkFA362.png",
        "createdTime": "2020-04-14 08:53:10",
        "fileUrl": "https://vod-cn-north-3-fed73505-cc30-42da-943e-6ce0cc2bdcb0.oss.cn-north-3.inspurcloudoss.com/videoTest.mp4",
        "id": "302365657428852736",
        "uploadMode": "upload",
        "region": "cn-north-3",
        "durationFormat": "00:00:29"
    },
    "taskInfo": [
        {
            "convertTemplateId": 302379581704437760,
            "inputFileName": "https://vod-cn-north-3-fed73505-cc30-42da-943e-6ce0cc2bdcb0.oss.cn-north-3.inspurcloudoss.com/videoTest.mp4",
            "subTaskId": 302383482675593218,
            "watermarkTemplateId": 302379477685698560
        }
    ],
    "taskId": 302383482675593217
}
}

回调视频详情接口

接口说明

该接口用于将上传的文件详细信息同步显示到视频点播界面，搭配获取视频上传凭证/获取文件上传凭证/提交转码任务接口使用。

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? Action=callBackMediaInfo&region=cn-north-3&mediaId=282454375987240960&userData=inspur 

响应示例

{
"code": "200",
"message": "查询成功",
"data": {
    "approveStatus": "toApprove",
    "bucketName":"vod-cn-north-3-fed73505-cc30-42da-943e-6ce0cc2bdcb0",
    "updatedTime": "2020-04-14 08:57:16",
    "fileName": "videoTest.mp4",
    "userData": "inspur",
    "fileSuffix": "mp4",
    "filePath": "videoTest.mp4",
    "updatedUserName": "tjlei",
    "fileSource": "apiUpload",
    "memo": null,
    "duration": "0.48",
    "classId": "277859102553735168",
    "deleted": "0",
    "createdUserName": "tjlei",
    "fileSize": "5.0MiB",
    "approveResult": "toApprove","imageUrl": "http://123.56.138.1:8080/group1/M00/00/00/eziKAV6VCmqALEplAAElwSHlkFA212.png",
    "createdTime": "2020-04-14 08:53:10",
    "fileUrl": "https://vod-cn-north-3-fed73505-cc30-42da-943e-6ce0cc2bdcb0.oss.cn-north-3.inspurcloudoss.com/videoTest.mp4",
    "id": "302365657428852736",
    "uploadMode": "upload",
    "region": "cn-north-3",
    "durationFormat": "00:00:29"
}
}

搜索媒资信息

请求

响应

mediaInfo（媒体信息）

basicInfo（基本信息）

videoInfo（元信息）

convertInfo（转码信息）

snapshotInfo（截图信息）

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? Action= searchMedia
&region=cn-north-3
&text=美国大片、警匪
&classId=1234,3456,4677
&startDateStr=2019 08 01 10:15:23
&endDateStr=2019 08 05 10:15:23
&uploadMode=webUpload
&sort=Desc
&start=1
&length=10
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
"code": 200,
"message": "查询成功",
"data": {
    "Response":{
       "mediaInfo"[
             "basicInfo"{
                "mediaId": "93ab850b4fab54b6e91d24d81d4",
                "fileName": "a.mp4",
                "memo": "this is a test file",
                "creationTime":"2019/08/01 10:15:23",
                "updateTime": "2019/08/01 10:15:23",
                "approveResult":"pass",
                "classId": 1234,
                "className"”: "电影-美国-警匪",
                "fileUrl": "http://a.inspurcloud.com/xx/xx/a.mp4",
                "imageUrl":"http://a.inspurcloud.com/xx/xx/a.jpg",
                "uploadMode": "apiUpload"
                },
             "videoInfo"{
                "fileLength": 2048000,
                "containerType":"mp4",
                "bitrate":1024000,
                "height": 1280,
                “width”: 720,
                "duration": 1800
                },
             "convertInfo" [
                {
                "url":"http://xx.vod.inspurcloud.com/xx/xx/a.flv",
                "convertTemplateId": 1100,
                "waterMarkTemplateId": 1200
                }],
             "snapshotInfo" [
                {
                "snapshotTemplateId"”: 1500,
                "url"[
                   "url1":"http://a.inspurcloud.com/xx/xx/0.jpg",
                   "url2":"http://a.inspurcloud.com/xx/xx/1.jpg"
                }]
                ]
       "totalCount":100,
       "userData":"inspur-test"
         }
     }
 }

查询媒资信息

请求

响应

mediaInfo（媒体信息）

basicInfo（基本信息）

videoInfo（元信息）

convertInfo（转码信息）

snapshotInfo（截图信息）

示例

请求示例

https://vod.cn-beijing.inspurcloud.cn? Action= queryMediaInfos
&mediaIds =93ab850b4f6f44eab5481d4,93ab850b4f6f44eab54bd
&userData= inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
"code": 200,
"message": "查询成功",
"data": {
    "Response":{
         "mediaInfo"[
             “basicInfo”{
                "mediaId":"93ab850b4feab54b6e91d24d81d4",
                "fileName":"a.mp4",
                "memo":"this is a test file",
                "creationTime":"2019/08/01 10:15:23",
                "updateTime":"2019/08/01 10:15:23",
                "approveResult":"pass",
                "classId":"1234",
                "className":"电影-美国-警匪",
                "fileUrl":"http://a.inspurcloud.com/xx/xx/a.mp4",
                "imageUrl"”:"http://a.inspurcloud.com/xx/xx/a.jpg",
                "uploadMode":"apiUpload"
                 },
              "videoInfo"{
                "fileLength": 2048000,
                "containerType": "mp4",
                "bitrate":1024000,
                "height": 1280,
                "width": 720,
                "duration": 1800,
                 },
              "convertInfo" [
                 {
                "url":"http://a.inspurcloud.com/xx/xx/a.flv",
                "“convertTemplateId": 1100,
                "waterMarkTemplateId": 1200
                  }],
               "snapshotInfo"[
                  {
                "snapshotTemplateId": 1500,
                "url"[
                   "url1":"http://a.inspurcloud.com/xx/xx/0.jpg"“,
                   "url2": "http://a.inspurcloud.com/xx/xx/1.jpg"
                     ]
                   }]
                ]
           "nonExisMediaIds":"93ab850b4f6f44eab54bd",
           "userData":"inspur-test"
         }
     }
 }

修改媒资信息

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? Action= updateMediaInfo
&region=cn-north-3
&mediaId=93ab850b4f6f44eab5481
&memo=this is a test video
&imageUrl=file/a.jpg
&classId=其他
&userData=inspur-test
&COMMON_PARAMS 
&公共请求参数

响应示例

{
"code": 200,
"message": "修改成功",
"data": {
    "Response":{
        "code":200,
        "codeDesc":"success",
        "userData":"inspur-test"
      }
  }
}

删除媒资

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? Action= deleteMedias
&region=cn-north-3
&mediaId=93ab850b4f6f44eab5481
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
"code": 200,
"message": "删除成功",
"data": {
    "Response":{
        "code":200,
        "codeDesc":"success",
        "userData":"inspur-test"
      }
  }
}

创建分类

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? action= createClass
&region=cn-north-3
&className=movie
&parentId = 354678912123
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
"code": "200",
"message": "新增成功",
"data": {
    "Response": {
        "codeDesc": "success",
        "classId": 302130660298129408,
        "code": "200",
        "userData": "inspur",
        "classLevel": "1",
        "parentId": "354678912123"
    }
  }
}

修改分类

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? action= updateClass
&region=cn-north-3
&classId=1155
&className=movie
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
"code": 200,
"message": "修改成功",
"data": {
    "Response":{
        "code":200,
        "codeDesc":"success",
        "userData ":"inspur-test"
       }
  }
}

删除分类

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? Action= deleteClass
&classId=1155
&region=cn-north-3
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
"code": 200,
"message": "删除成功",
"data": {
    "Response":{
       "code":200,
       "codeDesc":"success",
       "userData ":"inspur-test"
      }
  }
}

查询分类及子分类

请求

响应

classInfo& subClassInfo（分类信息）

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? action= queryClass
&region=cn-north-3
&classId =1155
&sort=Desc
&start=1
&length =10
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
“code”: 200,
"message": 查询成功",
“data”: {
    "Response":{
       “code”:200,
       "codeDesc":"success",
      “classInfo”{
          "classId": “1155”,
          "cateName": "movie ",
          "parentId": “0”,
          "classLevel ": “1”
       },
“subtotal”:20,
“userData”= “inspur-test”,
      “subClassInfo”{
          "classId": “1155”,
          "cateName": " movie ",
          "parentId": “1”,
          " classLevel ": “2”
        },
       }
   }
}

查询用户分类详情

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? Action= queryClassMessage
&region=cn-north-3
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
"code": "200",
"message": "查询成功",
"data": {
    "Response": {
        "classInfo": [
            {
                "fileNumber": "18",
                "isOpen": false,
                "children": [],
                "parentIds": null,
                "className": "其他",
                "id": "277859102553735168",
                "region": "cn-north-3",
                "classLevel": "1",
                "selfFileNumber": "18",
                "classType": "system",
                "parentId": null
            },
            {
                "fileNumber": "1",
                "isOpen": false,
                "children": [
                    {
                        "fileNumber": "1",
                        "isOpen": false,
                        "children": [
                            {
                                "fileNumber": "0",
                                "isOpen": false,
                                "children": [],
                                "parentIds": "302368346149683200,302373559900241920",
                                "className": "测试分类修改",
                                "id": "302373788011659264",
                                "region": "cn-north-3",
                                "classLevel": "3",
                                "selfFileNumber": "0",
                                "classType": "customer",
                                "parentId": "302373559900241920"
                            }
                        ],
                        "parentIds": "302368346149683200",
                        "className": "二级分类",
                        "id": "302373559900241920",
                        "region": "cn-north-3",
                        "classLevel": "2",
                        "selfFileNumber": "1",
                        "classType": "customer",
                        "parentId": "302368346149683200"
                    }
                ],
                "parentIds": null,
                "className": "一级分类",
                "id": "302368346149683200",
                "region": "cn-north-3",
                "classLevel": "1",
                "selfFileNumber": "0",
                "classType": "customer",
                "parentId": ""
            }
        ],
        "codeDesc": "success",
        "code": "200"
    }
  }
}

提交转码任务

接口说明

该接口用于对上传的文件进行转码，或者转码并对转码后文件加水印，返回转码文件的子任务id，以及使用的转码模板id等等，可以使用查询转码任务接口查询转码任务状态。

请求

taskConfig（任务配置）

响应

taskInfo（任务信息）

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? action= submitConvertTask
&region=cn-north-3
&mediaId=aabb01fac74bc
&taskconfig. convertTemplate=1100
&taskconfig. convertTemplate.waterMarkTemplate=1300
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
"code": "200",
"message": "新增成功",
"data": {
    "Response": {
        "codeDesc": "success",
        "code": 0,
        "taskInfo": {
            "subTaskId": 291221525369532416,
            "convertTemplateId": 283275090279596032,
            "watermarkTemplateId": null,
            "inputFileName": "https://vod-cn-north-3-2078420d-fc43-487b-9cb6-dd497a4218b6.oss.cn-north-3.inspurcloudoss.com/testmkv.mkv",
        },
        "taskId": 291221525252091904
    }
  }
}

查询转码任务

接口说明

根据转码任务id查询转码任务的状态以及转码输出文件的路径地址。

请求

响应

converTaskInfo（转码任务信息）

converSubTaskInfo（转码子任务信息集合）

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? action= queryConvertTaskList
&taskId="125xxx65-procedurev2-bff7bc1aabb01fac74bca"
&userData= inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
"code": "200",
"message": "查询成功",
"data": {
    "Response": {
        "codeDesc": "success",
        "code": "200",
        "converTaskInfoList": [
            {
                "converSubTaskInfoList": [
                    {
                        "subTaskId": 300284983846711296,
                        "convertTemplateId": 283275090279596032,
                        "watermarkTemplateId": null,
                        "inputFileName": "https://vod-cn-north-3-2078420d-fc43-487b-9cb6-dd497a4218b6.oss.cn-north-3.inspurcloudoss.com/测试测试呀.mp4",
                        "executeStatus": "completed",
                        "outputFileName": "测试测试呀ajskdj20200408150715.mp4"
                    },
                    {
                        "subTaskId": 293080319628267522,
                        "convertTemplateId": 200928478868574208,
                        "watermarkTemplateId": null,
                        "inputFileName": null,
                        "executeStatus": null,
                        "outputFileName": null
                    }
                ],
                "taskId": "300284983527944192"
            },
            {
                "converSubTaskInfoList": [
                    {
                        "subTaskId": 293078541012684801,
                        "convertTemplateId": 200928478868574208,
                        "watermarkTemplateId": null,
                        "inputFileName": "https://vod-cn-north-3-2078420d-fc43-487b-9cb6-dd497a4218b6.oss.cn-north-3.inspurcloudoss.com/testmp4.mp4",
                        "executeStatus": "completed",
                        "outputFileName": "testmp4MP4-标清-SD20200319191330.mp4"
                    }
                ],
                "taskId": "293078540823941120"
            }
        ],
        "nonExisTaskIds": "291961772134445051"
    }
  }
}

提交截图任务

请求

taskConfig（任务配置）

响应

taskInfo（任务信息）

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? sction= submitSnapshotTask
&region=cn-north-3
&taskconfig. snapshotTemplateId=1100
&taskconfig. timeOffset=00:00:01,00:00:02
& taskConfig.snapshotMode = afterTranscoding
& taskConfig.convertTemplateId = 54325451432
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
“code”: 200,
"message": "新增成功",
“data”: {
        "Response":{
            "taskId": "125xxx65-procefac74bca",
              “taskinfo”{
               “subTaskId”:"125xxx65-prc1aabb01fac74bca",
               “code”:200,
               “codeDesc”:”success”,
               “snapshotTemplateId”:1100,
               “snapshotType”:” timing”,
               “timeOffset”:”12:30:30，12:30:50”,
          },
           “userData”:”inspur-test”
       }
   }
}

查询截图任务

请求

响应

snapshotTaskInfo（截图任务信息集合）

converSubTaskInfo（转码子任务信息集合）

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? action=querySnapshotTaskList
&taskIds ="125xxx65-procedurev2-bffb15f0753c74bca"
&userData= inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
"code": "200",
"message": "查询成功",
"data": {
    "Response": {
        "codeDesc": "success",
        "code": "200",
        "snapshotTaskInfoList": [
            {
                "taskId": "302405333697507328",
                "snapshotSubTaskInfoList": [
                    {
                        "snapshotTemplateId": 302002816599523328,
                        "snapshotType": "timing",
                        "inputFileName": "https://vod-cn-north-3-2078420d-fc43-487b-9cb6-dd497a4218b6.oss.cn-north-3.inspurcloudoss.com/final.mp4",
                        "imageUrl": [
                            "https://vod-cn-north-3-2078420d-fc43-487b-9cb6-dd497a4218b6.oss.cn-north-3.inspurcloudoss.com/final测测测202004141133021.jpg",
                            "https://vod-cn-north-3-2078420d-fc43-487b-9cb6-dd497a4218b6.oss.cn-north-3.inspurcloudoss.com/final测测测202004141133020.jpg"
                        ],
                        "executeStatus": "completed",
                        "timeOffset": "[[\"00:00:01\",\"00:00:02\"]]",
                        "subTaskId": 302405333697507329
                    }
                ]
            }
        ]
    }
  }
} 

新增自定义转码模板

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? action= addConvertTemplate
&region=cn-north-3
&name=testConvertTemplate
&region= cn-north-3
&ontainer=MP4
&vIdeo. codec =H.264
&vIdeo. profile =high
&vIdeo. bitrate =500
&vIdeo. wIdth=1920
&vIdeo. height =1080
&vIdeo. FPS=25
&audio. Codec=12
&audio. Samplerate=21
&audio. Bitrate=12
&audio. Channels=2
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
“code”: 200,
"message": "新增成功",
“data”: {
    "Response": {
        “code”: 200,
        "codeDesc": "success",
        "convertTemplateId": 204167573938982912,
"userData":"inspur-test"
        }
    }
}

查询自定义转码模板

请求

响应

templateInfo（模板信息）

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? action= queryConvertTemplate List
& templateId =1140
&&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
"code":200,
"message": "查询成功",
“data”: {
    "Response": {
    "code": 200,
    "codeDesc": "success",
    "nonExisTemplateIds": "123;2041",
    "userData":"inspur-test",
        "templateInfoList": [
            {
                "container": "MP4",
                "convertTemplateId": 203920872454049792,
                "name": "testConvertTemplate333444",
                "video": {
                    "Codec": "H.264",
                    "FPS": 25,
                    "Height": 1920,
                    "Bitrate": 500,
                    "Width": 1080,
                    "Profile": "High"
                },
                "audio": {
                    "Codec": "MP3",
                    "Samplerate": 32000,
                    "Bitrate": 33,
                    "Channels": 4
                },
                "region": "cn-north-3"
            }
        ]
    }
  }
}

删除自定义转码模板

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? action= deleteConvertTemplate
&region=cn-north-3
&templateId"=1140
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
“code”: 200,
"message": "删除成功",
“data”: {
    "Response": {
         "code": 200,
         "codeDesc": "success",
         "userData"="inspur-test"
    }
  }
}

新增水印模板

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? action= addWaterMarkTemplate
&name=testConvertTemplate
&region=cn-north-3
&imageURL=inpurtexample/a.jpg
&left =10
&top=10
&wIdth =100
&height =100
&resolutionHeight=1280
&resolutionWidth =720
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
“code”: 200,
"message": "新增成功",
“data”: {
    "Response":{
       "code":200,
       "codeDesc":"success",
       "templateID":1155,
      "userData":”inspur-test”
    }
  }
}

查询水印模板

请求

响应

templateInfo（模板信息）

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? action= queryWaterMarkTemplateList
&TemplateId=1140
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
“code”: 200,
"message": "查询成功",
“data”: {
    "Response": {
    "code": 200,
        "codeDesc": "success",
        “templateInfo”{
           "WaterMarkTemplateId": 1100,
           "name": " testConvertTemplate ",
           "region": "cn-north-3",
           "left":10,
           "top":10,
           "wIdth":10,
           "height":10,
           " resolutionHeight ": 1280,
          “resolutionWIdth”:720
         },
       "nonExisTaskIds":"125xxx65-procedure ",
      “userData”:"inspur-test"
    }
  }
}

删除水印模板

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? action= deleteWaterMarkTemplate
&region=cn-north-3
&templateId=1140
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
“code”: 200,
"message": "删除成功",
“data”: {
    "Response": {
        "code": 200,
        "codeDesc":"success",
        "userData":"inspur-test"
    }
  }
}

新增截图模板

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com?
&action= addSampleSnapshotTemplate
&name=testSampleSnapshotTemplate
&region= cn-north-3
&imagetype=JPG
&wIdth =1920
&height =1080
&sampleType =precent
&sample Value =10
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
“code”: 200,
"message": "新增成功",
“data”: {
    "Response": {
    "code": 200,
    "codeDesc":"success",
    "templateId":203092838401003520,
    "userData":"inspur-test"
    }
  }
}

查询截图模板

请求

响应

templateInfo（模板信息）

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com?
action= querySnapshotTemplateList
&templateId"=1140
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
“code”: 200,
"message": "查询成功",
“data”: {
    "Response": {
        "code":200,
        "codeDesc":"success",
        "userData":"inspur-test",
        "templateInfo": [
            {
                "snapshotTemplateId": 204282398219272192,
                "name": "test",
                "region": "cn-north-3",
                "imagetype": "jpg",
                "width": 20,
                "height": 20,
                "snapshotType": 2,
                "sampleType": " seconds ",
                "sampleValue": "10"
            }
        ]
    }
  }
}

删除截图模板

请求

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? action= deleteSnapshotTemplate
&templateId:1140
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
“code”: 200,
"message": "删除成功",
“data”: {
    "Response": {
    "code":200,
        "codeDesc":"success",
        "userData":"inspur-test"
    }
  }
}

人工审核

请求

auditContent（审核内容）

响应

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com? action= createAudit
&region=cn-north-3
&audit = [{"approveResult":"disable","mediaId":"mediaId"}](base64转换)
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
“code”: 200,
"message": "查询成功",
“data”: {
    "Response": {
        "code":200
        "codeDesc":"success",
        "userData":"inspur-test"
    }
  }
}

获取人工审核历史

请求

响应

historie（审核信息）

示例

请求示例

https://vod.cn-north-3.inspurcloudapi.com?action= queryAuditHistory
&region=cn-north-3
&mediaId=xx65-prc1
&sort=DESC
&userData=inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

{
"code": "0",
"message": "查询成功",
“data”: {
    "Response": {
        "code":200,
        "codeDesc":"success",
        "userData":"inspur-test",
        "approveResult":"pass",
        " historie ": [
            {
                " creationTime ":"2019-08-08 12:12:12",
                "approveResult ":"pass"
            }
        ]
    }
  }
}

事件通知

接口概述

每个区域可以单独配置事件通知的回调方式和回调地址。在视频点播（如转码、水印、截图）任务完成后，视频点播服务会根据存储区域配置的回调方式和回调地址及时通知用户。

功能列表

接口说明

HTTP回调流程

HTTP(HTTPS)回调：您需要部署一个HTTP服务来接收回调消息，并在视频点播控制台上配置回调URL；当事件产生时，服务端会向该URL发起HTTP POST请求，具体内容将通过HTTP Body送达。

配置方法

1. 登录浪潮云-视频点播控制台；
2. 在左侧导航栏中，选择【全局设置】>【回调配置】，进入回调配置管理页面；
3. 在 “回调配置” 栏中，单击【编辑】，将 “回调URL” 设置为 App 后台接收回调的地址；
4. 在 “回调模式” 栏中，单击【编辑】，将 “回调模式” 选择为 “普通回调”；
5. 在 “事件回调配置” 栏中，单击【编辑】，选择您需要开启的事件回调类型。

回调协议

1. 请求：HTTP POST 请求，包体内容为 JSON ，每一种回调的具体包体内容参见详细需求说明；
2. 应答：服务端忽略应答包内容。

回调判断与重试

1. 服务发起HTTP回调时，若回调接收服务响应的HTTP状态码为200即视为回调成功；响应状态码不为200，或是响应时间超过5秒出现超时，都视为回调失败。服务会忽略响应的包体内容，仅以HTTP状态码为准；
2. 若由于配置异常（比如您的回调地址错误、消息接收服务异常等），导致消息回调失败，点播服务会继续重试回调2次，即总共最多回调3次；超过后会丢弃。

时间参数说明

接口中所有时间参数，均为东八区时间。

公共参数

转码任务完成回调

接口说明

视频点播中的转码任务完成时会产生此事件。

请求

taskData(任务数据)

示例

请求示例

 {
"userData": "",
"taskDataList": {
    "output": {
        "bucket": "vod-cn-north-3-fed73505-cc30-42da-943e-6ce0cc2bdcb0",
        "region": "cn-north-3"
    },
    "duration": "3.433",
    "outputFileName": "dassdaMP4-标清-SD20200227111933.mp4",
    "input": {
        "bucket": "vod-cn-north-3-fed73505-cc30-42da-943e-6ce0cc2bdcb0",
        "path": "dassda.mp4",
        "region": "cn-north-3"
    },
    "codeDesc": "success",
   “convertStatus”:”success”,
    "code": 200,
    "convertTemplateID": "200928478868574208",
    "mediaId": "282488161241858048",
    "waterMarkId": "282555819362549760",
    "subTaskId": "285369821130063872"
},
"eventTime": "2020-02-27T11:20:40.294+08:00",
"eventType": "convertTaskComplete",
"version": "2019-10-24",
"taskId": "285369821117480960"
}

截图任务完成回调

接口说明

视频点播中的截图任务完成时会产生此事件。

请求

taskData(任务数据)

示例

请求示例

 {
 "version": "2019-10-24",
 "eventType": "SnapshotTaskComplete",
 "taskID": "1edb7eb88a599d05abe451cfc541cfbd",
 "taskData": {
       "subTaskId":"1edb7eb88a599be451cfc541cfbd",
       "code":200,
       "codeDesc":"success”,
       "convertStatus":"success",
       "mediaId" =“aabb01fac74bc",
       "imageUrlList” [
                      "url0":"http://a.inspurcloud.com/xx/xx/0.jpg",
                      "url1":"http://a.inspurcloud.com/xx/xx/1.jpg"
                      ],
       "duration": 599,
       "snapshotTemplateId": 1100
       }
  }

上传任务完成回调

接口说明

视频点播中的媒资文件上传完成时会产生此事件。

请求

taskData(任务数据)

示例

请求示例

 {
 "version":"2019-10-24",
 "eventType":"uploadMediaComplete",
 "taskID":"1edb7eb88a599d05abe451cfc541cfbd",
 "Data": {
     "subTaskId":"1edb7eb88a599be451cfc541cfbd",
     "code": 200,
     "codeDesc":"success",
     "mediaId"="aabb01fac74bc",
     "duration": 599,
     "mediaUrl":"http://xx.vod.inspurcloud. com/a.mp4"
         }
   }

接口访问限制

1. 每个用户调用接口次数：100次/秒；
2. 整套open API接口调用次数：1000次/秒；
3. 超过最大调用次数，限制访问。