WFS - Get Landing Page
使用 來取得有關功能集合的 API 定義、一致性語句和元數據的連結。
Get Landing Page
API 是 HTTP GET
要求,可提供指定數據集中功能集合的相關 API 定義、一致性語句和元數據連結。
WFS API 遵循適用於功能以查詢數據集的開放式地理空間聯盟 API 標準。
數據集是由多個功能集合所組成。 功能集合是以通用架構為基礎的類似類型特徵集合。
提交取得登陸頁面要求
GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/?api-version=2.0
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
dataset
|
path | True |
string |
要從中查詢之數據集的標識碼。 |
geography
|
path | True |
string |
此參數會指定 Azure 地圖服務 Creator 資源所在的位置。 有效值為us和 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
這些是 Microsoft Entra OAuth 2.0 流程。 與 Azure 角色型存取控制配對時,可用來控制對 REST API 的存取 Azure 地圖服務。 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 身分識別平台 概觀。
類型:
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 管理平面透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 Azure 地圖服務 資源上的清單 SAS 作業建立共用存取簽章令牌。
使用此令牌時,任何應用程式都有權使用 Azure 角色型訪問控制進行存取,並精細控制到期、速率和區域 (特定令牌的使用) 。 換句話說,SAS 令牌可用來允許應用程式以比共用密鑰更安全的方式控制存取。
對於公開的應用程式,我們建議在 地圖帳戶資源 上設定允許的來源特定清單,以限制轉譯濫用,並定期更新 SAS 令牌。
類型:
apiKey
位於:
header
範例
GetLandingPage
範例要求
GET https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/?api-version=2.0
範例回覆
{
"ontology": "Facility-2.0",
"links": [
{
"href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4",
"rel": "self",
"title": "Azure Maps WFS"
},
{
"href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/api",
"rel": "service",
"title": "The API definition"
},
{
"href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/conformance",
"rel": "conformance",
"title": "WFS 3.0 conformance classes implemented by this server"
},
{
"href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/version",
"rel": "data",
"title": "The version information"
},
{
"href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections",
"rel": "data",
"title": "Metadata about the feature collections"
}
]
}
定義
名稱 | Description |
---|---|
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
Landing |
|
WFSEndpoint |
其他 WFS 端點的連結 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細資料。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |
LandingPageResult
名稱 | 類型 | Description |
---|---|---|
links |
其他 WFS 端點的連結。 |
|
ontology |
string |
此數據集的本體版本。 |
WFSEndpointLink
其他 WFS 端點的連結
名稱 | 類型 | Description |
---|---|---|
href |
string |
鏈接目標。 |
hreflang |
string |
提示,指出取消參考連結結果的語言為何。 |
rel |
string |
關聯類型。 |
title |
string |
用來為連結的目的地加上標籤,使其可作為人類可讀取的標識碼 (例如,如果存在) ,則以 Content-Language 標頭欄位所指示的語言) 選單項 (。 |
type |
string |
提示,指出取消參考連結結果的媒體類型為何。 |