Response Status Code
This page describes each status code from the API response.
Status Codes
This table shows the main status code and its name using Vald. The sections below describe the meaning of each code and why API returns.
| code | name |
|---|---|
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 5 | NOT_FOUND |
| 6 | ALREADY_EXISTS |
| 8 | RESOURCE_EXHAUSTED |
| 13 | INTERNAL |
| 14 | UNAVAILABLE |
OK
OK means complete process with success.
Services that return this code are all services.
CANCELLED
CANCELLED means the operation was cancelled.
Services that return this code are all services.
INVALID_ARGUMENT
INVALID_ARGUMENT means something wrong in the request argument.
Services that return status are all services. If you get this code, please verify your request payload is correct.
DEADLINE_EXCEEDED
DEADLINE_EXCEEDED returns when the process ends due to timeout.
Services that return status are:
The timeout configuration is on the Vald cluster side. If it appears constantly, you need to review the cluster settings. However, only when using a search service can you overwrite the timeout configuration by lengthening the time setting in the search request config.
NOT_FOUND
NOT_FOUND appears when there is no result corresponding to the request.
The example cases are:
- No search result when using SearchById RPC.
- No index data corresponding to the request vector when using Update/Exists/GetObject RPC
Services that return status are:
The possible reasons are:
- There is no index data in Vald Agent components or running the indexing process in the Vald Agent components. When the Vald Agent component runs the indexing process (createIndex/saveIndex), any process won’t run, and it will return with no result.
- The request query vector or ID is wrong when using the search/update/remove service. Notably, both update service and remove service require the ID of vector Vald Agent component already indexed.
ALREADY_EXISTS
ALREADY_EXISTS means that the Vald Agent component already stores the vector index same as the query vector when set skip_strict_exist_check as true in request config.
Services that return status are:
You have to change the query vector with skip_strict_exist_check as true or set skip_strict_exist_check as false instead of changing the query vector.
RESOURCE_EXHAUSTED
RESOURCE_EXHAUSTED means that some resources have been exhausted.
It appears when:
- There is out-of-memory in gRPC payload, in networks, etc.
- There are some server overload situations.
- The sent or received message is larger than the configured limit (default is 4 MB).
Services that return status are all services. The most case in the Vald is that the query vector is too large. In other words, the vector dimension size in configuration is too large.
INTERNAL
INTERNAL appears when some wrong happens in the Vald cluster.
It is there are the serious problems with the Vald cluster.
Services that return status are all services. If you get it, please verify the state of the Vald cluster.
UNAVAILABLE
UNAVAILABLE means the gRPC message cannot reach the Vald cluster.
It would be best to verify whether the Vald cluster is running and the host and port are correct.