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) – The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

  • tasks[].error.details[].typeUrl (string) – A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one «/» character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading «.» is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  • tasks[].error.details[].value (string) – Must be a valid serialized protocol buffer of the above specified type.

  • tasks[].error.message (string) – A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

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

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

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

  • tasks[].response.typeUrl (string) – A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one «/» character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading «.» is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  • tasks[].response.value (string) – Must be a valid serialized protocol buffer of the above specified type.

  • 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) – The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

  • task.error.details[].typeUrl (string) – A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one «/» character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading «.» is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  • task.error.details[].value (string) – Must be a valid serialized protocol buffer of the above specified type.

  • task.error.message (string) – A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

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

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

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

  • task.response.typeUrl (string) – A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one «/» character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading «.» is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  • task.response.value (string) – Must be a valid serialized protocol buffer of the above specified type.

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

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