SubmitDNAJob.md
4.66 KB
调用SubmitDNAJob提交DNA作业。
接口说明
该接口为异步接口,提交任务后返回任务 ID(此时任务尚未完成,任务将进入后台排队异步执行),最终结果将通过回调通知,也可通过查询 DNA 作业列表主动查询任务状态。
本接口目前支持使用的地域为华北 2(北京)、华东 1(杭州)、华东 2(上海)。
提交文本 DNA 作业目前仅支持华东 2(上海)地域使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
操作:是指具体的权限点。
访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
-
资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
条件关键字:是指云产品自身定义的条件关键字。
关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ice:SubmitDNAJob | \全部资源 `` | 无 | 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Input | object | 是 | 输入 DNA 文件。 | |
| Type | string | 是 | 输入文件类型,取值: 1. OSS:OSS 文件地址 2. Media:媒资 ID | Media |
| Media | string | 是 | 输入文件信息,支持 OSS 地址和媒资 ID 两种。 OSS 地址规则为: 1、oss://bucket/object 2、http(s)://bucket.oss-\[regionId\].aliyuncs.com/object 其中 bucket 为和当前项目处于同一区域的 oss bucket 名称,object 为文件路径。 | 1b1b9cd148034739af413150fded\*\*\*\* |
| PipelineId | string | 否 | 管道 ID。 | 5246b8d12a62433ab77845074039\*\*\*\* |
| Config | string | 否 | DNA 配置,JSON 对象。 若填写,会覆盖模板参数。 | {"SaveType": "save","MediaType":"video"} |
| TemplateId | string | 否 | 模版 ID。 | S00000101-100060 |
| UserData | string | 否 | 用户自定义数据,最大长度 128 个字节。 | userData |
| PrimaryKey | string | 是 | 唯一的视频主键,唯一性由用户保证。 | 3ca84a39a9024f19853b21be9cf9\*\*\*\* |
| DBId | string | 是 | DNA 库 ID。如需创建 DNA 库,请参见CreateDNADB - 创建 DNA 库。 | 2288c6ca184c0e47098a5b665e2a12\*\*\*\* |
DNA 配置 Config 参数包括:SaveType 和 MediaType 字段。
其中,SaveType 表示存储类型,包括:
nosave: 仅搜索不入库。
save: 去重入库。
forcesave: 强制入库。
onlysave: 仅入库不搜索。
MediaType 表示输入文件媒体类型,包括:
video: 视频。
audio: 音频。
image: 图片。
text: 长文本。
asr: asr 识别文本。
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object | |||
| RequestId | string | 请求 ID。 | 25818875-5F78-4A13-BEF6-D7393642CA58 |
| JobId | string | 视频 DNA 作业 ID。建议您保存此 ID 便于后续调用其他相关接口时使用。 | 88c6ca184c0e47098a5b665e2\*\*\*\* |
示例
正常返回示例
JSON格式
{
"RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
"JobId": "88c6ca184c0e47098a5b665e2****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。
调试