Закрыть пул для редактирования

POST /pools/{id}/close-for-update

Закрывает пул для редактирования.

Чтобы внести изменения в пул, закройте его для редактирования.

Примечание

Если после редактирования не открыть пул вручную, он откроется автоматически через 15 минут.

В этом случае не производятся проверки, способные заблокировать открытие пула.

В результате запросов создается операция. Чтобы отслеживать ход операции, отправьте запрос к ресурсу /operations.

Примеры запросов

cURL

Python

Nodejs

curl -X POST 'https://tasks.yandex.ru/api/v1/pools/32267581/close-for-update' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

import requests

url = "https://tasks.yandex.ru/api/v1/pools/32267581/close-for-update"
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
}
response = requests.post(url, headers=headers)

print(response.text)

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://tasks.yandex.ru/api/v1/pools/32267581/close-for-update',
  'qs': {},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Path-параметры

Параметр

Описание

id*

string

Идентификатор пула.

Заголовки

Заголовок	Описание
`Authorization`	API-токен для авторизации аккаунта. В качестве префикса добавьте `OAuth`.

Ответ

Примечание

Если текущий статус пула совпадает с запрашиваемым, возвращается пустой ответ со статусом 204.

{
  "id": "019587fd-b536-49f8-b6dc-01ffc25f8594",
  "type": "POOL.CLOSE",
  "status": "SUCCESS",
  "submitted": "2022-04-07T16:06:15.902",
  "started": "2022-04-07T16:06:15.902",
  "finished": "2022-04-07T16:06:15.902",
  "progress": 100,
  "parameters": {
    "pool_id": "21"
  }
}

Параметр	Описание
`id`	string Идентификатор операции.
`type`	string Тип операции: `POOL.CLOSE` — закрытие пула.
`status`	string Статус операции: `PENDING` — выполнение не началось; `RUNNING` — выполняется; `SUCCESS` — успешно выполнена; `FAIL` — не выполнена.
`submitted`	string Дата и время отправки запроса по UTC в формате ISO 8601: `YYYY-MM-DDThh:mm:ss[.sss]`.
`started`	string Дата и время начала операции по UTC в формате ISO 8601: `YYYY-MM-DDThh:mm:ss[.sss]`.
`finished`	string Дата и время окончания операции по UTC в формате ISO 8601: `YYYY-MM-DDThh:mm:ss[.sss]`.
`progress`	integer Ход выполнения операции в процентах.
`parameters.pool_id`	string Идентификатор пула.

Была ли статья полезна?

Закрыть пул

Открыть пул