GetC2paSignResult - 查询C2PA可信签名结果

更新时间:
复制 MD 格式

查询单文件或OSS Bucket批量C2PA可信签名任务的状态和结果。

接口说明

请求说明

  • 本接口用于查询通过CreateC2paSignTaskCreateC2paBucketSignTask创建的可信签名任务状态及其最终结果。

  • 支持查询FILEBUCKET两类可信签名任务,不适用于基础签名接口SignUserImage

  • 对于处于PROCESSINGPAUSINGPAUSEDCANCELING状态的 Bucket 任务,不会返回中间统计信息;只有当任务进入SUCCEEDEDCANCELED状态后,才会提供完整的统计数据及报告位置。

  • 查询操作本身是免费的,并且不会重新触发底层签名过程。

  • TaskId必须符合标准 UUID 格式(小写带连字符),同时也兼容历史遗留的十进制格式 ID。

  • 如果提供的TaskId格式不正确,则直接返回InvalidParam错误,而不会进一步查询任务表或证书服务。

  • 注意区分接口调用成功与任务执行成功的概念:即使 API 调用成功(Code=OK, Success=true),实际任务仍可能失败并带有特定的ErrorCode

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

aideepsign:GetC2paSignResult

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

TaskId

string

CreateC2paSignTask 返回的不透明任务 ID,最多 64 个字符。

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

任务状态。取值:PROCESSINGSUCCEEDEDFAILED

SUCCEEDED

SignedFileUrl

string

签名文件的临时下载地址,仅在 Status=SUCCEEDED 时返回。

https://example.oss-cn-hangzhou.aliyuncs.com/...

ErrorCode

string

任务失败错误码,仅在 Status=FAILED 时返回。

C2PA_FORMAT_UNSUPPORTED

ErrorMessage

string

任务失败错误信息,仅在 Status=FAILED 时返回。

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

True

Message

string

附加信息。接口调用成功时返回 success

success

HttpStatusCode

integer

HTTP 状态码。接口调用成功时返回 200

200

Code

string

本次接口调用的业务错误码。调用成功时返回 OK

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"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情