产品文档

媒体处理服务

submitTranscodeJob

描述

提交转码作业

请求方式

POST

请求地址

https://mps.jdcloud-api.com/v1/transcodeJobs:submit

请求参数

名称 类型 是否必需 默认值 描述
accessKey String True 输入对象存储 accessKey,必须参数
secretKey String True 输入对象存储 accessKey,必须参数
endpoint String True 输入对象存储 endpoint。必须参数,内网域名,如 s3-internal.cn-north-1.jcloudcs.com
bucket String True 输入对象存储 bucket,必须参数
objectKey String True 输入对象存储 objectKey,必须参数
title String False 输入视频标题,可选参数,默认会从 objectKey 中截取
templateIds String[ ] True 转码模板ID集合,必须参数,非空集合
outputConfig TranscodeOutputConfig True 输出配置,必须参数
additionalProperties String False 附加参数,JSON格式的字符串。除非清楚了解其用途和用法,请勿使用此字段。
若参数在本次作业提交所关联的模板中,存在相同用途的对应字段,则该属性值会覆盖模板中的对应字段;
若参数在本次作业提交所关联的模板中,不存在相同用途的对应字段,则该属性值会作为补充设置,用于生产任务;
有特殊说明的除外。
当前支持的附加参数:
- hls.encrypt.key - HLS加密公钥,对应于转码模板中 encryption.hlsKey 字段
- hls.encrypt.keyUrl - HLS加密公钥地址,对应于转码模板中 encryption.hlsKeyUrl 字段
- hls.encrypt.encodeType - HLS加密公钥编码方式,对应于转码模板中 encryption.hlsKeyEncodeType 字段
特殊说明:
- HLS加密相关参数,具有完整性要求,故 hls.encrypt 命名空间下的附加参数,依赖于 hls.encrypt.key 参数的设置情况。若设置 hls.encrypt.key 参数,则命名空间 hls.encrypt 下的其他参数也须同时设置;否则,其他参数会被忽略。

TranscodeOutputConfig

名称 类型 是否必需 默认值 描述
accessKey String False 输出对象存储 accessKey,可选参数,默认与输入 accessKey 保持一致
secretKey String False 输出对象存储 secretKey,可选参数,默认与输入 secretKey 保持一致
endpoint String False 输出对象存储 endpoint。可选参数,内网域名,默认与输入 endpoint 保持一致,如 s3-internal.cn-north-1.jcloudcs.com
bucket String False 输出对象存储 bucket,可选参数,默认与输入 bucket 保持一致
outputList TranscodeOutputObject[ ] True 输出集合,必须参数,非空集

TranscodeOutputObject

名称 类型 是否必需 默认值 描述
objectKey String True 输出对象存储 objectKey,必须参数
templateId String True 关联模板ID,必须参数

返回参数

名称 类型 描述
result Result 提交转码作业结果
requestId String 请求ID

Result

名称 类型 描述
jobId String 转码作业ID
taskIds String[ ] 转码任务ID集合

返回码

返回码 描述
200 OK
400 Invalid parameter
401 Authentication failed
500 Internal server error
503 Service unavailable

请求示例

POST

https://mps.jdcloud-api.com/v1/mt/transcodeJobs:submit

{
    "accessKey": "Input OSS Access Key", 
    "bucket": "Input OSS bucket", 
    "endpoint": "Input OSS endpoint", 
    "objectKey": "Input OSS Object Key", 
    "outputConfig": {
        "accessKey": "Output OSS Access Key", 
        "bucket": "Output OSS bucket", 
        "endpoint": "Output OSS endpoint", 
        "outputList": [
            {
                "objectKey": "Output OSS Object Key", 
                "templateId": "Related transcode template ID"
            }
        ], 
        "secretKey": "Output OSS Secret Key"
    }, 
    "secretKey": "Input OSS Secret Key", 
    "templateIds": [
        "10001"
    ], 
    "title": "Input file title"
}

返回示例

{
    "requestId": "d2e394ff-f7ff-42b5-8544-8866f999507e", 
    "result": {
        "jobId": "10001", 
        "taskIds": [
            "10001"
        ]
    }
}
更新时间:2020-05-09 10:43:02