API参考

服务端API

API概述

术语表

接口说明

1）媒体处理服务 API 的服务接入地址-华北三：mps.cn-north-3.inspurcloudapi.com

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

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

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

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

6）返回format：JOSN格式

公共请求头

公共参数

调用OpenAPI使用说明

引入jar包

首先引入jar包：iam-sdk-java-0.01-SNAPSHOT.jar

使用说明

1. 添加依赖：compile('com.inspur.iam:iam-sdk-java:0.0.1-SNAPSHOT')或者引入jar包
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")

提交转码任务接口

请求

input（输入参数）

output（输出参数）

taskConfig（任务配置）

响应

taskInfo（任务信息）

示例

请求示例

 https://mps.cn-north-3.inspurcloudapi.com? action= submitConvertTask
 &input.region= oss-cn-beijing
 &input.bucket= example-bucket
 &input.path= inpurtexample/a.flv
 &onput.region= oss-cn-beijing
 &output.bucket= example-bucket
 &output.dir=/outputexample
 &taskconfig. converttemplate.1=1100
 &taskconfig. converttemplate.1.waterMarkTemplate=1300
 &userData= inspur-test
 &COMMON_PARAMS &公共请求参数

响应示例

示例

请求示例

https://mps.cn-north-3.inspurcloudapi.com? action= submitConvertTask
&input.region= oss-cn-beijing
&input.bucket= example-bucket
&input.path= inpurtexample/a.flv
&onput.region= oss-cn-beijing
&output.bucket= example-bucket
&output.dir=/outputexample
&taskconfig. converttemplate.1=1100
&taskconfig. converttemplate.1.waterMarkTemplate=1300
&userData= inspur-test
&COMMON_PARAMS &公共请求参数

响应示例

    {
     "code": "0",
     "message": "新增成功",
     "result": {
        "Response":{
            "taskId": "125bca",
               "taskinfo"{
                   "subTaskId":"b57bc1aabb01fac74bca,
                  "code":0,
                   "codeDesc":"success",
                "convertTemplateId":"1100",
                "waterMarkTemplate":"1300",
                "inputFilename":"test.mp4"
                }
              "userdata":"inspur-test"
           }
           }
     }
  }

查询转码任务接口

请求

响应

converTaskInfo（转码任务信息）

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

示例

请求示例

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

响应示例

{
  "code": "0",
  "message": "查询成功",
  "result": {
    "Response":{
        "converTaskInfoList": [{
            taskId":"125c74bca",
            converSubTaskInfoList[{
                 "subTaskId":"xx65-procedu",
                   "state":"submitted",
                 "convertTemplateId":"1100",
                 "waterMarkTemplate":”1300”,
                 "inputFilename":"test.mp4"
             },
             {
                 "subTaskId":"xx65-procedu",
                   "state":"submitted",
                 "convertTemplateId":"1100",
                 "waterMarkTemplate":”1300”,
                 "inputFilename":"test.mp4"
             }
             ]
       } ]
        "userData":"inspur-test",
        "nonExisTaskIds":"125xxx65-prure; 127xxx65-procedure"
    }
  }
}

提交截图任务接口

请求

input（输入参数）

output（输出参数）

taskConfig（任务配置）

响应

taskInfo（任务信息）

示例

请求示例

 https://mps.cn-north-3.inspurcloudapi.com? sction= submitSnapshotTask
 &input.region= oss-cn-beijing
 &input.bucket= example-bucket
 input.path= inpurtexample/a.flv
 &output.region= oss-cn-beijing
 &output.bucket= example-bucket
 &output.dir=/outputexample
 &Taskconfig. snapshotTemplateId =1100
 &Taskconfig. timeOffset.0 =12:30:30
 &Taskconfig. timeOffset.1 =12:30:35
 & userData= inspur-test
 &COMMON_PARAMS &公共请求参数

响应示例

{
"code": "0",
"message": "新增成功",
"result": {
        "Response":{
            "taskId": "125xxx65-procefac74bca",
              “taskinfo”{
            “subTaskId”:"125xxx65-prc1aabb01fac74bca",
               “code”:0,
               “codeDesc”:”success”,
               “snapshotTemplateId”:”1100”,
               “snapshotType”:” timing”,
               “timeOffset”:“12:30:30，12:30:50”,
               “inputFilename”:”test.mp4”
          }
          “userdata”:”inspur-test”
       }
    }
 }

查询截图任务接口

请求

响应

snapshotTaskInfo（截图任务信息集合）

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

示例

请求示例

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

响应示例

{
"code": "0",
"message": "查询成功",
"result": {
    "Response":{
       "snapshotTaskInfoList": [{        
               taskId":"125xxx65-proabb01fac74bca",
               snapshotSubTaskInfoList[{
                   “subTaskId”:"125xxc1aab74bca",
                “state”:”submitted”,
                “snapshotTemplateId”:”1100”,
                “snapshotType”:” timing”,
                “timeOffset”:“12:30:30，12:30:50”,
                “ inputFilename”:”test.mp4”
                }
                {
                “subTaskId”:"125xxx65-ca",
                “state”:”submitted”,
                “snapshotTemplateId”:”1100”,
                “snapshotType”:” timing”,
                “timeOffset”:“12:30:30，12:30:50”,
                “ inputFilename”:”test.mp4”
                } ]
       } ]
      “userData”:“inspur-test”,
      “nonExisTaskIds”:” 125xxx65-procedure; 127xxx65-pdure”
     }
   }
 }

