用於建立圖片敏感資訊掃描任務並返回任務 ID。
介面說明
請求說明
本介面用於建立圖片敏感資訊掃描任務,系統將對指定的圖片進行敏感資料識別。
支援透過圖片 URL 或 OSS ObjectKey 指定待掃描圖片。
圖片大小不能超過 10MB。
ImageUrl和ObjectKey必須至少提供一個;如果兩個都提供,則優先使用ObjectKey。使用
ObjectKey時,需確保該 Key 屬於當前呼叫者的命名空間,不允許跨租戶存取。可以透過
ClientToken參數保證請求的冪等性。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ClientToken |
string |
否 |
用於保證請求的冪等性。由用戶端產生該參數值,要保證在不同請求間唯一。 |
5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
| ObjectKey |
string |
否 |
待掃描圖片在 OSS 中的 |
deepsign/123456789/scan/abc12345.jpg |
| ImageUrl |
string |
否 |
待掃描圖片的 URL 位址,僅支援 HTTP/HTTPS 協定。圖片大小不超過 10 MB。 |
https://example.com/document.jpg |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
請求 ID。 |
A1B2C3D4-E5F6-7890-ABCD-EF1234567890 |
| TaskId |
string |
任務 ID,用於呼叫 |
f47ac10b-58cc-4372-a567-0e02b2c3d479 |
| Success |
boolean |
表示是否呼叫成功。true:呼叫成功。 false:呼叫失敗。 |
True |
| Message |
string |
附加資訊。 |
null |
| HttpStatusCode |
integer |
HTTP 狀態碼。 |
200 |
| Code |
string |
內部錯誤碼。 |
OK |
樣本
正常返回樣本
JSON格式
{
"RequestId": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890",
"TaskId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"Success": true,
"Message": "null",
"HttpStatusCode": 200,
"Code": "OK"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。