Task

Подсказка

Актуальную спецификацию можно скачать и использовать в привычном инструменте.

Набор методов для управления Task:

Метод API

HTTP-метод

Описание

Get {serviceInstanceId}/{pageSize}/{pageToken}

GET

Возвращает список задач и данные по ним в рамках заказанной услуги

Get {serviceInstanceId}/{taskId}

GET

Возвращает информацию об указанной задачи, в том числе статус выполнения

GET /kubernetes/v1/tasks/{serviceInstanceId}/{pageSize}/{pageToken}
Parameters
  • serviceInstanceId (string) – идентификатор услуги

  • pageSize (integer) – максимальное количество результатов на странице 10 или 200

  • pageToken (integer) – шаг перехода к следующей странице результатов запроса

Status Codes
  • 200 OK – A successful response

Response JSON Object
  • nextPageToken (integer) – шаг перехода к следующей странице результатов запроса

  • taskList[].command (string) – команда на выполнениe (создать кластер, удалить кластер и т.п.)

  • taskList[].createdAt (string) – время создания задачи

  • taskList[].createdBy (string) – идентификатор пользователя или сервисного аккаунта, инициировавшего операцию

  • taskList[].done (boolean) – статус выполнения запроса. Если значение равно false — операция еще выполняется. Если поле false и поле error не пустое - задача завершилась с ошибкой. Если true — операция завершена успешно.

  • taskList[].doneAt (string) – время завершения выполнения задачи

  • taskList[].error.code (integer) – код ошибки. Доступные коды ошибок определены в google.rpc.Code

  • taskList[].error.details[].typeUrl (string) – дополнительные сведения об ошибке о типе протокола передачи данных. Соответствия gRPC-статусов с HTTP-кодами определены в google.rpc.Code

  • taskList[].error.details[].value (string) – значение ошибки

  • taskList[].error.message (string) – описание ошибки

  • taskList[].id (string) – идентификатор задачи (task)

  • taskList[].metadata (object) – метаданные задачи. Обычно в поле содержится идентификатор ресурса, над которым выполняется задача

  • totalTaskCount (integer) – общее число задач

GET /kubernetes/v1/tasks/{serviceInstanceId}/{taskId}
Parameters
  • serviceInstanceId (string) – идентификатор услуги

  • taskId (string) – идентификатор задачи (task)

Status Codes
  • 200 OK – A successful response

Response JSON Object
  • command (string) – команда на выполнениe (создать кластер, удалить кластер и т.п.)

  • createdAt (string) – время создания задачи

  • createdBy (string) – идентификатор пользователя или сервисного аккаунта, инициировавшего операцию

  • done (boolean) – статус выполнения запроса. Если значение равно false — операция еще выполняется. Если поле false и поле error не пустое - задача завершилась с ошибкой. Если true — операция завершена успешно.

  • doneAt (string) – время завершения выполнения задачи

  • error.code (integer) – код ошибки. Доступные коды ошибок определены в google.rpc.Code

  • error.details[].typeUrl (string) – дополнительные сведения об ошибке о типе протокола передачи данных. Соответствия gRPC-статусов с HTTP-кодами определены в google.rpc.Code

  • error.details[].value (string) – значение ошибки

  • error.message (string) – описание ошибки

  • id (string) – идентификатор задачи (task)

  • metadata (object) – метаданные задачи. Обычно в поле содержится идентификатор ресурса, над которым выполняется задача