新增自定义转码模板接口

请求

响应

示例

请求示例

 https://mps.cn-north-3.inspurcloudapi.com? action= addConvertTemplate
 &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
 &COMMON_PARAMS &公共请求参数

响应示例

{
"code": "0",
"message": "新增成功",
"result": {
    "Response": {
        "codeDesc": "success",
        "code": 0,
        "convertTemplateId": 204167573938982912
    }
  }
}

查询自定义转码模板接口

请求

响应

templateInfo（模板信息）

示例

请求示例

  https://mps.cn-north-3.inspurcloudapi.com? action= queryConvertTemplate List
  ConvertTemplateId"="1140"
  &COMMON_PARAMS &公共请求参数

响应示例

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

删除自定义转码模板接口

请求

响应

示例

请求示例

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

响应示例

{
"code": "0",
"message": "删除成功",
"result": {
    "Response": {
        "codeDesc": "success",
        "code": 0
    }
  }
}

新增水印模板接口

请求

响应

示例

请求示例

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

响应示例

{
"code": "0",
"message": "新增成功",
"result": {
    "Response":{
       "code":0
       "codeDesc":"success"
       "templateID":"1155"
     }
   }
 }

查询水印模板接口

请求

响应

templateInfo（模板信息）

示例

请求示例

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

响应示例

{
"code": "0",
"message": "查询成功",
"result": {
    "Response": {
        "codeDesc": "success",
        "code": 0,
        templateInfo{
           "WaterMarkTemplateId": "1100",
           "name": " testConvertTemplate ",
           "region": "cn-north-3",
           "left":"10px",
           "top":"10px",
           "wIdth":"10px",
           "height":"10px",
           " resolution_ height ": "1280px",
           “resolution_ wIdth”:”720px”
         }
       "nonExisTaskIds":"125xxx65-procedure; 127xxx65-procedure"    
     }
   }
 }

删除水印模板接口

请求

响应

示例

请求示例

 https://mps.cn-north-3.inspurcloudapi.com? action= deleteWaterMarkTemplate
 & templateId "="1140"
 &COMMON_PARAMS &公共请求参数

响应示例

{
"code": "0",
"message": "删除成功",
"result": {
    "Response": {
        "codeDesc": "success",
        "code": 0
    }
   }
  }

新增截图模板接口

请求

响应

示例

请求示例

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

响应示例

{
"code": "0",
"message": "新增成功",
"result": {
    "Response": {
    "codeDesc": "success",
    "code": 0,
    "templateId": "203092838401003520"
    }
  }
}

查询截图模板接口

请求

响应

templateInfo（模板信息）

示例

请求示例

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

响应示例

{
"code": "0",
"message": "查询成功",
"result": {
    "Response": {
        "codeDesc": "success",
        "code": 0,
        "templateInfo": [
            {
                "snapshotTemplateId": "204282398219272192",
                "name": "2",
                "region": "cn-north-3",
                "imagetype": "2",
                "width": "2",
                "height": "2",
                "snapshotType": "2",
                "sampleType": "2",
                "sampleValue": "2"
             }
          ]
       }
    }
 }

删除截图模板接口

请求

响应

示例

请求示例

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

响应示例

{
"code": "0",
"message": "删除成功",
"result": {
    "Response": {
        "codeDesc": "success",
        "code": 0
    }
  }
}

事件通知接口

回调接口概述

回调接口说明

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

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

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

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

回调公共参数

转码任务完成回调

请求

taskData(任务数据)

input（输入参数）

output（输出参数）

示例

请求示例

 {
  "version": "2018-03-03",
  "eventType": " convertTaskComplete ",
  “taskID”:” 1edb7eb88a599d05abe451cfc541cfbd”,
  "taskData": {
       “subTaskId”:” 1edb7eb88a599be451cfc541cfbd”,
       " code ": 0,
       " codeDesc ": “success”,
      “Input”{
         “region”:“oss-cn-beijing”
         “bucket ": " example-bucket ",
         “path ": " inpurtexample/a.flv "
          },
      "output "{
         “region”:“oss-cn-beijing”
         “bucket ": " example-bucket ",
         “path":/outputexample/ a.flv ",
          } 
        "duration": 599,
        " convertTemplateId ": 1100,
       “waterMarkId” : 1100
     }
   }

截图任务完成回调

请求

taskData(任务数据)

input（输入参数）

output（输出参数）

示例

请求示例

{
 "version": "2018-03-03",
 "eventType": " SnapshotTaskComplete ",
 taskID”:” 1edb7eb88a599d05abe451cfc541cfbd”,
 "Data": {
   “subTaskId”:” 1edb7eb88a599be451cfc541cfbd”,
   " code ": 0,
   " codeDesc ": “success”,
   “Input”{
      “region”:“oss-cn-beijing”
      “bucket ": " example-bucket ",
      “path ": " inpurtexample/a.flv "
    },
   "output "{
      “region”:“oss-cn-beijing”
      “bucket ": " example-bucket ",
      “path":/outputexample/ a.flv ",
    } 
   "duration": 599,
   " snapshotTemplateId ": 1100,
  }
}