GraphQL API

GraphQL API PS Cloud Services использует язык запросов GraphQL.

Документация API и список эндпоинтов описаны в статье: Описание GraphQL Playground.
Чтобы пользоваться API, необходимо получить токен доступа к приложению.

Использование API через PostmanИспользование API через Postman

Настройка запроса в PostmanНастройка запроса в Postman

1. Войдите в свой аккаунт Postman.
2. Создайте новый запрос.
3. Укажите метод POST (все запросы GraphQL отправляются через POST).
4. Введите URL сервиса, например:

https://console.ps.kz/cloud/graphql

Заголовки (Headers)Заголовки (Headers)

Во вкладке Headers укажите:

• X-User-Token — ваш токен доступа к приложению.
• Content-Type — application/json.

Тело запроса (Body)Тело запроса (Body)

1. Перейдите во вкладку Body.
2. Выберите тип GraphQL.
3. Вставьте ваш запрос.

Пример Query-запросаПример Query-запроса

Запрос для получения списка виртуальных машин в сервисе «Облачные серверы»:

query {
  vpc {
    instance {
      pagination(perPage: 1000, filter: { serviceId: "13745", status: ACTIVE }) {
        items {
          instanceName
          floatingipsArray
          ram
          cores
        }
      }
    }
  }
}

Разбор запроса:

• query — запрос на чтение данных.
• vpc — обращение к сервису «Облачные серверы».
• instance — список виртуальных машин.
• pagination — ограничение вывода (например, до 1000 элементов).
• filter — фильтрация по ID проекта и статусу.
• items — поля, которые будут возвращены: имя, IP, RAM, CPU.

Пример Mutation-запросаПример Mutation-запроса

Mutation-запросы позволяют изменять данные. Например, изменить конфигурацию виртуальной машины:

mutation {
  vpc {
    instance {
      resizeInstance(
        input: {
          flavorId: "1517fe16-592c-4938-9bb6-d5ec5593041a"
          serviceId: "13745"
          instanceId: "aeaeda28-6ae3-4895-9120-5f46af358cc0"
          regionId: "kz-ala-1"
        }
      ) {
        instance {
          instanceName
          flavor {
            ram
            vcpus
          }
          regionId
        }
      }
    }
  }
}

Пояснения:

• mutation — запрос на изменение.
• resizeInstance — операция изменения конфигурации.
• input — параметры изменения:
  • flavorId — ID новой конфигурации (CPU/RAM).
  • serviceId — ID проекта.
  • instanceId — ID виртуальной машины.
  • regionId — регион.
• В блоке instance указываем, какие данные вернуть после изменения: имя, RAM, CPU, регион.

Выполнение запросаВыполнение запроса

Нажмите кнопку Send.
Результат выполнения отобразится в нижней части окна Postman.

ЗаключениеЗаключение

GraphQL API PS Cloud Services предоставляет гибкий способ управления облачными ресурсами.

Вы можете:

• выполнять query-запросы для получения информации о виртуальных машинах, проектах и сервисах;
• использовать mutation-запросы для изменения конфигураций или управления ресурсами;
• работать через удобные инструменты, такие как Postman или GraphQL Playground.

Благодаря этому подходу администрирование становится более прозрачным и автоматизированным, что особенно полезно при работе с большим числом проектов и сервисов.