Traffic - Get Traffic Flow Segment
Gunakan untuk mendapatkan informasi tentang kecepatan dan waktu perjalanan dari bagian jalan yang ditentukan.
Traffic Flow Segment
API adalah permintaan HTTP GET
yang memberikan informasi tentang kecepatan dan waktu perjalanan fragmen jalan yang paling dekat dengan koordinat yang diberikan. Ini dirancang untuk bekerja bersama lapisan Alur Layanan Render untuk mendukung visualisasi data aliran yang dapat diklik.
Traffic Flow Segment
Dengan API, sisi klien dapat menghubungkan tempat apa pun di peta dengan data aliran di jalan terdekat dan menyajikannya kepada pengguna.
GET https://atlas.microsoft.com/traffic/flow/segment/{format}?api-version=1.0&style={style}&zoom={zoom}&query={query}
GET https://atlas.microsoft.com/traffic/flow/segment/{format}?api-version=1.0&style={style}&zoom={zoom}&query={query}&unit={unit}&thickness={thickness}&openLr={openLr}
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
format
|
path | True |
Format respons yang diinginkan. Nilai dapat berupa json atau xml. |
|
api-version
|
query | True |
string |
Nomor versi API Azure Maps. |
query
|
query | True |
number[] |
Koordinat titik yang dekat dengan segmen jalan. Parameter ini adalah daftar empat koordinat, yang berisi dua pasangan koordinat (lat, long, lat, long), dan dihitung menggunakan proyeksi EPSG4326. Ketika titik akhir ini dipanggil secara langsung, koordinat diteruskan sebagai string tunggal yang berisi empat koordinat, dipisahkan oleh koma. |
style
|
query | True |
Gaya yang akan digunakan untuk merender petak peta. Nilai yang valid adalah absolut yang mengembalikan warna yang mencerminkan kecepatan absolut yang diukur, relatif yang mengembalikan kecepatan relatif terhadap aliran bebas, Penundaan relatif yang hanya menampilkan kecepatan relatif di mana mereka berbeda dari kecepatan aliran bebas |
|
zoom
|
query | True |
integer int32 |
Tingkat perbesar tampilan untuk petak peta yang diinginkan. Nilai zoom harus dalam rentang: 0-22 (inklusif). Silakan lihat Tingkat Pembesaran Tampilan dan Kisi Petak untuk detailnya. |
open
|
query |
boolean |
Boolean tentang apakah respons harus menyertakan kode OpenLR |
|
thickness
|
query |
integer int32 |
Nilai lebar garis yang mewakili lalu lintas. Nilai ini adalah pengali dan nilai yang diterima berkisar antara 1 - 20. Nilai defaultnya adalah 10. |
|
unit
|
query |
Satuan kecepatan dalam KMPH atau MPH |
Header Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
x-ms-client-id |
string |
Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan ID Microsoft Entra. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan ID Microsoft Entra di Azure Maps, lihat artikel berikut ini untuk panduan. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Terjadi kesalahan tak terduga. |
Keamanan
AADToken
Ini adalah Alur Microsoft Entra OAuth 2.0 . Saat dipasangkan dengan kontrol akses berbasis peran Azure , kontrol akses tersebut dapat digunakan untuk mengontrol akses ke REST API Azure Maps. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa akun sumber daya atau sub-sumber daya Azure Maps. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin ke REST API Azure Maps.
Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk memodelkan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.
Catatan
- Definisi keamanan ini memerlukan penggunaan
x-ms-client-id
header untuk menunjukkan sumber daya Azure Maps mana yang meminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps .
Authorization URL
khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi ID Microsoft Entra.
* Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Microsoft Azure, PowerShell, CLI, Azure SDK, atau REST API.
* Penggunaan Azure Maps Web SDK memungkinkan penyiapan aplikasi berbasis konfigurasi untuk beberapa kasus penggunaan.
- Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat Gambaran umum platform identitas Microsoft.
Jenis:
oauth2
Alur:
implicit
URL Otorisasi:
https://login.microsoftonline.com/common/oauth2/authorize
Cakupan
Nama | Deskripsi |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Ini adalah kunci bersama yang disediakan saat Anda Membuat akun Azure Maps di portal Microsoft Azure atau menggunakan PowerShell, CLI, Azure SDK, atau REST API.
Dengan kunci ini, aplikasi apa pun dapat mengakses semua REST API. Dengan kata lain, kunci ini dapat digunakan sebagai kunci master di akun tempat kunci tersebut dikeluarkan.
Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses REST API Azure Maps sehingga kunci Anda dapat disimpan dengan aman.
Jenis:
apiKey
Dalam:
query
SAS Token
Ini adalah token tanda tangan akses bersama dibuat dari operasi Daftar SAS pada sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Microsoft Azure, PowerShell, CLI, Azure SDK, atau REST API.
Dengan token ini, aplikasi apa pun berwenang untuk mengakses dengan kontrol akses berbasis peran Azure dan kontrol halus ke kedaluwarsa, laju, dan wilayah penggunaan untuk token tertentu. Dengan kata lain, Token SAS dapat digunakan untuk memungkinkan aplikasi mengontrol akses dengan cara yang lebih aman daripada kunci bersama.
Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah mengonfigurasi daftar asal tertentu yang diizinkan di sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.
Jenis:
apiKey
Dalam:
header
Contoh
Request traffic flow segment information
Permintaan sampel
GET https://atlas.microsoft.com/traffic/flow/segment/json?api-version=1.0&style=absolute&zoom=10&query=52.41072,4.84239
Respon sampel
{
"flowSegmentData": {
"frc": "FRC3",
"currentSpeed": 79,
"freeFlowSpeed": 79,
"currentTravelTime": 33,
"freeFlowTravelTime": 33,
"confidence": 0.5,
"coordinates": {
"coordinate": [
{
"latitude": 52.404648,
"longitude": 4.8442388
},
{
"latitude": 52.408447,
"longitude": 4.8357286
}
]
},
"openlr": null,
"@version": "1.0.53-mascoma"
}
}
Definisi
Nama | Deskripsi |
---|---|
Coordinates |
Termasuk koordinat yang menjelaskan bentuk segmen. Koordinat digeser dari jalan tergantung pada tingkat zoom untuk mendukung visualisasi berkualitas tinggi di setiap skala. |
Error |
Info tambahan kesalahan manajemen sumber daya. |
Error |
Detail kesalahan. |
Error |
Respons kesalahan |
Flow |
Properti Data Segmen Alur |
Lat |
Lokasi yang direpresentasikan sebagai garis lintang dan bujur. |
Response |
Format respons yang diinginkan. Nilai dapat berupa json atau xml. |
Speed |
Satuan kecepatan dalam KMPH atau MPH |
Traffic |
Objek ini dikembalikan dari panggilan Segmen Alur Lalu Lintas yang berhasil |
Traffic |
Gaya yang akan digunakan untuk merender petak peta. Nilai yang valid adalah absolut yang mengembalikan warna yang mencerminkan kecepatan absolut yang diukur, relatif yang mengembalikan kecepatan relatif terhadap aliran bebas, Penundaan relatif yang hanya menampilkan kecepatan relatif di mana mereka berbeda dari kecepatan aliran bebas |
Coordinates
Termasuk koordinat yang menjelaskan bentuk segmen. Koordinat digeser dari jalan tergantung pada tingkat zoom untuk mendukung visualisasi berkualitas tinggi di setiap skala.
Nama | Jenis | Deskripsi |
---|---|---|
coordinate |
Array koordinat |
ErrorAdditionalInfo
Info tambahan kesalahan manajemen sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
info |
object |
Info tambahan. |
type |
string |
Jenis info tambahan. |
ErrorDetail
Detail kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
additionalInfo |
Info tambahan kesalahan. |
|
code |
string |
Kode kesalahan. |
details |
Detail kesalahan. |
|
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
ErrorResponse
Respons kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
error |
Objek kesalahan. |
FlowSegmentData
Properti Data Segmen Alur
Nama | Jenis | Deskripsi |
---|---|---|
@version |
string |
Ini menunjukkan versi perangkat lunak yang menghasilkan respons. |
confidence |
number |
Keyakinan adalah ukuran kualitas waktu dan kecepatan perjalanan yang disediakan. Nilai 1 berarti keyakinan penuh, bahwa respons berisi data berkualitas tinggi. Nilai yang lebih rendah menunjukkan tingkat respons dapat bervariasi dari kondisi aktual di jalan. Nilai apa pun yang lebih besar dari 0,6 berarti informasi didasarkan pada input pemeriksaan real time. Nilai 0,5 berarti kecepatan yang dilaporkan didasarkan pada info historis. Nilai antara 0,5 dan 0,6 memiliki rata-rata tertimbang terhitung antara kecepatan historis dan langsung. |
coordinates |
Termasuk koordinat yang menjelaskan bentuk segmen. Koordinat digeser dari jalan tergantung pada tingkat zoom untuk mendukung visualisasi berkualitas tinggi di setiap skala. |
|
currentSpeed |
integer |
Kecepatan rata-rata saat ini pada titik yang dipilih, dalam unit yang diminta. Ini dihitung dari currentTravelTime dan panjang segmen yang dipilih. |
currentTravelTime |
integer |
Waktu perjalanan saat ini dalam hitungan detik, di seluruh segmen lalu lintas ini, berdasarkan pengukuran real-time yang menyatu antara lokasi yang ditentukan ke arah yang ditentukan. |
frc |
string |
Kelas Jalan Fungsional. Ini menunjukkan jenis jalan: 0: Jalan raya, jalan bebas hambatan, atau jalan utama lainnya. 1: Jalan utama, kurang penting daripada jalan raya. 2: Jalan utama lainnya. 3: Jalan sekunder. 4: Jalan penghubung lokal. 5: Jalan lokal yang sangat penting. 6: Jalan lokal. |
freeFlowSpeed |
integer |
Kecepatan aliran bebas yang diharapkan dalam kondisi ideal, dinyatakan dalam unit yang diminta. Ini terkait dengan freeFlowTravelTime. |
freeFlowTravelTime |
integer |
Waktu perjalanan dalam hitung detik, di seluruh segmen lalu lintas ini, yang akan diharapkan dalam kondisi arus bebas yang ideal. |
openlr |
string |
Kode OpenLR untuk segmen. Lihat OpenLR untuk informasi selengkapnya tentang penggunaan kode Open LR. |
LatLongPair
Lokasi yang direpresentasikan sebagai garis lintang dan bujur.
Nama | Jenis | Deskripsi |
---|---|---|
latitude |
number |
Properti garis lintang |
longitude |
number |
Properti garis bujur |
ResponseFormat
Format respons yang diinginkan. Nilai dapat berupa json atau xml.
Nama | Jenis | Deskripsi |
---|---|---|
json |
string |
|
xml |
string |
SpeedUnit
Satuan kecepatan dalam KMPH atau MPH
Nama | Jenis | Deskripsi |
---|---|---|
KMPH |
string |
Kilometer Per Jam |
MPH |
string |
Mil Per Jam |
TrafficFlowSegmentData
Objek ini dikembalikan dari panggilan Segmen Alur Lalu Lintas yang berhasil
Nama | Jenis | Deskripsi |
---|---|---|
flowSegmentData |
Properti Data Segmen Alur |
TrafficFlowSegmentStyle
Gaya yang akan digunakan untuk merender petak peta. Nilai yang valid adalah absolut yang mengembalikan warna yang mencerminkan kecepatan absolut yang diukur, relatif yang mengembalikan kecepatan relatif terhadap aliran bebas, Penundaan relatif yang hanya menampilkan kecepatan relatif di mana mereka berbeda dari kecepatan aliran bebas
Nama | Jenis | Deskripsi |
---|---|---|
absolute |
string |
|
relative |
string |
|
relative-delay |
string |