This topic describes the common response parameters and HTTP status codes for calling the Content Moderation API operations.
Common response parameters
JSON-formatted data is returned for all requests. The following table describes the common response parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
| code | Integer | Yes | The HTTP status code returned for the moderation task. Some extended error codes are supported.
For more information, see Common HTTP status codes. |
| msg | String | Yes | The details of the error. |
| requestId | String | Yes | The unique ID of the request, which can be used to locate issues. |
| data | Integer, String, or JSON object | No | The service-related response data. This parameter may be empty when an error occurs. Generally, the value is a JSON structure or array. |
Common HTTP status codes
| Error code | HTTP status code | Description |
|---|---|---|
| OK | 200 | The message returned because the request is successful. |
| PROCESSING | 280 | The error message returned because the task is running. We recommend that you wait for a while, such as 5 seconds, before querying the result. |
| BAD_REQUEST | 400 | The error message returned because the request is invalid. This error is typically caused by invalid request parameters. Check the request parameters carefully. |
| NOT_ALLOWED | 401 | The error message returned because an image or video link that is not secure is used. |
| FORBIDDEN | 403 | The error message returned because your image or video link cannot be accessed. Check whether the link is accessible from the Internet and whether an anti-theft chain policy is configured. |
| NOT_FOUND | 404 | The error message returned because the content to be moderated cannot be found. This is usually because your image or video content cannot be downloaded. Make sure that the content is accessible from the Internet. |
| DOWNLOAD_FAILED | 480 | The error message returned because the download fails. Make sure that the size and resolution of the content to be moderated are within the limits of the API if the size and resolution can be obtained. |
| GENERAL_ERROR | 500 | The error message returned because a temporary server error occurs. We recommend that you try again. If the error code persists, submit a ticket. |
| DB_FAILED | 580 | The error message returned because an error occurs for database operations. We recommend that you try again. If the error code persists, submit a ticket. |
| TIMEOUT | 581 | The error message returned because the operation times out. We recommend that you try again. If the error code persists, submit a ticket. |
| CACHE_FAILED | 585 | The error message returned because a cache error occurs. We recommend that you try again. If the error code persists, submit a ticket. |
| ALGO_FAILED | 586 | The error message returned because an algorithm error occurs. Submit a ticket to us. |
| MQ_FAILED | 587 | The error message returned because a middleware error occurs. Submit a ticket to us. |
| EXCEED_QUOTA | 588 | The error message returned because the number of requests exceeds the quota. The quota defaults to 50 images, 20 videos, 20 audios, or 100 pieces of text per second. If you want to adjust the quota, submit a ticket. |
| TOO_LARGE | 589 | The error message returned because the content to be moderated is too large in size. Make sure that the content size is allowed by the API. We recommend that you try again. If the error code persists, submit a ticket. |
| BAD_FORMAT | 590 | The error message returned because the content to be moderated is in an invalid format. Make sure that the format of the content is allowed by the API. |
| CONNECTION_POOL_FULL | 591 | The error message returned because the connection pool is full. Submit a ticket to us. |
| DOWNLOAD_TIMEOUT | 592 | The error message returned because the download times out. The download duration is limited to 3 seconds. Make sure that the size of the moderated content is allowed by the API. |
| EXPIRED | 594 | The error message returned because the task expires. For example, taskId expires. |
| CATCH_FRAME_FAILED | 595 | The error message returned because frame capturing fails. Submit a ticket to us. |
| PERMISSION_DENY | 596 | The error message returned because the account is unauthorized, overdue, deactivated, or disabled. For more information, see the returned message. |