Data - List Preview
Запрос list позволяет вызывающей объекту получить список всего содержимого, ранее отправленного с помощью отправки данных.
Применимо к: Ценовая категория S1.
Этот API позволяет вызывающей объекту получить список всего содержимого, отправленного ранее с помощью API отправки данных.
Примечание
Прекращение поддержки службы данных Azure Maps
Служба данных Azure Maps (версии 1 и 2) устарела и будет прекращена 24.09.24. Чтобы избежать перебоев в работе службы, необходимо обновить все вызовы к службе данных для использования службы реестра данных Azure Maps до 24.09.09.24. Дополнительные сведения см. в статье Создание реестра данных.
Запрос на отправку списка
Чтобы получить список всего содержимого данных карты, необходимо отправить GET
запрос без дополнительных параметров.
Вывод списка ответов на данные
API списка данных возвращает полный список всех данных в json
формате . Ответ содержит следующие сведения для каждого ресурса данных:
udid — уникальный идентификатор данных для ресурса данных.
location — расположение ресурса данных. Выполните http
GET
в этом расположении, чтобы скачать данные.
Ниже приведен пример ответа, возвращающего udid
и location
из трех ресурсов данных:
{
"mapDataList":
[
{
"udid": "9a1288fa-1858-4a3b-b68d-13a8j5af7d7c",
"location": "https://atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0",
"sizeInBytes": 29920,
"uploadStatus": "Completed"
},
{
"udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"location": "https://atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
"sizeInBytes": 1339,
"uploadStatus": "Completed"
},
{
"udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
"location": "https://atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
"sizeInBytes": 1650,
"uploadStatus": "Pending"
}]
}
GET https://{geography}.atlas.microsoft.com/mapData?api-version=1.0
GET https://{geography}.atlas.microsoft.com/mapData?subscription-key={subscription-key}&api-version=1.0
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
geography
|
path | True |
string |
Этот параметр указывает, где находится ресурс Azure Maps Creator. Допустимые значения: us и eu. |
api-version
|
query | True |
string |
Номер версии API Azure Maps Текущая версия — 1.0. |
subscription-key
|
query |
string |
Один из ключей Azure Maps, предоставляемых из учетной записи Azure Maps. Дополнительные сведения об управлении проверкой подлинности см. в этой статье . |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
x-ms-client-id |
string |
Указывает учетную запись, предназначенную для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Запрос на получение списка данных успешно завершен. Текст ответа содержит список всех ранее отправленных данных. Headers Content-Type: string |
|
400 Bad Request |
Недопустимый запрос: один или несколько параметров были указаны неправильно или являются взаимоисключающими. |
|
401 Unauthorized |
Доступ запрещен из-за недопустимого ключа подписки или недопустимого маркера носителя Microsoft Entra ID. Обязательно укажите действительный ключ для активной подписки Azure и ресурса Maps. В противном случае проверьте заголовок WWW-Authenticate на наличие кода ошибки и описания предоставленного маркера носителя Microsoft Entra ID. Headers WWW-Authenticate: string |
|
403 Forbidden |
Проблемы с разрешениями, емкостью или проверкой подлинности. |
|
404 Not Found |
Не найдено. Не удалось найти запрошенный ресурс, но он может быть снова доступен в будущем. |
|
500 Internal Server Error |
При обработке этого запроса возникла ошибка. Повторите попытку позже. |
Безопасность
AADToken
Это Microsoft Entra потоков OAuth 2.0. В сочетании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе может быть предоставлен доступ через встроенную или пользовательскую роль, состоящую из одного или нескольких разрешений для Azure Maps REST API.
Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, которые могут управлять доступом к определенным API и областям.
Примечания
- Это определение безопасности требует использования заголовка
x-ms-client-id
, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами.
объект Authorization URL
предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID.
* Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API.
* Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.
- Дополнительные сведения о платформа удостоверений Майкрософт см. в платформа удостоверений Майкрософт обзоре.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Это общий ключ, который подготавливается при создании учетной записи Azure Maps в портал Azure или с помощью PowerShell, CLI, пакетов AZURE SDK или REST API.
С помощью этого ключа любое приложение может получить доступ ко всем REST API. Иными словами, этот ключ можно использовать в качестве ключа master в учетной записи, в которую они выдаются.
Для общедоступных приложений мы рекомендуем использовать подход конфиденциальных клиентских приложений для доступа к 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
Примеры
List all the previously uploaded data
Sample Request
GET https://us.atlas.microsoft.com/mapData?subscription-key=[subscription-key]&api-version=1.0
Sample Response
{
"mapDataList": [
{
"udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
"location": "https://atlas.microsoft.com/mapData/f6495f62-94f8-0ec2-c252-45626f82fcb2?api-version=1.0",
"sizeInBytes": 29920,
"uploadStatus": "Completed"
},
{
"udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"location": "https://atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
"sizeInBytes": 1339,
"uploadStatus": "Completed"
},
{
"udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
"location": "https://atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
"sizeInBytes": 1650,
"uploadStatus": "Pending"
}
]
}
{
"error": {
"code": "400 BadRequest",
"message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
}
}
{
"error": {
"code": "401 Unauthorized",
"message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
}
}
{
"error": {
"code": "403 Forbidden",
"message": "Permission, capacity, or authentication issues."
}
}
{
"error": {
"code": "404 NotFound",
"message": "Not Found: the requested resource could not be found, but it may be available again in the future."
}
}
{
"error": {
"code": "500 InternalServerError",
"message": "An error occurred while processing the request. Please try again later."
}
}
Определения
Имя | Описание |
---|---|
Map |
Подробные сведения о данных. |
Map |
Модель ответа для API списка данных. Возвращает список всех ранее отправленных данных. |
OData |
Этот объект возвращается при возникновении ошибки в API Azure Maps. |
OData |
Этот объект ответа возвращается при возникновении ошибки в API Azure Maps. |
MapDataDetailInfo
Подробные сведения о данных.
Имя | Тип | Описание |
---|---|---|
location |
string |
Расположение данных. Выполните http |
sizeInBytes |
integer |
Размер содержимого в байтах. |
udid |
string |
Уникальный идентификатор данных. |
uploadStatus |
string |
Текущее состояние отправки содержимого. |
MapDataListResponse
Модель ответа для API списка данных. Возвращает список всех ранее отправленных данных.
Имя | Тип | Описание |
---|---|---|
mapDataList |
Список всех ранее отправленных данных. |
ODataError
Этот объект возвращается при возникновении ошибки в API Azure Maps.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ODataError. |
details |
Этот объект возвращается при возникновении ошибки в API Azure Maps. |
|
message |
string |
При наличии — понятное описание ошибки. |
target |
string |
Если доступно, целевой объект, вызывающий ошибку. |
ODataErrorResponse
Этот объект ответа возвращается при возникновении ошибки в API Azure Maps.
Имя | Тип | Описание |
---|---|---|
error |
Этот объект возвращается при возникновении ошибки в API Azure Maps. |