Tileset - List
用來取得圖格集的清單。
備註
Azure 地圖服務 Creator 淘汰
Azure 地圖服務 Creator 室內地圖服務現在已被取代,且將於 2025/9/30 淘汰。 如需詳細資訊,請參閱 Azure 地圖服務 Creator 的生命周期結束公告。
提交清單要求
List
API 是用來擷取所有現有磚集清單的 HTTP GET
要求。
GET https://{geography}.atlas.microsoft.com/tilesets?api-version=2.0
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
geography
|
path | True |
string |
此參數會指定 Azure 地圖服務建立者資源所在的位置。 有效值為我們和 eu。 |
api-version
|
query | True |
string |
Azure 地圖服務 API 的版本號碼。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
x-ms-client-id |
string |
指定要與 Microsoft Entra ID 安全性模型搭配使用的帳戶。 它代表 Azure 地圖服務帳戶的唯一標識碼,而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。 若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性,請參閱下列 文章 以取得指引。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
清單磚集要求成功完成。 回應本文包含所有磚集的清單。 |
|
Other Status Codes |
發生未預期的錯誤。 |
安全性
AADToken
這些是 Entra OAuth 2.0 流程
若要實作案例,建議您檢視
備註
- 此安全性定義 需要 使用
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 身分識別平臺概觀。
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | 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,以便安全地儲存您的密鑰。
類型:
apiKey
位於:
query
SAS Token
這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 azure 地圖服務資源
使用此令牌時,任何應用程式都有權使用 Azure 角色型訪問控制進行存取,並更精細地控制特定令牌的到期、速率和區域。 換句話說,SAS 令牌可用來讓應用程式以比共用密鑰更安全的方式控制存取。
對於公開的應用程式,我們建議在 對應帳戶資源上設定允許的來源特定清單, 以限制轉譯濫用,並定期更新 SAS 令牌。
類型:
apiKey
位於:
header
範例
Get a list of all tilesets
範例要求
GET https://us.atlas.microsoft.com/tilesets?api-version=2.0
範例回覆
{
"tilesets": [
{
"tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84",
"datasetId": "63b18a6b-ac35-4b23-a1d9-ffa1003ad50b",
"description": "My first tileset",
"minZoom": 16,
"maxZoom": 18,
"bbox": [
-122.13595,
47.636524,
-122.1329,
47.637525
]
},
{
"tilesetId": "b8dca8b3-8aad-4afe-abd6-0efe37b5a2e3",
"datasetId": "c0a01139-662e-4d5a-bf5f-92ea4a292aad",
"description": "My second tileset",
"minZoom": 19,
"maxZoom": 19,
"bbox": [
-122.13595,
47.636524,
-122.1329,
47.637525
]
}
]
}
定義
名稱 | Description |
---|---|
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
Tileset |
數據的詳細資訊。 |
Tileset |
磚集清單 API 的回應模型。 傳回所有圖格集的清單。 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細數據。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |
Tileset
數據的詳細資訊。
名稱 | 類型 | Description |
---|---|---|
bbox |
number[] (double) |
磚集所有功能的周框方塊。 使用的投影 - EPSG:3857。 格式:『minLon、minLat、maxLon、maxLat』。 |
datasetId |
string |
用來建立磚集的唯一數據集標識碼。 |
description |
string |
建立磚集時所提供呼叫端的描述。 長度上限為 1024 個字元。 |
maxZoom |
integer |
為磚集產生的最高磚縮放層級磚。 |
minZoom |
integer |
為磚集產生的最低磚縮放層級磚。 |
ontology |
string |
此數據集的本體版本。 |
tilesetId |
string |
磚集的唯一磚集標識碼。 |
TilesetListResult
磚集清單 API 的回應模型。 傳回所有圖格集的清單。
名稱 | 類型 | Description |
---|---|---|
nextLink |
string |
如果有,則為下一頁數據的位置。 |
tilesets |
Tileset[] |
所有圖格集的清單。 |