Mirror Gateway Troubleshooting

This page introduces the popular troubleshooting for Mirror Gateway.

Additionally, if you encounter some errors when using API, the API status code helps you, too.

Insert Operation

Mirror Gateway sends an Update request to its host if some requests are ALREADY_EXISTS.

Therefore, in addition to the Insert API status code, the Update API status code may also be returned to the user.

Here are some common reasons of error.

namecommon reason
CANCELLEDExecuted cancel() of rpc from client/server-side or network problems between client and server.
INVALID_ARGUMENTThe Dimension of the request vector is NOT the same as Vald Agent’s config, the requested vector’s ID is empty, or some request payload is invalid.
DEADLINE_EXCEEDEDThe RPC timeout setting is too short on the client/server side.
ALREADY_EXISTSRequest ID is already inserted. This status code is returned when all target hosts return ALREADY_EXISTS.
NOT_FOUNDRequested ID is NOT inserted. This is the status code of the Update request.
INTERNALTarget Vald cluster or network route has some critical error.

0 (OK) is also returned when all target hosts return OK or ALREADY_EXISTS.

Update Operation

Mirror Gateway sends an Update request to its host if some requests are NOT_FOUND.

Therefore, in addition to the Update API status code, the Insert API status code may also be returned to the user.

Here are some common reasons of error.

namecommon reason
CANCELLEDExecuted cancel() of rpc from client/server-side or network problems between client and server.
INVALID_ARGUMENTThe Dimension of the request vector is NOT the same as Vald Agent’s config, the requested vector’s ID is empty, or some request payload is invalid.
DEADLINE_EXCEEDEDThe RPC timeout setting is too short on the client/server side.
NOT_FOUNDRequested ID is NOT inserted. This status code is returned when all target hosts return NOT_FOUND.
ALREADY_EXISTSRequest a pair of ID and vector is already inserted. This status code is returned when all hosts return ALREADY_EXISTS.
INTERNALTarget Vald cluster or network route has some critical error.

0 (OK) is also returned when all target hosts return OK or ALREADY_EXISTS.

Upsert Operation

The request process may not be completed when the response code is NOT 0 (OK).

Here are some common reasons of error.

namecommon reason
CANCELLEDExecuted cancel() of rpc from client/server-side or network problems between client and server.
INVALID_ARGUMENTThe Dimension of the request vector is NOT the same as Vald Agent’s config, the requested vector’s ID is empty, or some request payload is invalid.
DEADLINE_EXCEEDEDThe RPC timeout setting is too short on the client/server side.
ALREADY_EXISTSRequested pair of ID and vector is already inserted. This status code is returned when all target hosts return ALREADY_EXISTS.
INTERNALTarget Vald cluster or network route has some critical error.

0 (OK) is also returned when all target hosts return OK or ALREADY_EXISTS.

Remove Operation

The request process may not be completed when the response code is NOT 0 (OK).

Here are some common reasons of error.

namecommon reason
CANCELLEDExecuted cancel() of rpc from client/server-side or network problems between client and server.
INVALID_ARGUMENTThe Requested vector’s ID is empty, or some request payload is invalid.
DEADLINE_EXCEEDEDThe RPC timeout setting is too short on the client/server side.
NOT_FOUNDRequested ID is NOT inserted. This status code is returned when all target hosts return NOT_FOUND.
INTERNALTarget Vald cluster or network route has some critical error.

0 (OK) is also returned when all target hosts return OK or NOT_FOUND.

See also