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

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

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

Перечисляет регионы страны.

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

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

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

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

Параметры

Параметр	Тип	Описание	In	Необходимость
countryCode	string	Код ISO требуемой страны. Чтобы получить список доступных кодов стран, используйте запрос GET для всех стран .	path	требуется

Ответ

Коды ответов

Код	Тип	Описание
200	CountryWithRegions	Успех. Ответ содержит список регионов страны.
404	ErrorEnvelope	Не удалось. Запрошенный ресурс не существует.

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

Объект `CountryWithRegions`

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

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

Объект `Region`

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

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

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

<{
  "countyName": "France",
  "countryCode": "FR",
  "regionCount": 2,
  "regions": [
    {
      "name": "Auvergne-Rhone-Alpes",
      "code": "ARA"
    },
    {
      "name": "Bourgogne-Franche-Comte",
      "code": "BFC"
    }
  ]
}

@@ Строка 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 регионы страны'''''
 Перечисляет регионы страны.
@@ Строка 105: / Строка 107: @@
       }
     ]
-  }</code>
+  }