QueryDNAJobList.md
5.93 KB
调用QueryDNAJobList查询DNA作业。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ice:QueryDNAJobList | \全部资源 `` | 无 | 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| JobIds | string | 否 | 需要查询的 DNA 作业 ID 列表。一次最多建议查询 10 个,用半角逗号(,)分隔。 | 88c6ca184c0e47098a5b665e2a12\*\*\*\* |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object | |||
| RequestId | string | 请求 ID。 | 25818875-5F78-4A13-BEF6-D7393642CA58 |
| JobList | array | DNA 作业信息。 | |
| DNAJob | object | DNAJob | |
| DNAResult | string | DNA 结果链接。 | http://test\_bucket.oss-cn-shanghai.aliyuncs.com/fingerprint/video/search\_result/5/5.txt |
| PrimaryKey | string | 唯一的视频主键,唯一性由用户保证。 | 3ca84a39a9024f19853b21be9cf9\*\*\*\* |
| DBId | string | DNA 库 Id。 | 2288c6ca184c0e47098a5b665e2a12\*\*\*\* |
| CreationTime | string | 作业创建时间。 | 2022-12-28T03:21:37Z |
| FinishTime | string | 作业完成时间。 | 2022-12-28T03:21:44Z |
| Status | string | 作业状态,可取值: - Queuing:排队中。 - Analysing:分析中。 - Success:成功。 - Fail:失败。 | Queuing |
| Message | string | 作业执行错误信息。 | "The resource operated \\"a887d0b\*\*\*d805ef6f7f6786302\\" cannot be found" |
| Config | string | DNA 配置。 | {"SaveType": "save","MediaType"":"video"} |
| UserData | string | 用户自定义数据。 | testdna |
| Code | string | 作业执行错误码。 | "InvalidParameter.ResourceNotFound" |
| Input | object | 输入文件。 | |
| 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\*\*\*\* |
| Id | string | 作业 ID。 | 88c6ca184c0e47098a5b665e2a12\*\*\*\* |
DNAResult 的内容为 Array of VideoMatchInfo,其中:
VideoMatchInfo 详情
| 名称 | 类型 | 描述 |
|---|---|---|
| PrimaryKey | String | 匹配文件唯一主键。 |
| GlobalSimilarity | Double | 整体相似度。 |
| VideoMatchSegments | Array of VideoMatchSegment | 视频/图搜视频匹配片段信息。 |
| AudioMatchSegments | Array of AudioMatchSegment | 音频搜音频匹配片段信息。 |
| TextMatchSegments | Array of TextMatchSegment | 文本搜文本匹配片段信息。 |
VideoMatchSegment/AudioMatchSegment 详情
| 名称 | 类型 | 描述 |
|---|---|---|
| StartTime | Double | 输入视频/音频的开始时间。 |
| EndTime | Double | 输入视频/音频的结束时间。 |
| MasterStartTime | Double | 库中视频/音频的开始时间。 |
| MasterEndTime | Double | 库中视频/音频的结束时间。 |
| Similarity | Double | 匹配片段的置信度。 |
TextMatchSegment 详情
| 名称 | 类型 | 描述 |
|---|---|---|
| Start | Double | 查询匹配片段起始时间。 |
| End | Double | 查询匹配片段结束时间。 |
| QueryText | String | 查询匹配的文本片段。 |
| MasterText | String | 底库匹配的文本片段。 |
| Similarity | Double | 匹配片段的置信度。 |
示例
正常返回示例
JSON格式
{
"RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
"JobList": [
{
"DNAResult": "http://test_bucket.oss-cn-shanghai.aliyuncs.com/fingerprint/video/search_result/5/5.txt",
"PrimaryKey": "3ca84a39a9024f19853b21be9cf9****",
"DBId": "2288c6ca184c0e47098a5b665e2a12****",
"CreationTime": "2022-12-28T03:21:37Z",
"FinishTime": "2022-12-28T03:21:44Z",
"Status": "Queuing",
"Message": "The resource operated \"a887d0b***d805ef6f7f6786302\" cannot be found",
"Config": "{\"SaveType\": \"save\",\"MediaType\"\":\"video\"}",
"UserData": "testdna",
"Code": "InvalidParameter.ResourceNotFound",
"Input": {
"Type": "Media",
"Media": "1b1b9cd148034739af413150fded****"
},
"Id": "88c6ca184c0e47098a5b665e2a12****"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-05-25 | API 内部配置变更,不影响调用 | 查看变更详情 |
调试