Creates an image sensitive information scan task and returns the task ID.
Operation description
Operation description
This operation creates an image sensitive information scan task. The system performs sensitive data identification on the specified image.
You can specify the image to scan by using an image URL or an OSS ObjectKey.
The image size cannot exceed 10 MB.
You must specify at least one of ImageUrl and ObjectKey. If both are specified, ObjectKey takes precedence.
When you use ObjectKey, make sure that the key belongs to the namespace of the current caller. Cross-tenant access is not allowed.
You can use the ClientToken parameter to ensure the idempotence of the request.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClientToken |
string |
No |
The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. |
5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
| ObjectKey |
string |
No |
The ObjectKey of the image to scan in OSS. When you use ObjectKey, make sure that the key belongs to the namespace of the current caller. You must specify at least one of ImageUrl and ObjectKey. |
deepsign/123456789/scan/abc12345.jpg |
| ImageUrl |
string |
No |
The URL of the image to scan. Only HTTP and HTTPS protocols are supported. The image size cannot exceed 10 MB. You must specify at least one of ImageUrl and ObjectKey. |
https://example.com/document.jpg |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
A1B2C3D4-E5F6-7890-ABCD-EF1234567890 |
| TaskId |
string |
The task ID. You can use this ID to call the GetSensitiveScanResult operation to query the result. |
f47ac10b-58cc-4372-a567-0e02b2c3d479 |
| Success |
boolean |
Indicates whether the call was successful. Valid values:
|
True |
| Message |
string |
The additional information. |
null |
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| Code |
string |
The internal error code. |
OK |
Examples
Success response
JSON format
{
"RequestId": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890",
"TaskId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"Success": true,
"Message": "null",
"HttpStatusCode": 200,
"Code": "OK"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 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. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.