This topic describes the common response parameters and common error codes for calling the Content Moderation API.
Common response parameters
All requests return data in JSON format. The following table describes the common fields in the response parameters.
|
Name |
Type |
Description |
|
Code |
Integer |
Error code.
For more information, see Common error codes. |
|
Msg |
String |
A detailed description of the error. |
|
RequestId |
String |
The unique ID of the request. Use this ID to locate issues. |
|
Data |
|
The API (business) response data. This field may be empty if an error occurs. Typically a JSON object or array. |
Common error codes
|
Code |
Msg |
Description |
|
200 |
OK |
The request succeeded. |
|
280 |
PROCESSING |
The task is still in progress. Wait a few seconds (for example, 5s) and query the result again. |
|
400 |
BAD_REQUEST |
The request is invalid. This is usually caused by incorrect request parameters. Check the request parameters carefully. |
|
400 |
EXCEED_QUOTA |
The request rate exceeds the quota. Default quotas: 50 images/s for image moderation, 20 ingest endpoints/s for video moderation, 20 ingest endpoints/s for audio moderation, 100 entries/s for text moderation, and 10 images/s for image OCR. To adjust the quota, contact us through Support and Services. |
|
400 |
File type is not support |
The format of the content to be moderated is invalid. Make sure the content is within the API limits. |
|
401 |
NOT_ALLOWED |
The request failed. This is usually because an insecure URL for an image or video file was used. |
|
403 |
FORBIDDEN |
The access request failed. This is usually because the URL of your image or video file is inaccessible. Confirm that the content is accessible over the Internet and that no hotlink protection policy is enabled. |
|
404 |
NOT_FOUND |
The content to be moderated was not found. This is usually because the image or video content cannot be downloaded. Confirm that the content is accessible over the Internet. |
|
480 |
DOWNLOAD_FAILED |
Download failed. Make sure the content size and resolution (if any) are within the API limits. |
|
480 |
DOWNLOAD_TIMEOUT |
Download timed out. The download time limit is 3 seconds. Make sure the content size is within the API limits. |
|
500 |
GENERAL_ERROR |
A temporary server-side error occurred. Retry the request. If the error persists, contact us through Support and Services. |
|
503 |
ServiceUnavailable |
A system error occurred. Verify that the requested domain name is valid. If it is, contact us through Support and Services and provide the case details. |
|
580 |
DB_FAILED |
A database operation failed. Retry the request. If the error persists, contact us through Support and Services. |
|
581 |
TIMEOUT |
Request timed out. Retry the request. If the error persists, contact us through Support and Services. |
|
585 |
CACHE_FAILED |
A cache error occurred. Retry the request. If the error persists, contact us through Support and Services. |
|
586 |
ALGO_FAILED |
An algorithm error occurred. Contact us through Support and Services. |
|
587 |
MQ_FAILED |
A middleware error occurred. Contact us through Support and Services. |
|
589 |
TOO_LARGE |
The content is too large. Make sure the content is within the API limits. Retry the request. If the error persists, contact us through Support and Services. |
|
591 |
CONNECTION_POOL_FULL |
The connection pool is full. Contact us through Support and Services. |
|
594 |
EXPIRED |
The task expired. For example, the TaskId expired. |
|
595 |
CATCH_FRAME_FAILED |
Frame capture failed. Contact us through Support and Services. |
|
596 |
PERMISSION_DENY |
Access is denied. Possible causes: the account is not authorized, has an overdue payment, has not activated the service, or has been disabled. See the returned error description for details. |