openapi: 3.0.1
info:
  title: Cloud.ru
  version: '1.0'
servers:
- url: dataplatform.api.cloud.ru
tags:
- name: BiService
- name: FlavorService
paths:
  /v1/bi-flavors:
    get:
      tags:
      - FlavorService
      summary: ListFlavors
      description: Возвращает список флейворов по заданным параметрам.
      operationId: FlavorService_ListFlavors
      parameters:
      - name: projectId
        in: query
        description: Идентификатор проекта.
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |-
          Максимальное количество результатов на странице ответа.

          Если значение больше [page_size], сервис возвращает [next_page_token], который используется в
          [ListFlavorsResponse]. Значение [page_size] по умолчанию: 1000.
        schema:
          type: string
          format: int64
      - name: pageToken
        in: query
        description: |-
          Токен запрашиваемой страницы с результатами.

          Чтобы получить результаты следующей страницы для [page_token], используем значение
          [ListFlavorsResponse.next_page_token], полученное из прошлого запроса.
        schema:
          type: string
      responses:
        "200":
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1ListFlavorsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
  /v1/bis:
    get:
      tags:
      - BiService
      summary: List
      description: Возвращает список экземпляров BI.
      operationId: BiService_List
      parameters:
      - name: clusterId
        in: query
        description: "Идентификатор кластера, в котором установлены экземпляры BI."
        required: true
        schema:
          type: string
      - name: projectId
        in: query
        description: "Идентификатор проекта, в котором установлены экземпляры BI."
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |-
          Максимальное количество результатов на странице при возврате ответа.

          Если количество доступных результатов больше максимального количества результатов, запрос возвращает токен
          следующей страницы, который можно использовать для получения следующей страницы результатов при последующих
          запросах списка экземпляров BI.
          Значение по умолчанию: 100.
        schema:
          type: string
          format: int64
      - name: pageToken
        in: query
        description: |-
          Токен страницы.

          Чтобы получить следующую страницу списка результатов, установите значение поля `page_token` в то, что вернул
          `next_page_token` при предыдущем запросе списка.
        schema:
          type: string
      - name: filter
        in: query
        description: "Выражение фильтра, которое фильтрует экземпляры BI, перечисл\
          енные в ответе."
        schema:
          type: string
      responses:
        "200":
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1ListBiResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
    post:
      tags:
      - BiService
      summary: Create
      description: Запускает операцию по созданию экземпляра BI.
      operationId: BiService_Create
      requestBody:
        description: Параметры запроса для создания экземпляра BI.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1CreateBiRequest'
        required: true
      responses:
        "200":
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudruoperationOperation'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      x-codegen-request-body-name: body
  /v1/bis/{biId}:
    get:
      tags:
      - BiService
      summary: Get
      description: Возвращает экземпляр BI.
      operationId: BiService_Get
      parameters:
      - name: biId
        in: path
        description: Идентификатор экземпляра BI.
        required: true
        schema:
          type: string
      responses:
        "200":
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudrudataplatformbiv1Bi'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
    put:
      tags:
      - BiService
      summary: Update
      description: Запускает операцию по обновлению экземпляра BI.
      operationId: BiService_Update
      parameters:
      - name: biId
        in: path
        description: Идентификатор экземпляра BI.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cloudrudataplatformbiv1BiServiceUpdateBody'
        required: true
      responses:
        "200":
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudruoperationOperation'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      x-codegen-request-body-name: body
    delete:
      tags:
      - BiService
      summary: Delete
      description: Запускает операцию по удалению экземпляра BI.
      operationId: BiService_Delete
      parameters:
      - name: biId
        in: path
        description: Идентификатор экземпляра BI.
        required: true
        schema:
          type: string
      responses:
        "200":
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudruoperationOperation'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
  /v1/bis/{biId}/operations:
    get:
      tags:
      - BiService
      summary: ListOperations
      description: Возвращает список объектов Operation по заданым параметрам.
      operationId: BiService_ListOperations
      parameters:
      - name: biId
        in: path
        description: Идентификатор BI.
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: |-
          Максимальное количество результатов на странице ответа.

          Если значение больше [page_size], сервис возвращает [next_page_token], который используется в
          [ListBiOperationsResponse]. Значение [page_size] по умолчанию: 1000.
        schema:
          type: string
          format: int64
      - name: pageToken
        in: query
        description: |-
          Токен запрашиваемой страницы с результатами.

          Чтобы получить результаты следующей страницы для [page_token], используем значение
          [ListBiOperationsResponse.next_page_token], полученное из прошлого запроса.
        schema:
          type: string
      responses:
        "200":
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1ListBiOperationsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
components:
  schemas:
    cloudrudataplatformbiv1Bi:
      required:
      - clusterId
      - enableExternalHost
      - flavorId
      - internalHost
      - logGroupId
      - name
      - projectId
      - subnetId
      - zoneId
      type: object
      properties:
        id:
          type: string
          description: Идентификатор экземпляра BI.
        name:
          type: string
          description: Название экземпляра BI.
        description:
          type: string
          description: Описание экземпляра BI.
        status:
          $ref: '#/components/schemas/cloudrudataplatformbiv1BiStatus'
        clusterId:
          type: string
          description: "Идентификатор кластера, в котором установлен экземпляр BI."
        projectId:
          type: string
          description: "Идентификатор проекта, в котором установлен экземпляр BI."
        flavorId:
          type: string
          description: Идентификатор типа конфигурации вычислительной мощности.
        subnetId:
          type: string
          description: Идентификатор подсети в сети.
        enableExternalHost:
          type: boolean
          description: Требуется ли публичный IP-адрес экземпляру BI во внешней сети.
        internalHost:
          type: string
          description: Адрес экземпляра BI во внутренней сети.
        externalHost:
          type: string
          description: Адрес экземпляра BI во внешней сети.
          readOnly: true
        zoneId:
          type: string
          description: Идентификатор зоны доступности ресурса.
        logGroupId:
          type: string
          description: Идентификатор группы журналов.
        createdBy:
          type: string
          description: "Идентификатор пользователя, который создал экземпляр BI."
          readOnly: true
        updatedBy:
          type: string
          description: "Идентификатор пользователя, который последним обновил экзе\
            мпляр BI."
          readOnly: true
        createdAt:
          type: string
          description: Время создания экземпляра BI.
          format: date-time
          readOnly: true
        updatedAt:
          type: string
          description: Время последнего обновления экземпляра BI.
          format: date-time
          readOnly: true
      description: Ответ на запрос получения экземпляра BI.
    cloudrudataplatformbiv1BiServiceUpdateBody:
      type: object
      properties:
        name:
          type: string
          description: Название экземпляра BI.
        description:
          type: string
          description: Описание экземпляра BI.
      description: Параметры запроса для обновления экземпляра BI.
    cloudrudataplatformbiv1BiStatus:
      type: string
      description: |-
        Статус экземпляра BI.

         - BI_STATUS_UNSPECIFIED: Не указано.
         - PENDING: Ожидание.
         - CREATING: Создание.
         - RUNNING: Выполнение.
         - RESUMING: Возобновление.
         - UPDATING: Обновление.
         - DELETED: Удалено.
         - DELETING: Удаление.
         - ERROR: Ошибка.
         - SUSPENDING: Приостановка.
         - SUSPENDED: Приостановлено.
         - FAILED: Неудача.
      default: BI_STATUS_UNSPECIFIED
      enum:
      - BI_STATUS_UNSPECIFIED
      - PENDING
      - CREATING
      - RUNNING
      - RESUMING
      - UPDATING
      - DELETED
      - DELETING
      - ERROR
      - SUSPENDING
      - SUSPENDED
      - FAILED
    cloudruoperationOperation:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: Идентификатор операции.
        resourceName:
          title: |-
            Информация о ресурсе, над которым производится операция.
            Строится следующим образом: urn:cloud:SERVICE:ZONE_OPT:PROJECT_OPT:RESOURCE_TYPE_OPT.
            Пример 1: urn:cloud:dataplatform::54295782-7aef-43e6-b33b-c9735938677a:metastore_server
          type: string
          readOnly: true
        resourceId:
          title: |-
            Уникальный идентификатор ресурса, над которым производится операция.
            Пример: 54295782-7aef-43e6-b33b-c9735938677a
          type: string
          readOnly: true
        createdAt:
          type: string
          description: Время создания операции.
          format: date-time
          readOnly: true
        updatedAt:
          type: string
          description: Время последнего изменения операции.
          format: date-time
          readOnly: true
        done:
          type: boolean
          description: |-
            Флаг завершенности операции.
            Если значение `false`, то операция в процессе выполнения.
            Если значение `true`, то операция завершена и поле `error` может быть заполнено.
          readOnly: true
        description:
          type: string
          description: Описание операции. От 0 до 255 символов.
          readOnly: true
        error:
          $ref: '#/components/schemas/rpcStatus'
    dataplatformprivatebiv1Bi:
      type: object
      properties:
        id:
          type: string
          description: ID of the BI.
        name:
          type: string
          description: Name of the BI.
        description:
          type: string
          description: Description of the BI.
        status:
          $ref: '#/components/schemas/dataplatformprivatebiv1BiStatus'
        clusterId:
          type: string
          description: ID of the cluster.
        projectId:
          type: string
          description: ID of the project.
        flavorId:
          type: string
          description: ID of the flavor.
        chartId:
          type: string
          description: ID of the chart.
        subnetId:
          type: string
          description: ID of the network subnet.
        enableExternalHost:
          type: boolean
          description: Enable external host.
        internalHost:
          type: string
          description: Internal host address.
        externalHost:
          type: string
          description: External host address.
        zoneId:
          type: string
          description: ID of the resource availability zone.
        logGroupId:
          type: string
          description: ID of the log group.
        createdBy:
          type: string
          description: UUID of the role creates BI.
        updatedBy:
          type: string
          description: UUID of the role updates BI.
        createdAt:
          type: string
          description: "Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\
            \ text format."
          format: date-time
        updatedAt:
          type: string
          description: "Update timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\
            \ text format."
          format: date-time
      description: "Response message for [BiService.Get]."
    dataplatformprivatebiv1BiStatus:
      type: string
      description: |-
        Internal BI status, COMPATIBLE but NOT LIMITED statuses of the Deployer responses in `instance-lib`.

         - BI_STATUS_UNSPECIFIED: BI status unspecified.
         - PENDING: Pending.
         - CREATING: Creating.
         - RUNNING: Running.
         - RESUMING: Resuming.
         - UPDATING: Updating.
         - DELETED: Deleted.
         - DELETING: Deleting.
         - ERROR: Error.
         - SUSPENDING: Suspending.
         - SUSPENDED: Suspended.
         - FAILED: Failed.
      default: BI_STATUS_UNSPECIFIED
      enum:
      - BI_STATUS_UNSPECIFIED
      - PENDING
      - CREATING
      - RUNNING
      - RESUMING
      - UPDATING
      - DELETED
      - DELETING
      - ERROR
      - SUSPENDING
      - SUSPENDED
      - FAILED
    operationv1Operation:
      type: object
      properties:
        id:
          type: string
          description: ID of the operation.
        description:
          type: string
          description: |-
            Description of the operation. 0-256 characters long.

            ex: Create VM, Stop VM, Delete Disk, Snapshot Disk, etc
        createdAt:
          type: string
          description: Creation timestamp.
          format: date-time
        createdBy:
          type: string
          description: ID of the user or service account who initiated the operation.
        modifiedAt:
          type: string
          description: The time when the Operation resource was last modified.
          format: date-time
        done:
          type: boolean
          description: |-
            If the value is `false`, it means the operation is still in progress.
            If `true`, the operation is completed, and either `error` or `response` is available.
        metadata:
          $ref: '#/components/schemas/protobufAny'
        error:
          $ref: '#/components/schemas/rpcStatus'
        response:
          $ref: '#/components/schemas/protobufAny'
        percent:
          title: Percent for check progress of operation
          type: integer
          format: int32
        objectId:
          title: Specify object id for data platform values
          type: string
        objectType:
          title: Object type for data platform objects
          type: string
        workflow:
          $ref: '#/components/schemas/v1TemporalWorkflow'
      description: "An Operation resource. For more information, see [Operation](/docs/api-design-guide/concepts/operation)."
    protobufAny:
      type: object
      properties:
        '@type':
          type: string
          description: |-
            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. As of May 2023, there are no widely used type server
            implementations and no plans to implement one.

            Schemes other than `http`, `https` (or the empty scheme) might be
            used with implementation specific semantics.
      additionalProperties:
        type: object
      description: |-
        `Any` contains an arbitrary serialized protocol buffer message along with a
        URL that describes the type of the serialized message.

        Protobuf library provides support to pack/unpack Any values in the form
        of utility functions or additional generated methods of the Any type.

        Example 1: Pack and unpack a message in C++.

            Foo foo = ...;
            Any any;
            any.PackFrom(foo);
            ...
            if (any.UnpackTo(&foo)) {
              ...
            }

        Example 2: Pack and unpack a message in Java.

            Foo foo = ...;
            Any any = Any.pack(foo);
            ...
            if (any.is(Foo.class)) {
              foo = any.unpack(Foo.class);
            }
            // or ...
            if (any.isSameTypeAs(Foo.getDefaultInstance())) {
              foo = any.unpack(Foo.getDefaultInstance());
            }

         Example 3: Pack and unpack a message in Python.

            foo = Foo(...)
            any = Any()
            any.Pack(foo)
            ...
            if any.Is(Foo.DESCRIPTOR):
              any.Unpack(foo)
              ...

         Example 4: Pack and unpack a message in Go

             foo := &pb.Foo{...}
             any, err := anypb.New(foo)
             if err != nil {
               ...
             }
             ...
             foo := &pb.Foo{}
             if err := any.UnmarshalTo(foo); err != nil {
               ...
             }

        The pack methods provided by protobuf library will by default use
        'type.googleapis.com/full.type.name' as the type URL and the unpack
        methods only use the fully qualified type name after the last '/'
        in the type URL, for example "foo.bar.com/x/y.z" will yield type
        name "y.z".

        JSON
        ====
        The JSON representation of an `Any` value uses the regular
        representation of the deserialized, embedded message, with an
        additional field `@type` which contains the type URL. Example:

            package google.profile;
            message Person {
              string first_name = 1;
              string last_name = 2;
            }

            {
              "@type": "type.googleapis.com/google.profile.Person",
              "firstName": <string>,
              "lastName": <string>
            }

        If the embedded message type is well-known and has a custom JSON
        representation, that representation will be embedded adding a field
        `value` which holds the custom JSON in addition to the `@type`
        field. Example (for message [google.protobuf.Duration][]):

            {
              "@type": "type.googleapis.com/google.protobuf.Duration",
              "value": "1.212s"
            }
    rpcStatus:
      type: object
      properties:
        code:
          type: integer
          description: |-
            The status code, which should be an enum value of
            [google.rpc.Code][google.rpc.Code].
          format: int32
        message:
          type: string
          description: |-
            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.
        details:
          type: array
          description: |-
            A list of messages that carry the error details.  There is a common set of
            message types for APIs to use.
          items:
            $ref: '#/components/schemas/protobufAny'
      description: |-
        The `Status` type defines a logical error model that is suitable for
        different programming environments, including REST APIs and RPC APIs. It is
        used by [gRPC](https://github.com/grpc). Each `Status` message contains
        three pieces of data: error code, error message, and error details.

        You can find out more about this error model and how to work with it in the
        [API Design Guide](https://cloud.google.com/apis/design/errors).
    v1BiActionResponse:
      type: object
      properties:
        bi:
          $ref: '#/components/schemas/dataplatformprivatebiv1Bi'
        operation:
          $ref: '#/components/schemas/operationv1Operation'
      description: "Response message for [BiService.Create], [BiService.Update], [BiService.Delete]."
    v1CreateBiRequest:
      required:
      - clusterId
      - enableExternalHost
      - flavorId
      - logGroupId
      - name
      - projectId
      - subnetId
      - zoneId
      type: object
      properties:
        name:
          type: string
          description: Название экземпляра BI.
        description:
          type: string
          description: Описание экземпляра BI.
        clusterId:
          type: string
          description: "Идентификатор кластера, в котором будет установлен экземпл\
            яры BI."
        projectId:
          type: string
          description: "Идентификатор проекта, в котором будет установлен экземпля\
            ры BI."
        flavorId:
          type: string
          description: Идентификатор типа конфигурации вычислительной мощности.
        subnetId:
          type: string
          description: Идентификатор подсети в сети.
        enableExternalHost:
          type: boolean
          description: Требуется ли публичный IP-адрес экземпляру BI во внешней сети.
        zoneId:
          type: string
          description: Идентификатор зоны доступности ресурса.
        logGroupId:
          type: string
          description: Идентификатор группы журналов.
      description: Параметры запроса для создания экземпляра BI.
    v1Flavor:
      required:
      - cpu
      - memory
      type: object
      properties:
        id:
          type: string
          description: Идентификатор флейвора.
        cpu:
          type: string
          description: Количество ядер CPU для данного флейвора.
          format: int64
        memory:
          type: string
          description: Объем памяти для данного флейвора.
          format: int64
      description: Ответ на запрос получения флейвора BI.
    v1ListBiActionResponse:
      type: object
      properties:
        bis:
          type: array
          description: List of BI and Operations.
          items:
            $ref: '#/components/schemas/v1BiActionResponse'
        nextPageToken:
          type: string
          description: |-
            Token for getting the next page of the list. If the number of results is greater than the specified
            [ListBiRequest.page_size], use `next_page_token` as the value for the [ListBiRequest.page_token]
            parameter in the next list request.

            Each subsequent page will have its own `next_page_token` to continue paging through the results.
      description: "Response message for [BiService.List]."
    v1ListBiOperationsResponse:
      type: object
      properties:
        operations:
          type: array
          description: Список операций.
          items:
            $ref: '#/components/schemas/cloudruoperationOperation'
        nextPageToken:
          type: string
          description: Токен следующей страницы с результатами.
      description: Описание параметров ответа при получении ответа на запрос списка
        операций.
    v1ListBiResponse:
      type: object
      properties:
        bis:
          type: array
          description: Список экземпляров BI.
          items:
            $ref: '#/components/schemas/cloudrudataplatformbiv1Bi'
        nextPageToken:
          type: string
          description: |-
            Токен для получения следующей страницы списка результатов.

            Каждая последующая страница будет иметь свой собственный `next_page_token` для продолжения просмотра результатов.
      description: Ответ на запрос получения списка экземпляров BI.
    v1ListFlavorsResponse:
      type: object
      properties:
        flavors:
          type: array
          description: Список флейворов.
          items:
            $ref: '#/components/schemas/v1Flavor'
        nextPageToken:
          type: string
          description: Токен следующей страницы с результатами.
      description: Описание параметров ответа при получении ответа на запрос списка
        флейворов.
    v1TemporalWorkflow:
      type: object
      properties:
        runId:
          title: Temporal workflow run id
          type: string
        workflowKey:
          title: Temporal workflow key
          type: string
x-original-swagger-version: "2.0"