GraphQL Playground

GraphQL Playground — встроенный инструмент для работы с API в консоли PS Cloud Services. Он позволяет выполнять запросы к GraphQL-серверу, получать структурированные ответы и просматривать автоматически сгенерированную документацию API. Подходит как разработчикам, так и администраторам.

Вход в GraphQL PlaygroundВход в GraphQL Playground

1. Войдите в консоль управления PS Ckoud Services.

2. В адресной строке используйте ссылку:

   https://console.ps.kz/НАЗВАНИЕ-СЕРВИСА/graphql
   

   Где вместо НАЗВАНИЕ-СЕРВИСА укажите один из сервисов:

   • account — аккаунты и пользователи;
   • domains — доменные имена;
   • cloud — облачные серверы (VPC);
   • dbaas — базы данных;
   • k8saas — кластеры Kubernetes;
   • lbaas — балансировщики нагрузки;
   • vps — VPS.

После перехода откроется интерфейс GraphQL Playground.

Работа с документациейРабота с документацией

На вкладке DOCS отображается автоматически сгенерированная документация:

• Query — чтение данных (аналог GET в REST).
• Mutation — изменение данных (аналог POST/PUT).
• Subscriptions — подписки на события (например, уведомления в реальном времени).

Каждый объект API описан подробно: типы данных, аргументы и доступные поля.

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

Рабочая область делится на две части:

• слева — ввод запросов (Query и Mutation);
• справа — результат в формате JSON.

Запуск:

• кнопка Play (треугольник);
• Ctrl + Enter (Windows/Linux);
• Cmd + Enter (MacOS).

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

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

Результат: список инстансов с именем, IP-адресами, RAM и количеством ядер.

Пример 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
        }
      }
    }
  }
}

Результат: новые значения CPU и RAM для выбранного инстанса.

ИтогиИтоги

GraphQL Playground позволяет:

• работать с API без внешних инструментов;
• просматривать документацию по объектам и методам;
• выполнять Query и Mutation-операции;
• проверять результат сразу в ответе сервера.

Это универсальный инструмент для администраторов и разработчиков.