Открыть меню
Открыть персональное меню
Вы не представились системе
Your IP address will be publicly visible if you make any edits.

GET регионы: различия между версиями

Материал из Документация АппОптима
(Новая страница: «Список стран и их регионов. Запрос создает в качестве полезной нагрузки <code>application/json</code>...»)
 
Нет описания правки
 
(не показаны 2 промежуточные версии 2 участников)
Строка 1: Строка 1:
'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%9C%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%B8%D0%BD%D0%B3%20%D1%80%D0%B5%D0%B0%D0%BB%D1%8C%D0%BD%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F%20(RUM) Мониторинг реального пользователя] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%93%D0%B5%D0%BE%D0%B3%D1%80%D0%B0%D1%84%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B5%20%D1%80%D0%B5%D0%B3%D0%B8%D0%BE%D0%BD%D1%8B Географические регионы] / GET регионы'''''
Список стран и их регионов.
Список стран и их регионов.


Строка 4: Строка 6:
{| class="wikitable"
{| class="wikitable"
| rowspan="2" |GET
| rowspan="2" |GET
|Managed
|АппОптима
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/rum/regions</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/rum/regions</nowiki></code>
|-
|-
Строка 32: Строка 34:
=== Объекты тела ответа ===
=== Объекты тела ответа ===


==== Объект _ <code>CountryListWithRegions</code> ====
==== Объект <code>CountryListWithRegions</code> ====
Список стран с их регионами.
Список стран с их регионами.
{| class="wikitable"
{| class="wikitable"
Строка 89: Строка 91:


=== JSON-модель тела ответа ===
=== JSON-модель тела ответа ===
  <code>{
  <{
   "countryCount": 252,
   "countryCount": 252,
   "countries": [
   "countries": [
Строка 123: Строка 125:
     }
     }
   ]
   ]
  }</code>
  }

Текущая версия от 16:35, 2 января 2025

API АппОптима / Эндпойнты среды / Развёртывание / Мониторинг реального пользователя / Географические регионы / GET регионы

Список стран и их регионов.

Запрос создает в качестве полезной нагрузки application/json формат.

GET АппОптима https://{your-domain}/e/{your-environment-id}/api/v2/rum/regions
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/rum/regions

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия « Чтение географических регионов » ( geographicRegions.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответов

Код Тип Описание
200 CountryListWithRegions Успех. Ответ содержит список стран с региональными подразделениями.

Объекты тела ответа

Объект CountryListWithRegions

Список стран с их регионами.

Элемент Тип Описание
countryCount integer Количество стран.
countries CountryRegions[] Список стран.

Объект CountryRegions

Информация о стране.

Элемент Тип Описание
name string Название страны.
code string Код ISO страны.
regionCount integer Количество регионов в стране.
regions Region[] Список регионов страны.

Объект Region

Информация о регионе страны.

Элемент Тип Описание
name string Название региона.
code string Код региона.

JSON-модель тела ответа

<{
  "countryCount": 252,
  "countries": [
    {
      "name": "France",
      "code": "FR",
      "regionCount": 2,
      "regions": [
        {
          "name": "Auvergne-Rhone-Alpes",
          "code": "ARA"
        },
        {
          "name": "Bourgogne-Franche-Comte",
          "code": "BFC"
        }
      ]
    },
    {
      "name": "Belgium",
      "code": "BE",
      "regionCount": 2,
      "regions": [
        {
          "name": "Antwerp Province",
          "code": "01"
        },
        {
          "name": "Brussels Captial",
          "code": "11"
        }
      ]
    }
  ]
}