你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Data - List

参考

服务:: Maps

API 版本:: 2.0

用于提取以前使用数据上传上传的所有内容的列表。

注意

Azure Maps 数据服务停用

Azure Maps 数据服务（v1 和 v2）现已弃用，并将于 2024 年 9 月 16 日开始停用。为了避免服务中断，对数据服务的所有调用都需要在 2024 年 9 月 16 日之前更新为使用 Azure Maps 数据注册表服务。有关详细信息，请参阅如何创建数据注册表。

Data List API 是一个 HTTP GET 请求，允许调用方提取以前使用数据上传 API 上传的所有内容的列表。

提交列表请求

若要列出所有地图数据内容，将发出 GET 不带其他参数的请求。

列出数据响应

数据列表 API 以格式返回所有数据 json 的完整列表。响应包含每个数据资源的以下详细信息：

udid - 数据资源的唯一数据 ID。

location - 数据资源的位置。在此位置执行 HTTP GET 请求以下载数据。

下面是返回 udid 3 个数据资源的和 location 的示例响应：

{
    "mapDataList": 
    [
        {
            "udid": "9a1288fa-1858-4a3b-b68d-13a8j5af7d7c",
            "location": "https://us.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://us.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://us.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=2.0

URI 参数

名称	在	必需	类型	说明
geography	path	True	string	此参数指定 Azure Maps Creator 资源所在的位置。有效值为 us 和 eu。
api-version	query	True	string	Azure Maps API 的版本号。

请求头

名称	必需	类型	说明
x-ms-client-id		string	指定用于与 Microsoft Entra ID 安全模型结合使用的帐户。它表示 Azure Maps 帐户的唯一 ID，可从 Azure Maps 管理平面帐户 API 检索。若要在 Azure Maps 中使用 Microsoft Entra ID 安全性，请参阅以下文章以获取指导。

响应

名称	类型	说明
200 OK	MapDataListResult	列表数据请求已成功完成。响应正文包含以前上传的所有数据的列表。
Other Status Codes	ErrorResponse	发生了意外错误。

安全性

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 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。 * 使用 Azure Maps Web SDK 可以针对多个用例对应用程序进行基于配置的设置。

有关Microsoft标识平台的详细信息，请参阅 Microsoft标识平台概述。

类型: 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 门户中或使用 PowerShell、CLI、Azure SDK 或 REST API 创建 Azure Maps 帐户时预配的共享密钥。

使用此密钥，任何应用程序都可以访问所有 REST API。换句话说，此密钥可用作颁发密钥的帐户中的主密钥。

对于公开的应用程序，我们建议使用机密客户端应用程序方法来访问 Azure Maps REST API，以便安全地存储密钥。

类型: apiKey
在: query

SAS Token

这是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面通过 Azure Maps 资源上的列出 SAS 操作创建的共享访问签名令牌。

使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域 () 。换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序，我们建议在 Map 帐户资源上配置允许的来源的特定列表，以限制呈现滥用，并定期续订 SAS 令牌。

类型: apiKey
在: header

示例

List all the previously uploaded data

Sample request

HTTP

GET https://us.atlas.microsoft.com/mapData?api-version=2.0

Sample response

Status code:: 200

{
  "mapDataList": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "location": "https://us.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://us.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://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
      "sizeInBytes": 1650,
      "uploadStatus": "Pending"
    }
  ]
}

定义

名称	说明
DataFormat	已上传内容的数据格式。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
MapData	数据的详细信息。
MapDataListResult	数据列表 API 的响应模型。返回以前上传的所有数据的列表。
UploadStatus	内容的当前上传状态。

DataFormat

已上传内容的数据格式。

名称	类型	说明
dwgzippackage	string	包含 DWG 文件的 ZIP 包。
geojson	string	GeoJSON 是基于 JSON 的地理空间数据交换格式。
zip	string	压缩的数据格式。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

MapData

数据的详细信息。

名称	类型	说明
dataFormat	DataFormat	已上传内容的数据格式。
description	string	当前说明。
location	string	数据位置。在此位置执行 HTTP `GET` 请求以下载数据。
sizeInBytes	integer	内容的大小（以字节为单位）。
udid	string	数据的唯一数据 ID。
uploadStatus	UploadStatus	内容的当前上传状态。

MapDataListResult

数据列表 API 的响应模型。返回以前上传的所有数据的列表。

名称	类型	说明
mapDataList	MapData[]	以前上传的所有数据的列表。

UploadStatus

内容的当前上传状态。

名称	类型	说明
Completed	string	上传验证和处理已完成
Failed	string	上传验证和/或处理失败
Pending	string	正在处理上传

通过