Queries the status and result of a single-file or OSS Bucket batch C2PA trusted signing task.
Operation description
Request description
This operation queries the status and final result of a trusted signing task created by
CreateC2paSignTaskorCreateC2paBucketSignTask.Supports querying both
FILEandBUCKETtypes of trusted signing tasks. This operation does not apply to the basic signing operationSignUserImage.For Bucket tasks in the
PROCESSING,PAUSING,PAUSED, orCANCELINGstate, intermediate statistics information is not returned. Complete statistics information and report locations are provided only after the task enters theSUCCEEDEDorCANCELEDstate.The query operation itself is free and does not re-trigger the underlying signing procedure.
TaskIdmust conform to the standard UUID format (lowercase with hyphens) and is also compatible with legacy decimal format IDs.If the provided
TaskIdformat is incorrect, anInvalidParamerror is returned directly without further querying the task table or certificate service.Note the distinction between a successful API invocation and a successful task execution: even if the API invocation succeeds (
Code=OK,Success=true), the actual task may still have failed with a specificErrorCode.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
aideepsign:GetC2paSignResult |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| TaskId |
string |
Yes |
The opaque task ID returned by |
7093c29e-f472-4e1e-91c6-a43df7c7382e |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The task query result. |
||
| RequestId |
string |
The request ID of this API call. |
A1B2C3D4-E5F6-7890-ABCD-EF1234567890 |
| TaskId |
string |
The C2PA signing task ID. |
7093c29e-f472-4e1e-91c6-a43df7c7382e |
| Status |
string |
The task status. Valid values: |
SUCCEEDED |
| SignedFileUrl |
string |
The temporary download URL of the signed file. Returned only when |
https://example.oss-cn-hangzhou.aliyuncs.com/... |
| ErrorCode |
string |
The task failure error code. Returned only when |
C2PA_FORMAT_UNSUPPORTED |
| ErrorMessage |
string |
The task failure error message. Returned only when |
only valid JPEG and PNG source files are supported |
| TaskType |
string |
The task type: FILE or BUCKET. |
BUCKET |
| TotalCount |
integer |
The total number of objects scanned by the Bucket task. Returned only when the Bucket task is in the SUCCEEDED or CANCELED state. |
3 |
| SucceededCount |
integer |
The number of objects successfully signed by the Bucket task. Returned only when the Bucket task is in the SUCCEEDED or CANCELED state. |
1 |
| FailedCount |
integer |
The number of objects that failed, were skipped, or were terminated by the Bucket task. Returned only when the Bucket task is in the SUCCEEDED or CANCELED state. |
2 |
| ReportObjectKey |
string |
The object key of the final standard JSON report for the Bucket task. Returned only when the Bucket task succeeds. |
ai-deepsign-signed/047b8305-9572-4eed-b7fb-8588b989b6e5/c2pa_report.json |
| ReportFileUrl |
string |
The temporary download URL returned when the Bucket task enters the CANCELED state and the internal JSON report is written successfully. The report covers only objects discovered before termination. |
https://ai-deepsign-hangzhou-prod.oss-cn-hangzhou.aliyuncs.com/c2pa_bucket_reports/047b8305-9572-4eed-b7fb-8588b989b6e5/c2pa_report.json?Expires=1788000000&Signature=*** |
| Success |
boolean |
Indicates whether this query call is successful. This value may still be |
True |
| Message |
string |
The additional message. Returns |
success |
| HttpStatusCode |
integer |
The HTTP status code. Returns |
200 |
| Code |
string |
The business error code of this API call. Returns |
OK |
Examples
Success response
JSON format
{
"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://ai-deepsign-hangzhou-prod.oss-cn-hangzhou.aliyuncs.com/c2pa_bucket_reports/047b8305-9572-4eed-b7fb-8588b989b6e5/c2pa_report.json?Expires=1788000000&Signature=***",
"Success": true,
"Message": "success",
"HttpStatusCode": 200,
"Code": "OK"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.