查询单文件或OSS Bucket批量C2PA签名任务的状态和结果。
接口说明
请求说明
本接口用于查询通过
CreateC2paSignTask或CreateC2paBucketSignTask创建的任务状态及其最终结果。支持图片、视频及多种音频格式(FLAC, M4A, MP3, WAV)的签名任务查询。
对于
BUCKET类型的任务,在其处于PROCESSING,PAUSING,PAUSED, 或CANCELING状态时不提供中间统计信息,仅在进入SUCCEEDED或CANCELED状态后返回完整统计与报告位置。查询时需提供有效的
TaskId,该 ID 应为创建任务时返回的值;支持标准 UUID 格式以及兼容旧版十进制任务 ID。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
aideepsign:GetC2paSignResult |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| TaskId |
string |
是 |
|
7093c29e-f472-4e1e-91c6-a43df7c7382e |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
查询任务返回结果 |
||
| RequestId |
string |
本次 OpenAPI 调用的请求 ID。 |
A1B2C3D4-E5F6-7890-ABCD-EF1234567890 |
| TaskId |
string |
C2PA 签名任务 ID。 |
7093c29e-f472-4e1e-91c6-a43df7c7382e |
| Status |
string |
任务状态。取值: |
SUCCEEDED |
| SignedFileUrl |
string |
签名文件的临时下载地址,仅在 |
https://example.oss-cn-hangzhou.aliyuncs.com/... |
| ErrorCode |
string |
任务失败错误码,仅在 |
C2PA_FORMAT_UNSUPPORTED |
| ErrorMessage |
string |
任务失败错误信息,仅在 |
only valid JPEG and PNG source files are supported |
| TaskType |
string |
任务类型:FILE 或 BUCKET |
BUCKET |
| TotalCount |
integer |
Bucket 任务扫描到的对象总数,仅 Bucket 任务 SUCCEEDED 或 CANCELED 时返回 |
3 |
| SucceededCount |
integer |
Bucket 任务签名成功的对象数,仅 Bucket 任务 SUCCEEDED 或 CANCELED 时返回 |
1 |
| FailedCount |
integer |
Bucket 任务签名失败、跳过或被终止的对象数,仅 Bucket 任务 SUCCEEDED 或 CANCELED 时返回 |
2 |
| ReportObjectKey |
string |
Bucket 任务最终标准 JSON 报告的 Object Key,仅 Bucket 任务成功时返回 |
ai-deepsign-signed/047b8305-9572-4eed-b7fb-8588b989b6e5/c2pa_report.json |
| ReportFileUrl |
string |
Bucket 任务进入 CANCELED 且 JSON 报告生成成功时返回的临时下载地址;报告只覆盖终止前已发现的对象。 |
https://example-bucket.oss-cn-hangzhou.aliyuncs.com/c2pa_report.json?Expires=1788000000&Signature=*** |
| Success |
boolean |
表示本次查询调用是否成功。任务本身失败时,该值仍可能为 |
True |
| Message |
string |
附加信息。接口调用成功时返回 |
success |
| HttpStatusCode |
integer |
HTTP 状态码。接口调用成功时返回 |
200 |
| Code |
string |
本次接口调用的业务错误码。调用成功时返回 |
OK |
示例
正常返回示例
JSON格式
{
"RequestId": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890",
"TaskId": "7093c29e-f472-4e1e-91c6-a43df7c7382e",
"Status": "SUCCEEDED",
"SignedFileUrl": "https://example.oss-cn-hangzhou.aliyuncs.com/...",
"ErrorCode": "C2PA_FORMAT_UNSUPPORTED",
"ErrorMessage": "only valid JPEG and PNG source files are supported",
"TaskType": "BUCKET",
"TotalCount": 3,
"SucceededCount": 1,
"FailedCount": 2,
"ReportObjectKey": "ai-deepsign-signed/047b8305-9572-4eed-b7fb-8588b989b6e5/c2pa_report.json",
"ReportFileUrl": "https://example-bucket.oss-cn-hangzhou.aliyuncs.com/c2pa_report.json?Expires=1788000000&Signature=***",
"Success": true,
"Message": "success",
"HttpStatusCode": 200,
"Code": "OK"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。