Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1447264222.7 KB

Returns the state of a query previously submitted. Clients are expected to poll <code>GetQueryState</code> to monitor the current state of the planning before retrieving the work units. A query state is only visible to the principal that made the initial call to <code>StartQueryPlanning</code>.

post/GetQueryState

Request body

QueryIdstring required

The ID of the plan query operation.

Response

Success

Errorstring

An error message when the operation fails.

State'PENDING' | 'WORKUNITS_AVAILABLE' | 'ERROR' | 'FINISHED' | 'EXPIRED' required
<p>The state of a query previously submitted. The possible states are:</p> <ul> <li> <p>PENDING: the query is pending.</p> </li> <li> <p>WORKUNITS_AVAILABLE: some work units are ready for retrieval and execution.</p> </li> <li> <p>FINISHED: the query planning finished successfully, and all work units are ready for retrieval and execution.</p> </li> <li> <p>ERROR: an error occurred with the query, such as an invalid query ID or a backend error.</p> </li> </ul>