Geolocation - Get IP To Location

  • Ссылка
Service:
Maps
API Version:
1.0

Область применения: см. ценовые категории.

Эта служба вернет код страны ISO для указанного IP-адреса. Разработчики могут использовать эту информацию для блокировки или изменения определенного содержимого в зависимости от географических расположений, из которых просматривается приложение.

GET https://atlas.microsoft.com/geolocation/ip/json?api-version=1.0&ip={ip}

Параметры URI

Name In Required Type Description
format
 path True

Требуемый формат ответа. Поддерживается только формат json.
api-version
 query True
  • string

Номер версии API Azure Maps
ip
 query True
  • string

IP-адрес. Разрешены как IPv4, так и IPv6.

Заголовок запроса

Name Required Type Description
x-ms-client-id
  • string

Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Azure AD. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Azure AD безопасности в Azure Maps см. в следующих статьях.

Ответы

Name Type Description
200 OK

ОК
Other Status Codes

Произошла непредвиденная ошибка.

Безопасность

AADToken

Это Azure Active Directory потоки OAuth2. При связывании с управлением доступом на основе ролей Azure можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким Azure Maps учетной записи ресурсов или вложенным ресурсам. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для Azure Maps REST API.

Для реализации сценариев рекомендуется просматривать основные понятия проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным API и областям.

Примечания

  • Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какой Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Карты.

Это Authorization URL зависит от экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Azure Active Directory. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.

  • В настоящее время Azure Active Directory версии 1.0 или версии 2.0 поддерживает рабочие, учебные заведения и гости, но не поддерживает личные учетные записи.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, подготовленный при создании ресурса Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого ключа любой приложению разрешен доступ ко всем REST API. Другими словами, в настоящее время эти ключи можно рассматривать как главные ключи для учетной записи, для которой они выданы.

Для общедоступных приложений мы рекомендуем использовать доступ между серверами Azure Maps REST API, где этот ключ можно безопасно хранить.

Type: apiKey
In: query

SAS Token

Это маркер подписанного URL-адреса создается из операции LIST SAS для ресурса Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого маркера любое приложение имеет право на доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы приложения могли управлять доступом более безопасным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Type: apiKey
In: header

Примеры

Successfully retrieve country code from IP address

Sample Request

GET https://atlas.microsoft.com/geolocation/ip/json?api-version=1.0&ip=2001:4898:80e8:b::189

Sample Response

Status code:
200 
{
  "countryRegion": {
    "isoCode": "US"
  },
  "ipAddress": "2001:4898:80e8:b::189"
}

Определения

CountryRegion

Объект, содержащий сведения о стране или регионе.
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Сообщение об ошибке
IpAddressToLocationResult

Этот объект возвращается из успешного вызова IP-адреса в API страны или региона
JsonFormat

Требуемый формат ответа. Поддерживается только формат json.

CountryRegion

Объект, содержащий сведения о стране или регионе.

Name Type Description
isoCode
  • string

Код 2-символьного IP-адреса (ISO 3166-1) страны или региона. Обратите внимание, что IP-адрес в диапазонах, зарезервированных для специальной цели, возвращает значение NULL для страны или региона.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Name Type Description
info
  • object

Дополнительные сведения.
type
  • string

Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Name Type Description
additionalInfo

Дополнительные сведения об ошибке.
code
  • string

Код ошибки.
details

Сведения об ошибке.
message
  • string

Сообщение об ошибке.
target
  • string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Name Type Description
error

Объект ошибки.

IpAddressToLocationResult

Этот объект возвращается из успешного вызова IP-адреса в API страны или региона

Name Type Description
countryRegion

Объект, содержащий сведения о стране или регионе.
ipAddress
  • string

IP-адрес запроса.

JsonFormat

Требуемый формат ответа. Поддерживается только формат json.

Name Type Description
json
  • string

Формат обмена данными нотации объектов JavaScript