共用方式為


Traffic - Get Traffic Incident Tile

用來取得顯示交通事件的 256 x 256 像素磚。

Traffic Incident Tile API 是 HTTP GET 要求,會傳回顯示流量事件的 256 x 256 像素磚。 所有磚都會使用相同的網格線系統。 因為交通圖格使用透明影像,所以可以在地圖底圖頂端分層,以建立復合顯示。 交通圖格會轉譯圖形,以指出指定區域中道路上的交通。

GET https://atlas.microsoft.com/traffic/incident/tile/{format}?api-version=1.0&style={style}&zoom={zoom}&x={x}&y={y}
GET https://atlas.microsoft.com/traffic/incident/tile/{format}?api-version=1.0&style={style}&zoom={zoom}&x={x}&y={y}&t={t}

URI 參數

名稱 位於 必要 類型 Description
format
path True

TileFormat

所需的回應格式。 可能的值為 png & pbf。

api-version
query True

string

Azure 地圖服務 API 的版本號碼。

style
query True

TrafficIncidentTileStyle

用來呈現磚的樣式。 當格式為 pbf 時,此參數無效。

x
query True

integer

int32

縮放方格上磚的 X 座標。 值必須位於 [0, 2zoom -1] 範圍內。

如需詳細資訊,請參閱 縮放層級和磚網格 線。

y
query True

integer

int32

縮放方格上磚的 Y 座標。 值必須位於 [0, 2zoom -1] 範圍內。

如需詳細資訊,請參閱 縮放層級和磚網格 線。

zoom
query True

integer

int32

所需磚的縮放層級。 針對 點陣 圖格,值必須位於範圍:0-22 (內含) 。 對於 向量 磚,值必須位於範圍:0-22 (內含) 。 如需詳細資訊,請參閱 縮放層級和磚網格 線。

t
query

string

特定時間流量狀態的參考值,從 trafficState 欄位中的 Viewport API 呼叫、trafficModelId 屬性取得。 它會每分鐘更新一次,且在逾時前有效 2 分鐘。使用 -1 取得最新的流量資訊。 預設值:最新的流量資訊。

要求標頭

名稱 必要 類型 Description
x-ms-client-id

string

指定哪一個帳戶用於搭配 Microsoft Entra ID 安全性模型使用。 它代表 Azure 地圖服務帳戶的唯一標識碼,而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。 若要在 Azure 地圖服務中使用 Microsoft 專案標識碼安全性,請參閱下列 文章 以取得指引。

回應

名稱 類型 Description
200 OK

object

此物件會從成功的流量事件磚呼叫傳回

Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

標題

Content-Type: string

Other Status Codes

ErrorResponse

發生意外錯誤。

Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

安全性

AADToken

這些是 entra OAuth 2.0 Flow Microsoft 。 與 Azure 角色型存 取控制配對時,可用來控制對 Azure 地圖服務 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 的使用方式允許針對多個使用案例設定應用程式。

類型: 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 入口網站中 建立 Azure 地圖服務帳戶 或使用 PowerShell、CLI、Azure SDK 或 REST API 時所佈建的共用密鑰。

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

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

類型: apiKey
位於: query

SAS Token

這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 Azure 地圖服務資源 上的清單 SAS 作業建立共用存取簽章令牌。

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

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

類型: apiKey
位於: header

範例

Request a tile depicting a traffic incident

範例要求

GET https://atlas.microsoft.com/traffic/incident/tile/png?api-version=1.0&style=night&zoom=10&x=175&y=408

範例回覆

{}

定義

名稱 Description
ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

TileFormat

所需的回應格式。 可能的值為 png & pbf。

TrafficIncidentTileStyle

用來呈現磚的樣式。 當格式為 pbf 時,此參數無效。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細資料。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

TileFormat

所需的回應格式。 可能的值為 png & pbf。

名稱 類型 Description
pbf

string

pbf 格式的向量圖形。 支援縮放層級 0 到 22。

png

string

png 格式的影像。 支援縮放層級 0 到 18。

TrafficIncidentTileStyle

用來呈現磚的樣式。 當格式為 pbf 時,此參數無效。

名稱 類型 Description
night

string

夜間樣式。

s1

string

建立具有彩色形箭號的交通線,指出嚴重性。

s2

string

建立具有特定光暈度的純線。

s3

string

使用某種程度的光暈建立純線,與 s2 樣式不同。