get-query
Статья создана
Обновлена 1 октября 2024 г.
Метод возвращает информацию о запросе, включая метаинформацию о запросе, статус его выполнения и объем результатов.
При использовании HTTP API необходимо аутентифицироваться, указав для этого обязательные заголовки. Кроме того, можно задать необязательные заголовки для настройки исполнения запросов. При работе с HTTP API могут возвращаться ошибки.
Запрос
GET-запрос на адрес /queries/{query_id}?project={folder_id}, где {folder_id} — идентификатор каталога, а {query_id} — идентификатор запроса.
Ответ
В случае успеха возвращается HTTP-ответ с кодом 200 и информацией о запросе.
{
"name": "<название_запроса>",
"type": "<тип_запроса>",
"text": "<текст_запроса>",
"description": "<описание>",
"meta": {
"started_at": "2022-09-03T14:53:00.067Z",
"finished_at": "2022-09-03T14:53:00.067Z"
},
"issues": {
"details": [
{
"position": {
"row": 0,
"column": 0,
"file": "string"
},
"message": "string",
"end_position": {
"row": 10,
"column": 10,
"file": "string"
},
"issue_code": 0,
"severity": "FATAL",
"issues": [
],
"status": 0
}
],
"message": "string",
"status": 0
},
"result_sets": [
{
"rows": 0,
"truncated": true
}
],
"status": "RUNNING",
"id": "string"
}
| Поле | Описание |
|---|---|
name |
Название запроса. |
type |
Тип запроса: STREAMING — потоковый, ANALYTICS — аналитический. |
text |
Текст запроса. |
description |
Описание запроса. |
meta.started_at |
Момент начала выполнения запроса. |
meta.finished_at |
Момент завершения выполнения запроса. |
issues |
При наличии ошибок выполнения, содержит объект Issue. |
result_sets |
Массив результатов выполнения запроса. |
result_sets[].rows |
Количество строк результата выполнения запроса. |
result_sets[].truncated |
Количество строк результата запроса превышает лимит и было обрезано. |
Пример
Запрос:
curl \
--request 'GET' \
'https://api.yandex-query.cloud.yandex.net/api/fq/v1/queries/cseugn35bc3r********?project=b1gaue5b382m********' \
--header 'accept: application/json'
Ответ:
{
"name": "",
"type": "ANALYTICS",
"text": "select 1",
"description": "",
"meta": {
"started_at": "2022-09-03T15:02:36.827Z",
"finished_at": "2022-09-03T15:02:36.827Z"
},
"issues": [],
"result_sets": [
{
"rows": 110,
"truncated": false
}
],
"status": "FINISHED",
"id": "csqugo80f0l3********"
}