Status code reference
When calling the API/SDK for the search development workbench service, status codes are returned to signify the outcome of the call. Detailed information on the success or failure of the call can be found in the code and status fields of the response.
Below is a table of general status codes for the search development workbench service.
Category |
httpStatusCode |
code |
message |
Error description |
Request error |
400 |
InvalidParameter |
The request contains missing or invalid parameters. Please verify the request parameters. |
The parameters provided in the interface call are invalid. |
400 |
ServiceIdNotExist |
The service_id does not exist. |
The specified service ID is not found. |
|
429 |
Throttling |
Request throttling has been triggered. |
The request has triggered rate limiting. |
|
429 |
Throttling.RateQuota |
Request rate limit exceeded. Please try again later. |
The frequency of calls has exceeded the rate limit, such as the number of requests per second. |
|
429 |
Throttling.AllocationQuota |
Allocated quota exceeded. Please increase your quota limit. |
The call volume over a specified period has triggered rate limiting, such as the number of tokens generated per minute. |
|
429 |
Throttling.AllocationQuota |
Free allocated quota exceeded. |
The free quota has been used up, and the model has not enabled billing access. |
|
Server error |
500 |
InternalServerError |
An internal server error has occurred. Please try again later or contact customer support. |
An error occurred within the system. |
Return field reference
In the event of an access failure, the search development workbench service provides detailed error information in addition to the HTTP status code. A sample response for a failed request may appear as follows:
{
"request_id": "817964CD-1B84-4AE1-9B63-4FB99734DD41",
"latency": 0,
"code": "InvalidParameter",
"message": "JSON parse error: Invalid UTF-8 start byte 0xbc; nested exception is com.fasterxml.jackson.core.JsonParseException: Invalid UTF-8 start byte 0xbc\n at line: 2, column: 19]"
}
Return parameter description
Return parameter |
Type |
Description |
HTTP request return code |
integer |
A 200 (HTTPStatus.OK) indicates a successful request, while any other code signifies a failure. The error code can be found in the code field, and the message field provides detailed error information. |
request_id |
string |
The unique identifier for an API call assigned by the system. Developers can provide the request_id when seeking support to trace a specific call. |
code |
string |
The error code, if the request failed. For reference, see the "Error code" section in the status code table. |
message |
string |
Detailed information about the failure, if the request failed. For reference, see the "Error message" section in the status code table. Note that the content may vary depending on the specific circumstances and may not exactly match the information in the lookup table. |