Data - List Preview

參考

Service:: Maps

API Version:: 1.0

List 要求可讓呼叫端擷取先前使用數據上傳上傳的所有內容清單。
適用於： S1 定價層。

此 API 可讓呼叫者擷取先前使用數據上傳 API 上傳的所有內容清單。

注意

Azure 地圖服務數據服務淘汰

Azure 地圖服務數據服務 (v1 和 v2) 現在已被取代，將於 9/16/24 淘汰。若要避免服務中斷，所有對數據服務的呼叫都必須更新，才能使用 9/16/24 Azure 地圖服務 Data Registry 服務。如需詳細資訊，請參閱如何建立數據登錄。

提交清單要求

若要列出所有地圖數據內容，您將發出 GET 沒有其他參數的要求。

列出數據回應

數據清單 API 會以 json 格式傳回所有資料的完整清單。回應包含每個資料資源的下列詳細資料：

udid - 數據資源的唯一數據識別碼。

location - 數據資源的位置。在此位置上執行 HTTP GET 以下載數據。

以下是傳回 udid 和 location 3 個數據資源的範例回應：

{
    "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

With optional parameters:

GET https://{geography}.atlas.microsoft.com/mapData?subscription-key={subscription-key}&api-version=1.0

URI 參數

名稱	位於	必要	類型	Description
geography	path	True	string	此參數會指定 Azure 地圖服務 Creator 資源所在的位置。有效值為us和 eu。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。目前的版本為 1.0
subscription-key	query		string	Azure 地圖帳戶提供的其中一個 Azure 地圖服務金鑰。如需如何管理驗證的詳細資訊，請參閱這篇文章。

要求標頭

名稱	必要	類型	Description
x-ms-client-id		string	指定哪個帳戶與 Microsoft Entra ID 安全性模型搭配使用。它代表 Azure 地圖服務帳戶的唯一標識符，而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性，請參閱下列文章以取得指引。

回應

名稱	類型	Description
200 OK	MapDataListResponse	已成功完成列出數據要求。回應本文包含所有先前上傳的數據清單。 Headers Content-Type: string
400 Bad Request	ODataErrorResponse	不正確的要求：一或多個參數未正確指定或互斥。
401 Unauthorized	ODataErrorResponse	因為訂用帳戶金鑰無效或 Microsoft Entra ID 持有人令牌無效而拒絕存取。請務必為作用中的 Azure 訂用帳戶和地圖服務資源提供有效的密鑰。否則，請確認 WWW-Authenticate 標頭中提供 Microsoft Entra ID 持有人令牌的錯誤碼和描述。 Headers WWW-Authenticate: string
403 Forbidden	ODataErrorResponse	許可權、容量或驗證問題。
404 Not Found	ODataErrorResponse	找不到：找不到要求的資源，但未來可能會再次提供。
500 Internal Server Error	ODataErrorResponse	處理這個要求時發生錯誤。請稍後再試一次。

安全性

AADToken

這些是 Microsoft Entra OAuth 2.0 流程。與 Azure 角色型存取控制配對時，可用來控制對 #DE76344FCFDF946F498B41950E2A2ADF4 REST API 的存取。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。任何使用者、群組或服務主體都可以透過內建角色或由一或多個許可權組成的自定義角色來授與存取權，以 Azure 地圖服務 REST API。

若要實作案例，建議您檢視驗證概念。總而言之，此安全性定義會透過能夠針對特定 API 和範圍進行訪問控制的物件，提供將應用程式模型化 () 的解決方案。

備註

此安全性定義需要使用x-ms-client-id 標頭來指出應用程式要求存取權 Azure 地圖服務資源。這可以從地圖管理 API 取得。

Authorization URL專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL 和 Microsoft Entra ID 設定。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 管理平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式設定。

如需 Microsoft 身分識別平台的詳細資訊，請參閱 Microsoft 身分識別平台概觀。

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

Scopes

名稱	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

這是在 Azure 入口網站或使用PowerShell、CLI、Azure SDK 或 REST API 中建立 Azure 地圖服務帳戶時所佈建的共用密鑰。

使用此金鑰，任何應用程式都可以存取所有 REST API。換句話說，此金鑰可作為發行所在帳戶中的主要金鑰。

對於公開的應用程式，我們建議使用機密用戶端應用程式方法來存取 Azure 地圖服務 REST API，以便安全地儲存您的密鑰。

Type: apiKey
In: query

SAS Token

這是透過 Azure 管理平面透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 地圖服務資源上的列出 SAS 作業建立的共用存取簽章令牌。

使用此令牌時，任何應用程式都有權使用 Azure 角色型訪問控制進行存取，並更精細地控制到期、速率和區域 (特定令牌的使用) 。換句話說，SAS 令牌可用來允許應用程式以比共用密鑰更安全的方式來控制存取。

對於公開的應用程式，我們建議在地圖帳戶資源上設定允許的來源特定清單，以限制轉譯濫用，並定期更新 SAS 令牌。

Type: apiKey
In: header

範例

List all the previously uploaded data

Sample Request

HTTP

GET https://us.atlas.microsoft.com/mapData?subscription-key=[subscription-key]&api-version=1.0

Sample Response

Status code:: 200

{
  "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"
    }
  ]
}

Status code:: 400

{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}

Status code:: 401

{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}

Status code:: 403

{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}

Status code:: 404

{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}

Status code:: 500

{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

定義

名稱	Description
MapDataDetailInfo	數據的詳細資訊。
MapDataListResponse	數據清單 API 的回應模型。傳回所有先前上傳數據的清單。
ODataError	當 Azure 地圖服務 API 中發生錯誤時，會傳回這個物件。
ODataErrorResponse	當 Azure 地圖服務 API 中發生錯誤時，會傳回這個回應物件。

MapDataDetailInfo

數據的詳細資訊。

名稱	類型	Description
location	string	數據的位置。在此位置上執行 HTTP `GET` 以下載數據。
sizeInBytes	integer	以位元組為單位的內容大小。
udid	string	數據的唯一數據識別碼。
uploadStatus	string	內容的目前上傳狀態。

MapDataListResponse

數據清單 API 的回應模型。傳回所有先前上傳數據的清單。

名稱	類型	Description
mapDataList	MapDataDetailInfo[]	所有先前上傳數據的清單。

ODataError

當 Azure 地圖服務 API 中發生錯誤時，會傳回這個物件。

名稱	類型	Description
code	string	ODataError 程式代碼。
details	ODataError[]	當 Azure 地圖服務 API 中發生錯誤時，會傳回這個物件。
message	string	如果有的話，錯誤的人看得懂的描述。
target	string	如果有的話，造成錯誤的目標。

ODataErrorResponse

當 Azure 地圖服務 API 中發生錯誤時，會傳回這個回應物件。

名稱	類型	Description
error	ODataError	當 Azure 地圖服務 API 中發生錯誤時，會傳回這個物件。

Share via