查询C2PA内容凭证签名任务的状态和结果。
接口说明
请求说明
本接口用于查询通过
CreateC2paSignTask创建的异步签名任务的状态及结果。任务状态包括处理中(
PROCESSING)、成功(SUCCEEDED)或失败(FAILED)。成功时返回签名文件的临时下载链接,该链接有效期为 1 小时。
建议以合理的时间间隔轮询此接口,直到任务完成。
如果服务暂时不可用,将返回可重试的错误码
C2PA_SERVICE_UNAVAILABLE。查询不会重新创建或执行签名任务。
TaskId必须是有效的且属于当前调用者的任务 ID,否则会返回相应的错误信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| 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 |
| 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",
"Success": true,
"Message": "success",
"HttpStatusCode": 200,
"Code": "OK"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。