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 (array) –

• tasks[].command (string) – тип задачи (создать кластер, удалить кластер и т.д)

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

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

• tasks[].error (object) – необязательное поле. Описание ошибки (если имеется)

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

• tasks[].error.details (array) – A list of messages that carry the error details. There is a common set of message types for APIs to use.

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

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

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

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

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

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

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

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

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

• 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 (object) –

• task.command (string) – тип задачи (создать кластер, удалить кластер и т.д)

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

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

• task.error (object) – необязательное поле. Описание ошибки (если имеется)

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

• task.error.details (array) – A list of messages that carry the error details. There is a common set of message types for APIs to use.

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

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

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

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

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

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

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

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

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

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

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

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

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