ENetrebin (обсуждение | вклад) (Новая страница: «Список регионов и городов страны. Запрос создает в качестве полезной нагрузки <code>application...») |
Нет описания правки |
||
| Строка 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 города страны''''' | |||
Список регионов и городов страны. | Список регионов и городов страны. | ||
| Строка 119: | Строка 121: | ||
=== JSON-модель тела ответа === | === JSON-модель тела ответа === | ||
< | <{ | ||
"countryName": "France", | "countryName": "France", | ||
"countryCode": "FR", | "countryCode": "FR", | ||
Текущая версия от 16:35, 2 января 2025
API АппОптима / Эндпойнты среды / Развёртывание / Мониторинг реального пользователя / Географические регионы / GET города страны
Список регионов и городов страны.
Запрос создает в качестве полезной нагрузки application/json формат.
| GET | Удалось | https://{your-domain}/e/{your-environment-id}/api/v2/rum/cities/{countryCode}
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/rum/cities/{countryCode}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия « Чтение географических регионов » ( geographicRegions.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| countryCode | string | Код ISO требуемой страны.
Чтобы получить список доступных кодов стран, используйте запрос GET для всех стран . |
path | требуется |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | CountryWithRegionsWithCities | Успех. Ответ содержит список городов страны. |
| 404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект CountryWithRegionsWithCities
Информация о стране.
| Элемент | Тип | Описание |
|---|---|---|
| countryName | string | Название страны. |
| countryCode | string | Код ISO страны. |
| regionCount | integer | Количество регионов в стране. |
| regions | RegionWithCities[] | Список регионов страны. |
Объект RegionWithCities
Информация о регионе страны и его городах.
| Элемент | Тип | Описание |
|---|---|---|
| name | string | Название региона. |
| code | string | Код региона. |
| cityCount | integer | Количество городов в регионе страны. |
| cities | City[] | Список городов области. |
Объект _ City
Информация о городе.
| Элемент | Тип | Описание |
|---|---|---|
| name | string | Название города. |
| latitude | number | Широта города. |
| longitude | number | Долгота города. |
JSON-модель тела ответа
<{
"countryName": "France",
"countryCode": "FR",
"regionCount": 13,
"regions": [
{
"name": "Auvergne-Rhone-Alpes",
"code": "ARA",
"cityCount": 4,
"cities": [
{
"name": "Abondance",
"latitude": 46.2806,
"longitude": 6.7217
},
{
"name": "Abrest",
"latitude": 46.1008,
"longitude": 3.4463
}
]
}
]
}