查詢單檔案或OSS Bucket批次C2PA可信簽名任務的狀態和結果。
介面說明
請求說明
本介面用於查詢透過
CreateC2paSignTask或CreateC2paBucketSignTask建立的可信簽名任務狀態及其最終結果。支援查詢
FILE和BUCKET兩類可信簽名任務,不適用於基礎簽名介面SignUserImage。對於處於
PROCESSING、PAUSING、PAUSED或CANCELING狀態的 Bucket 任務,不會回傳中間統計資訊;只有當任務進入SUCCEEDED或CANCELED狀態後,才會提供完整的統計資料及報告位置。查詢操作本身是免費的,並且不會重新觸發底層簽名過程。
TaskId必須符合標準 UUID 格式(小寫帶連字號),同時也相容歷史遺留的十進位格式 ID。如果提供的
TaskId格式不正確,則直接回傳InvalidParam錯誤,而不會進一步查詢任務表或憑證服務。注意區分介面呼叫成功與任務執行成功的概念:即使 API 呼叫成功(
Code=OK,Success=true),實際任務仍可能失敗並帶有特定的ErrorCode。
調試
您可以在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://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 |
表示本次查詢呼叫是否成功。任務本身失敗時,該值仍可能為 |
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://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"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。