Task

Подсказка

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

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

Метод API

HTTP-метод

Описание

Get {serviceInstanceId}/tasks

GET

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

Get {serviceInstanceId}/tasks/{taskId}

GET

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

GET /openshift/v1/{serviceInstanceId}/tasks

Возвращает список задач

Parameters
  • serviceInstanceId (string) – идентификатор услуги (vDC)

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • tasks[].command (string) – тип задачи

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

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

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

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

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

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

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

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

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

  • tasks[].modifiedAt (string) – время последнего изменения ресурса

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

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

  • tasks[].serviceInstanceId (string) – идентификатор vDC (услуги)

  • tasks[].status (string) – статус выполнения задачи

GET /openshift/v1/{serviceInstanceId}/tasks/{taskId}

Возвращает задачу

Parameters
  • serviceInstanceId (string) – идентификатор услуги (vDC)

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

Status Codes
  • 200 OK – A successful response

Response JSON Object
  • task.command (string) – тип задачи

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

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

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

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

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

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

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

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

  • task.metadata.value (string) – значение ошибки

  • task.modifiedAt (string) – время последнего изменения ресурса

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

  • task.response.value (string) – значение ошибки

  • task.serviceInstanceId (string) – идентификатор vDC (услуги)

  • task.status (string) – статус выполнения задачи