Получение списка подписок Microsoft Azure Plan

Метод используется для получения многостраничного списка подписок Microsoft Azure Plan на основе модуля MicrosoftCSPProductsPlugin, кроме подписок в статусах Удаляется, Удалена, Ошибка установки, Ошибка удаления, для аккаунта, к которому есть доступ у текущего пользователя.

GET {reseller_domain}/plugin_microsoft_csp_products/internal_api/azure_subscriptions

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
account_id	query	integer	Обязательный	ID аккаунта, для которого запрашивается список подписок
page[size]	query	integer	Опциональный	Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)
page[number]	query	integer	Опциональный	Параметр постраничной навигации. Номер страницы ответа (1 по умолчанию)
filter[full_name][like]	query	string	Опциональный	Предназначен для фильтрации списка по части ID и названия подписки

Модель ответа

Название			Тип данных	Описание
data			array of objects	Данные ответа
	id		string	ID подписки
	type		string	Тип данных
	attributes		object	Информация о подписке
		created_at	string	Дата и время создания подписки
		name	string	Название подписки
		status	string	Статус подписки: ordered — Новый заказ. active — Активная. delivered — Доставлена. graced — Просрочена оплата. stopped — Остановлена. activation_failed — Ошибка активации. renewal_failed — Ошибка продления. updating_failed — Ошибка обновления. stopping_failed — Остановка не может быть завершена. switching_failed — Ошибка переключения. installing — Установка. activating — Активируется. renewing — Продление. updating — Обновление. stopping — Останавливается. switching — Переключение. waiting_for_manual_approve — Ожидает ручного подтверждения. blocked — Заблокирована.
		azure_plan_id	string	ID "контейнера" Azure Plan
		azure_subscription_id	string	ID подписки в Microsoft
links			object	Ссылки для постраничной навигации
	self		string	Текущая страница
	first		string	Первая страница
	prev		string	Предыдущая страница (при наличии)
	next		string	Следующая страница (при наличии)
	last		string	Последняя страница
meta			object	Информация о постраничной навигации
	current_page		integer	Номер текущей страницы
	page_count		integer	Общее число страниц

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

Bash

curl --location --request GET 'https://test.activeplatform.com/plugin_microsoft_csp_products/internal_api/azure_subscriptions?account_id=1' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

Пример ответа

JSON

{
  "data": [
    {
      "id": "32",
      "type": "subscriptions",
      "attributes": {
        "created_at": "2023-01-05T07:55:07.096Z",
        "name": "Azure_Plan",
        "status": "active",
        "azure_plan_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "azure_subscription_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
      }
    },
    {
      "id": "33",
      "type": "subscriptions",
      "attributes": {
        "created_at": "2023-01-05T07:55:08.803Z",
        "name": "Azure_Plan",
        "status": "active",
        "azure_plan_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "azure_subscription_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
      }
    }
  ],
  "links": {
    "self": "https://test.activeplatform.com/plugin_microsoft_csp_products/internal_api/azure_subscriptions?account_id=1&page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "first": "https://test.activeplatform.com/plugin_microsoft_csp_products/internal_api/azure_subscriptions?account_id=1&page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "prev": null,
    "next": null,
    "last": "https://test.activeplatform.com/plugin_microsoft_csp_products/internal_api/azure_subscriptions?account_id=1&page%5Bnumber%5D=1&page%5Bsize%5D=50"
  },
    "meta": {
        "current_page": 1,
        "page_count": 1
    }
}