@azure-rest/maps-route package
Antarmuka
BatchRequest |
Jenis ini mewakili isi permintaan untuk layanan Batch. |
BatchRequestItem |
Objek permintaan batch |
BatchResultItemOutput |
Item yang dikembalikan dari API Batch. Perluas dengan properti 'respons'. |
BatchResultOutput |
Objek ini dikembalikan dari panggilan layanan Batch yang berhasil. Perluas dengan properti 'batchItems'. |
BatchResultSummaryOutput |
Ringkasan hasil untuk permintaan batch |
EffectiveSettingOutput |
Parameter atau data efektif yang digunakan saat memanggil Route API ini. |
ErrorDetailOutput |
Detail kesalahan. |
ErrorResponseOutput |
Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.). |
GeoJsonFeature |
Jenis objek |
GeoJsonFeatureCollection |
Jenis objek |
GeoJsonFeatureCollectionData | |
GeoJsonFeatureData | |
GeoJsonGeometryCollection |
Jenis objek |
GeoJsonGeometryCollectionData | |
GeoJsonGeometryParent |
Objek geometri |
GeoJsonLineString |
Jenis geometri |
GeoJsonLineStringData | |
GeoJsonMultiLineString |
Jenis geometri |
GeoJsonMultiLineStringData | |
GeoJsonMultiPoint |
Jenis geometri |
GeoJsonMultiPointData |
Data yang dimuat oleh |
GeoJsonMultiPolygon |
Jenis objek |
GeoJsonMultiPolygonData | |
GeoJsonObjectParent |
Objek |
GeoJsonPoint |
Jenis geometri |
GeoJsonPointData |
Data yang dimuat oleh |
GeoJsonPolygon |
Jenis geometri |
GeoJsonPolygonData | |
GetRouteDirections | |
GetRouteRange | |
LatLongPairOutput |
Lokasi yang diwakili sebagai garis lintang dan bujur. |
MapsRouteClientOptions |
Parameter opsional untuk klien |
RequestRouteDirectionsBatch | |
RequestRouteDirectionsBatchSync | |
RequestRouteMatrix | |
RequestRouteMatrixSync | |
RouteDirectionParameters |
Parameter isi postingan untuk Petunjuk rute. |
RouteDirectionsBatchItemOutput |
Item yang dikembalikan dari panggilan layanan Route Directions Batch. |
RouteDirectionsBatchItemResponseOutput |
Hasil kueri. RouteDirections jika kueri berhasil diselesaikan, ErrorResponse sebaliknya. |
RouteDirectionsBatchResultOutput |
Objek ini dikembalikan dari panggilan layanan Route Directions Batch yang berhasil. |
RouteDirectionsOutput |
Objek ini dikembalikan dari panggilan Petunjuk Arah Rute yang berhasil |
RouteGetRouteDirections200Response |
API Informasi yang dikembalikan mencakup jarak, perkiraan waktu perjalanan, dan representasi geometri rute. Informasi perutean tambahan seperti urutan titik arah yang dioptimalkan atau instruksi giliran demi belokan juga tersedia, tergantung pada opsi yang dipilih. Layanan perutean menyediakan serangkaian parameter untuk deskripsi terperinci tentang model konsumsi khusus kendaraan. Untuk informasi selengkapnya, lihatModel Konsumsi |
RouteGetRouteDirectionsBatch200Response |
API Unduh Hasil Batch AsinkronUntuk mengunduh hasil batch asinkron, Anda akan mengeluarkan permintaan
Berikut adalah urutan operasi yang khas untuk mengunduh hasil batch:
Model Respons BatchKonten data yang dikembalikan mirip untuk permintaan asinkron dan sinkronisasi. Saat mengunduh hasil permintaan batch asinkron, jika batch telah selesai diproses, isi respons berisi respons batch. Respons batch ini berisi komponen
Berikut adalah sampel Respons Batch dengan 1 berhasil
|
RouteGetRouteDirectionsBatch202Headers | |
RouteGetRouteDirectionsBatch202Response |
API Unduh Hasil Batch AsinkronUntuk mengunduh hasil batch asinkron, Anda akan mengeluarkan permintaan
Berikut adalah urutan operasi yang khas untuk mengunduh hasil batch:
Model Respons BatchKonten data yang dikembalikan mirip untuk permintaan asinkron dan sinkronisasi. Saat mengunduh hasil permintaan batch asinkron, jika batch telah selesai diproses, isi respons berisi respons batch. Respons batch ini berisi komponen
Berikut adalah sampel Respons Batch dengan 1 berhasil
|
RouteGetRouteDirectionsDefaultResponse |
API Informasi yang dikembalikan mencakup jarak, perkiraan waktu perjalanan, dan representasi geometri rute. Informasi perutean tambahan seperti urutan titik arah yang dioptimalkan atau instruksi giliran demi belokan juga tersedia, tergantung pada opsi yang dipilih. Layanan perutean menyediakan serangkaian parameter untuk deskripsi terperinci tentang model konsumsi khusus kendaraan. Untuk informasi selengkapnya, lihatModel Konsumsi |
RouteGetRouteDirectionsQueryParam | |
RouteGetRouteDirectionsQueryParamProperties | |
RouteGetRouteDirectionsWithAdditionalParameters200Response |
API Informasi yang dikembalikan mencakup jarak, perkiraan waktu perjalanan, dan representasi geometri rute. Informasi perutean tambahan seperti urutan titik arah yang dioptimalkan atau instruksi giliran demi belokan juga tersedia, tergantung pada opsi yang dipilih. Layanan perutean menyediakan serangkaian parameter untuk deskripsi terperinci tentang Model Konsumsi khusus kendaraan. Silakan periksa Model Konsumsi untuk penjelasan terperinci tentang konsep dan parameter yang terlibat. |
RouteGetRouteDirectionsWithAdditionalParametersBodyParam | |
RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse |
API Informasi yang dikembalikan mencakup jarak, perkiraan waktu perjalanan, dan representasi geometri rute. Informasi perutean tambahan seperti urutan titik arah yang dioptimalkan atau instruksi giliran demi belokan juga tersedia, tergantung pada opsi yang dipilih. Layanan perutean menyediakan serangkaian parameter untuk deskripsi terperinci tentang Model Konsumsi khusus kendaraan. Silakan periksa Model Konsumsi untuk penjelasan terperinci tentang konsep dan parameter yang terlibat. |
RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam | |
RouteGetRouteDirectionsWithAdditionalParametersQueryParam | |
RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties | |
RouteGetRouteMatrix200Response |
API Untuk setiap asal yang diberikan, layanan menghitung biaya perutean dari asal tersebut ke setiap tujuan tertentu. Kumpulan asal dan kumpulan tujuan dapat dianggap sebagai header kolom dan baris tabel dan setiap sel dalam tabel berisi biaya perutean dari asal ke tujuan untuk sel tersebut. Sebagai contoh, katakanlah perusahaan pengiriman makanan memiliki 20 pengemudi dan mereka perlu menemukan pengemudi terdekat untuk mengambil pengiriman dari restoran. Untuk mengatasi kasus penggunaan ini, mereka dapat memanggil Matrix Route API. Untuk setiap rute, waktu dan jarak perjalanan dikembalikan. Anda dapat menggunakan biaya komputasi untuk menentukan rute terperinci mana yang akan dihitung menggunakan ROUTE Directions API. Ukuran maksimum matriks untuk permintaan asinkron 700 dan untuk permintaan sinkronisasi 100 (jumlah asal dikalikan dengan jumlah tujuan). Kirim Permintaan Matriks Rute SinkronJika skenario Anda memerlukan permintaan sinkron dan ukuran maksimum matriks kurang dari atau sama dengan 100, Anda mungkin ingin membuat permintaan sinkron. Ukuran maksimum matriks untuk API ini 100 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan itu, contoh dimensi matriks yang mungkin adalah: 10x10, 6x8, 9x8 (tidak perlu persegi).
Kirim Permintaan Matriks Rute AsinkronAPI Asinkron sesuai untuk memproses volume besar permintaan perutean yang relatif kompleks. Saat Anda membuat permintaan dengan menggunakan permintaan asinkron, secara default layanan mengembalikan kode respons 202 di sepanjang URL pengalihan di bidang Lokasi header respons. URL ini harus diperiksa secara berkala sampai data respons atau informasi kesalahan tersedia. Jika parameter Ukuran maksimum matriks untuk API ini adalah 700 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan tersebut, contoh dimensi matriks yang mungkin adalah: 50x10, 10x10, 28x25. 10x70 (tidak perlu persegi). Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.
Berikut adalah urutan khas operasi asinkron:
Unduh Hasil SinkronisasiSaat Anda membuat permintaan GET untuk Route Matrix Sync API, layanan mengembalikan 200 kode respons untuk permintaan yang berhasil dan array respons. Isi respons akan berisi data dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. Unduh Hasil AsinkronSaat permintaan mengeluarkan respons
URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan
|
RouteGetRouteMatrix202Headers | |
RouteGetRouteMatrix202Response |
API Untuk setiap asal yang diberikan, layanan menghitung biaya perutean dari asal tersebut ke setiap tujuan tertentu. Kumpulan asal dan kumpulan tujuan dapat dianggap sebagai header kolom dan baris tabel dan setiap sel dalam tabel berisi biaya perutean dari asal ke tujuan untuk sel tersebut. Sebagai contoh, katakanlah perusahaan pengiriman makanan memiliki 20 pengemudi dan mereka perlu menemukan pengemudi terdekat untuk mengambil pengiriman dari restoran. Untuk mengatasi kasus penggunaan ini, mereka dapat memanggil Matrix Route API. Untuk setiap rute, waktu dan jarak perjalanan dikembalikan. Anda dapat menggunakan biaya komputasi untuk menentukan rute terperinci mana yang akan dihitung menggunakan ROUTE Directions API. Ukuran maksimum matriks untuk permintaan asinkron 700 dan untuk permintaan sinkronisasi 100 (jumlah asal dikalikan dengan jumlah tujuan). Kirim Permintaan Matriks Rute SinkronJika skenario Anda memerlukan permintaan sinkron dan ukuran maksimum matriks kurang dari atau sama dengan 100, Anda mungkin ingin membuat permintaan sinkron. Ukuran maksimum matriks untuk API ini 100 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan itu, contoh dimensi matriks yang mungkin adalah: 10x10, 6x8, 9x8 (tidak perlu persegi).
Kirim Permintaan Matriks Rute AsinkronAPI Asinkron sesuai untuk memproses volume besar permintaan perutean yang relatif kompleks. Saat Anda membuat permintaan dengan menggunakan permintaan asinkron, secara default layanan mengembalikan kode respons 202 di sepanjang URL pengalihan di bidang Lokasi header respons. URL ini harus diperiksa secara berkala sampai data respons atau informasi kesalahan tersedia. Jika parameter Ukuran maksimum matriks untuk API ini adalah 700 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan tersebut, contoh dimensi matriks yang mungkin adalah: 50x10, 10x10, 28x25. 10x70 (tidak perlu persegi). Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.
Berikut adalah urutan khas operasi asinkron:
Unduh Hasil SinkronisasiSaat Anda membuat permintaan GET untuk Route Matrix Sync API, layanan mengembalikan 200 kode respons untuk permintaan yang berhasil dan array respons. Isi respons akan berisi data dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. Unduh Hasil AsinkronSaat permintaan mengeluarkan respons
URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan
|
RouteGetRouteRange200Response |
API Poligon yang dikembalikan dapat digunakan untuk pemrosesan lebih lanjut seperti Search Inside Geometry untuk mencari POI dalam isochrone yang disediakan. |
RouteGetRouteRangeDefaultResponse |
API Poligon yang dikembalikan dapat digunakan untuk pemrosesan lebih lanjut seperti Search Inside Geometry untuk mencari POI dalam isochrone yang disediakan. |
RouteGetRouteRangeQueryParam | |
RouteGetRouteRangeQueryParamProperties | |
RouteGuidanceOutput |
Berisi elemen terkait panduan. Bidang ini hanya ada ketika panduan diminta dan tersedia. |
RouteInstructionGroupOutput |
Mengelompokkan urutan elemen instruksi yang terkait satu sama lain. Rentang urutan dibatasi dengan firstInstructionIndex dan lastInstructionIndex. Ketika pesan teks yang dapat dibaca manusia diminta untuk panduan (instructionType=text atau tagged), maka instructionGroup memiliki pesan ringkasan yang dikembalikan jika tersedia. |
RouteInstructionOutput |
Sekumpulan atribut yang menjelaskan manuver, misalnya 'Belok kanan', 'Tetap kiri', 'Ambil feri', 'Ambil jalan raya', 'Tiba'. |
RouteLegOutput |
Deskripsi bagian dari rute, terdiri dari daftar titik. Setiap titik arah tambahan yang disediakan dalam permintaan akan menghasilkan kaki tambahan dalam rute yang dikembalikan. |
RouteMatrixOutput |
Objek hasil matriks |
RouteMatrixQuery |
Objek dengan matriks koordinat. |
RouteMatrixResultOutput |
Objek ini dikembalikan dari panggilan Route Matrix yang berhasil. Misalnya, jika 2 asal dan 3 tujuan disediakan, akan ada 2 array dengan masing-masing 3 elemen. Konten setiap elemen bergantung pada opsi yang disediakan dalam kueri. |
RouteMatrixResultResponseOutput |
Objek respons sel saat ini dalam matriks input. |
RouteMatrixSummaryOutput |
Objek ringkasan |
RouteOptimizedWaypointOutput |
Objek titik cara yang dioptimalkan. |
RouteOutput | |
RouteRangeOutput |
Rentang yang Dapat Dijangkau |
RouteRangeResultOutput |
Objek ini dikembalikan dari panggilan Rentang Yang Dapat Dijangkau Rute yang berhasil |
RouteReportOutput |
Melaporkan pengaturan efektif yang digunakan dalam panggilan saat ini. |
RouteRequestRouteDirectionsBatch200Response |
API Kirim Permintaan Batch AsinkronAPI Asinkron sesuai untuk memproses volume besar permintaan rute yang relatif kompleks
Saat Anda membuat permintaan dengan menggunakan permintaan asinkron, secara default layanan mengembalikan kode respons 202 di sepanjang URL pengalihan di bidang Lokasi header respons. URL ini harus diperiksa secara berkala sampai data respons atau informasi kesalahan tersedia. Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa. Harap dicatat bahwa permintaan batch asinkron adalah operasi yang berjalan lama. Berikut adalah urutan operasi yang khas:
Isi POST untuk Permintaan BatchUntuk mengirim petunjuk arah rute kueri, Anda akan menggunakan permintaan
Petunjuk arah rute kueri dalam batch hanyalah URL parsial tanpa protokol, URL dasar, jalur, versi api, dan kunci langganan. Ini dapat menerima salah satu petunjuk arah rute yang didukungparameter URI. Nilai string dalam arah rute kueri harus diloloskan dengan benar (misalnya karakter " harus diloloskan dengan \ ) dan juga harus dikodekan DENGAN URL dengan benar. API asinkron memungkinkan pemanggil untuk mengumpulkan hingga kueri 700 dan MENYinkronkan API hingga 100 kueri, dan batch harus berisi setidaknya 1 kueri. Unduh Hasil Batch AsinkronUntuk mengunduh hasil batch asinkron, Anda akan mengeluarkan permintaan
Berikut adalah urutan operasi yang khas untuk mengunduh hasil batch:
Model Respons BatchKonten data yang dikembalikan mirip untuk permintaan asinkron dan sinkronisasi. Saat mengunduh hasil permintaan batch asinkron, jika batch telah selesai diproses, isi respons berisi respons batch. Respons batch ini berisi komponen
Berikut adalah sampel Respons Batch dengan 1 berhasil
|
RouteRequestRouteDirectionsBatch202Headers | |
RouteRequestRouteDirectionsBatch202Response |
API Kirim Permintaan Batch AsinkronAPI Asinkron sesuai untuk memproses volume besar permintaan rute yang relatif kompleks
Saat Anda membuat permintaan dengan menggunakan permintaan asinkron, secara default layanan mengembalikan kode respons 202 di sepanjang URL pengalihan di bidang Lokasi header respons. URL ini harus diperiksa secara berkala sampai data respons atau informasi kesalahan tersedia. Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa. Harap dicatat bahwa permintaan batch asinkron adalah operasi yang berjalan lama. Berikut adalah urutan operasi yang khas:
Isi POST untuk Permintaan BatchUntuk mengirim petunjuk arah rute kueri, Anda akan menggunakan permintaan
Petunjuk arah rute kueri dalam batch hanyalah URL parsial tanpa protokol, URL dasar, jalur, versi api, dan kunci langganan. Ini dapat menerima salah satu petunjuk arah rute yang didukungparameter URI. Nilai string dalam arah rute kueri harus diloloskan dengan benar (misalnya karakter " harus diloloskan dengan \ ) dan juga harus dikodekan DENGAN URL dengan benar. API asinkron memungkinkan pemanggil untuk mengumpulkan hingga kueri 700 dan MENYinkronkan API hingga 100 kueri, dan batch harus berisi setidaknya 1 kueri. Unduh Hasil Batch AsinkronUntuk mengunduh hasil batch asinkron, Anda akan mengeluarkan permintaan
Berikut adalah urutan operasi yang khas untuk mengunduh hasil batch:
Model Respons BatchKonten data yang dikembalikan mirip untuk permintaan asinkron dan sinkronisasi. Saat mengunduh hasil permintaan batch asinkron, jika batch telah selesai diproses, isi respons berisi respons batch. Respons batch ini berisi komponen
Berikut adalah sampel Respons Batch dengan 1 berhasil
|
RouteRequestRouteDirectionsBatchBodyParam | |
RouteRequestRouteDirectionsBatchMediaTypesParam | |
RouteRequestRouteDirectionsBatchSync200Response |
API Kirim Permintaan Batch SinkronAPI Sinkron direkomendasikan untuk permintaan batch ringan. Ketika layanan menerima permintaan, layanan akan merespons segera setelah item batch dihitung dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. API Sinkron akan mengembalikan kesalahan waktu habis (respons 408) jika permintaan membutuhkan waktu lebih dari 60 detik. Jumlah item batch dibatasi hingga 100 untuk API ini.
Model Respons BatchKonten data yang dikembalikan mirip untuk permintaan asinkron dan sinkronisasi. Saat mengunduh hasil permintaan batch asinkron, jika batch telah selesai diproses, isi respons berisi respons batch. Respons batch ini berisi komponen
Berikut adalah sampel Respons Batch dengan 1 berhasil
|
RouteRequestRouteDirectionsBatchSync408Response |
API Kirim Permintaan Batch SinkronAPI Sinkron direkomendasikan untuk permintaan batch ringan. Ketika layanan menerima permintaan, layanan akan merespons segera setelah item batch dihitung dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. API Sinkron akan mengembalikan kesalahan waktu habis (respons 408) jika permintaan membutuhkan waktu lebih dari 60 detik. Jumlah item batch dibatasi hingga 100 untuk API ini.
Model Respons BatchKonten data yang dikembalikan mirip untuk permintaan asinkron dan sinkronisasi. Saat mengunduh hasil permintaan batch asinkron, jika batch telah selesai diproses, isi respons berisi respons batch. Respons batch ini berisi komponen
Berikut adalah sampel Respons Batch dengan 1 berhasil
|
RouteRequestRouteDirectionsBatchSyncBodyParam | |
RouteRequestRouteDirectionsBatchSyncDefaultResponse |
API Kirim Permintaan Batch SinkronAPI Sinkron direkomendasikan untuk permintaan batch ringan. Ketika layanan menerima permintaan, layanan akan merespons segera setelah item batch dihitung dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. API Sinkron akan mengembalikan kesalahan waktu habis (respons 408) jika permintaan membutuhkan waktu lebih dari 60 detik. Jumlah item batch dibatasi hingga 100 untuk API ini.
Model Respons BatchKonten data yang dikembalikan mirip untuk permintaan asinkron dan sinkronisasi. Saat mengunduh hasil permintaan batch asinkron, jika batch telah selesai diproses, isi respons berisi respons batch. Respons batch ini berisi komponen
Berikut adalah sampel Respons Batch dengan 1 berhasil
|
RouteRequestRouteDirectionsBatchSyncMediaTypesParam | |
RouteRequestRouteMatrix200Response |
API Untuk setiap rute, waktu dan jarak perjalanan dikembalikan. Anda dapat menggunakan biaya komputasi untuk menentukan rute terperinci mana yang akan dihitung menggunakan ROUTE Directions API. Ukuran maksimum matriks untuk permintaan asinkron 700 dan untuk permintaan sinkronisasi 100 (jumlah asal dikalikan dengan jumlah tujuan). Catatan Semua asal dan tujuan harus terkandung dalam kotak pembatas 400 km x 400 km yang selaras dengan sumbu. Jika tidak, beberapa sel matriks akan diselesaikan sebagai OUT_OF_REGION. Kirim Permintaan Matriks Rute SinkronJika skenario Anda memerlukan permintaan sinkron dan ukuran maksimum matriks kurang dari atau sama dengan 100, Anda mungkin ingin membuat permintaan sinkron. Ukuran maksimum matriks untuk API ini 100 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan itu, contoh dimensi matriks yang mungkin adalah: 10x10, 6x8, 9x8 (tidak perlu persegi).
Kirim Permintaan Matriks Rute AsinkronAPI Asinkron sesuai untuk memproses volume besar permintaan perutean yang relatif kompleks. Saat Anda membuat permintaan dengan menggunakan permintaan asinkron, secara default layanan mengembalikan kode respons 202 di sepanjang URL pengalihan di bidang Lokasi header respons. URL ini harus diperiksa secara berkala sampai data respons atau informasi kesalahan tersedia. Jika parameter Ukuran maksimum matriks untuk API ini adalah 700 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan tersebut, contoh dimensi matriks yang mungkin adalah: 50x10, 10x10, 28x25. 10x70 (tidak perlu persegi). Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.
Berikut adalah urutan khas operasi asinkron:
Unduh Hasil SinkronisasiSaat Anda membuat permintaan POST untuk Route Matrix Sync API, layanan mengembalikan 200 kode respons untuk permintaan yang berhasil dan array respons. Isi respons akan berisi data dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. Unduh Hasil AsinkronSaat permintaan mengeluarkan respons
URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan
|
RouteRequestRouteMatrix202Headers | |
RouteRequestRouteMatrix202Response |
API Untuk setiap rute, waktu dan jarak perjalanan dikembalikan. Anda dapat menggunakan biaya komputasi untuk menentukan rute terperinci mana yang akan dihitung menggunakan ROUTE Directions API. Ukuran maksimum matriks untuk permintaan asinkron 700 dan untuk permintaan sinkronisasi 100 (jumlah asal dikalikan dengan jumlah tujuan). Catatan Semua asal dan tujuan harus terkandung dalam kotak pembatas 400 km x 400 km yang selaras dengan sumbu. Jika tidak, beberapa sel matriks akan diselesaikan sebagai OUT_OF_REGION. Kirim Permintaan Matriks Rute SinkronJika skenario Anda memerlukan permintaan sinkron dan ukuran maksimum matriks kurang dari atau sama dengan 100, Anda mungkin ingin membuat permintaan sinkron. Ukuran maksimum matriks untuk API ini 100 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan itu, contoh dimensi matriks yang mungkin adalah: 10x10, 6x8, 9x8 (tidak perlu persegi).
Kirim Permintaan Matriks Rute AsinkronAPI Asinkron sesuai untuk memproses volume besar permintaan perutean yang relatif kompleks. Saat Anda membuat permintaan dengan menggunakan permintaan asinkron, secara default layanan mengembalikan kode respons 202 di sepanjang URL pengalihan di bidang Lokasi header respons. URL ini harus diperiksa secara berkala sampai data respons atau informasi kesalahan tersedia. Jika parameter Ukuran maksimum matriks untuk API ini adalah 700 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan tersebut, contoh dimensi matriks yang mungkin adalah: 50x10, 10x10, 28x25. 10x70 (tidak perlu persegi). Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.
Berikut adalah urutan khas operasi asinkron:
Unduh Hasil SinkronisasiSaat Anda membuat permintaan POST untuk Route Matrix Sync API, layanan mengembalikan 200 kode respons untuk permintaan yang berhasil dan array respons. Isi respons akan berisi data dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. Unduh Hasil AsinkronSaat permintaan mengeluarkan respons
URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan
|
RouteRequestRouteMatrixBodyParam | |
RouteRequestRouteMatrixMediaTypesParam | |
RouteRequestRouteMatrixQueryParam | |
RouteRequestRouteMatrixQueryParamProperties | |
RouteRequestRouteMatrixSync200Response |
API Untuk setiap rute, waktu dan jarak perjalanan dikembalikan. Anda dapat menggunakan biaya komputasi untuk menentukan rute terperinci mana yang akan dihitung menggunakan ROUTE Directions API. Ukuran maksimum matriks untuk permintaan asinkron 700 dan untuk permintaan sinkronisasi 100 (jumlah asal dikalikan dengan jumlah tujuan). Kirim Permintaan Matriks Rute SinkronJika skenario Anda memerlukan permintaan sinkron dan ukuran maksimum matriks kurang dari atau sama dengan 100, Anda mungkin ingin membuat permintaan sinkron. Ukuran maksimum matriks untuk API ini 100 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan itu, contoh dimensi matriks yang mungkin adalah: 10x10, 6x8, 9x8 (tidak perlu persegi).
Kirim Permintaan Matriks Rute AsinkronAPI Asinkron sesuai untuk memproses volume besar permintaan perutean yang relatif kompleks. Saat Anda membuat permintaan dengan menggunakan permintaan asinkron, secara default layanan mengembalikan kode respons 202 di sepanjang URL pengalihan di bidang Lokasi header respons. URL ini harus diperiksa secara berkala sampai data respons atau informasi kesalahan tersedia. Jika parameter Ukuran maksimum matriks untuk API ini adalah 700 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan tersebut, contoh dimensi matriks yang mungkin adalah: 50x10, 10x10, 28x25. 10x70 (tidak perlu persegi). Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.
Berikut adalah urutan khas operasi asinkron:
Unduh Hasil SinkronisasiSaat Anda membuat permintaan POST untuk Route Matrix Sync API, layanan mengembalikan 200 kode respons untuk permintaan yang berhasil dan array respons. Isi respons akan berisi data dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. Unduh Hasil AsinkronSaat permintaan mengeluarkan respons
URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan
|
RouteRequestRouteMatrixSync408Response |
API Untuk setiap rute, waktu dan jarak perjalanan dikembalikan. Anda dapat menggunakan biaya komputasi untuk menentukan rute terperinci mana yang akan dihitung menggunakan ROUTE Directions API. Ukuran maksimum matriks untuk permintaan asinkron 700 dan untuk permintaan sinkronisasi 100 (jumlah asal dikalikan dengan jumlah tujuan). Kirim Permintaan Matriks Rute SinkronJika skenario Anda memerlukan permintaan sinkron dan ukuran maksimum matriks kurang dari atau sama dengan 100, Anda mungkin ingin membuat permintaan sinkron. Ukuran maksimum matriks untuk API ini 100 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan itu, contoh dimensi matriks yang mungkin adalah: 10x10, 6x8, 9x8 (tidak perlu persegi).
Kirim Permintaan Matriks Rute AsinkronAPI Asinkron sesuai untuk memproses volume besar permintaan perutean yang relatif kompleks. Saat Anda membuat permintaan dengan menggunakan permintaan asinkron, secara default layanan mengembalikan kode respons 202 di sepanjang URL pengalihan di bidang Lokasi header respons. URL ini harus diperiksa secara berkala sampai data respons atau informasi kesalahan tersedia. Jika parameter Ukuran maksimum matriks untuk API ini adalah 700 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan tersebut, contoh dimensi matriks yang mungkin adalah: 50x10, 10x10, 28x25. 10x70 (tidak perlu persegi). Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.
Berikut adalah urutan khas operasi asinkron:
Unduh Hasil SinkronisasiSaat Anda membuat permintaan POST untuk Route Matrix Sync API, layanan mengembalikan 200 kode respons untuk permintaan yang berhasil dan array respons. Isi respons akan berisi data dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. Unduh Hasil AsinkronSaat permintaan mengeluarkan respons
URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan
|
RouteRequestRouteMatrixSyncBodyParam | |
RouteRequestRouteMatrixSyncDefaultResponse |
API Untuk setiap rute, waktu dan jarak perjalanan dikembalikan. Anda dapat menggunakan biaya komputasi untuk menentukan rute terperinci mana yang akan dihitung menggunakan ROUTE Directions API. Ukuran maksimum matriks untuk permintaan asinkron 700 dan untuk permintaan sinkronisasi 100 (jumlah asal dikalikan dengan jumlah tujuan). Kirim Permintaan Matriks Rute SinkronJika skenario Anda memerlukan permintaan sinkron dan ukuran maksimum matriks kurang dari atau sama dengan 100, Anda mungkin ingin membuat permintaan sinkron. Ukuran maksimum matriks untuk API ini 100 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan itu, contoh dimensi matriks yang mungkin adalah: 10x10, 6x8, 9x8 (tidak perlu persegi).
Kirim Permintaan Matriks Rute AsinkronAPI Asinkron sesuai untuk memproses volume besar permintaan perutean yang relatif kompleks. Saat Anda membuat permintaan dengan menggunakan permintaan asinkron, secara default layanan mengembalikan kode respons 202 di sepanjang URL pengalihan di bidang Lokasi header respons. URL ini harus diperiksa secara berkala sampai data respons atau informasi kesalahan tersedia. Jika parameter Ukuran maksimum matriks untuk API ini adalah 700 (jumlah asal dikalikan dengan jumlah tujuan). Dengan mengingat batasan tersebut, contoh dimensi matriks yang mungkin adalah: 50x10, 10x10, 28x25. 10x70 (tidak perlu persegi). Respons asinkron disimpan selama 24 jam. URL pengalihan mengembalikan respons 404 jika digunakan setelah periode kedaluwarsa.
Berikut adalah urutan khas operasi asinkron:
Unduh Hasil SinkronisasiSaat Anda membuat permintaan POST untuk Route Matrix Sync API, layanan mengembalikan 200 kode respons untuk permintaan yang berhasil dan array respons. Isi respons akan berisi data dan tidak akan ada kemungkinan untuk mengambil hasilnya nanti. Unduh Hasil AsinkronSaat permintaan mengeluarkan respons
URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan
|
RouteRequestRouteMatrixSyncMediaTypesParam | |
RouteRequestRouteMatrixSyncQueryParam | |
RouteRequestRouteMatrixSyncQueryParamProperties | |
RouteSectionOutput |
Bagian rute berisi informasi tambahan tentang bagian rute. Setiap bagian berisi setidaknya elemen |
RouteSectionTecCauseOutput |
Penyebab peristiwa lalu lintas. Dapat berisi elemen mainCauseCode dan subCauseCode. Dapat digunakan untuk menentukan ikonografi dan deskripsi. |
RouteSectionTecOutput |
Detail peristiwa lalu lintas, menggunakan definisi dalam standar |
RouteSummaryOutput |
Objek ringkasan |
Routes | |
SimplePollerLike |
Poller sederhana yang dapat digunakan untuk melakukan polling operasi jangka panjang. |
Alias Jenis
GeoJsonGeometry |
Objek geometri |
GeoJsonObject |
Objek |
MapsRouteClient | |
RouteGetRouteDirectionsBatchParameters | |
RouteGetRouteDirectionsParameters | |
RouteGetRouteDirectionsWithAdditionalParametersParameters | |
RouteGetRouteMatrixParameters | |
RouteGetRouteRangeParameters | |
RouteRequestRouteDirectionsBatchParameters | |
RouteRequestRouteDirectionsBatchSyncParameters | |
RouteRequestRouteMatrixParameters | |
RouteRequestRouteMatrixSyncParameters |
Fungsi
build |
|
create |
Buat badan permintaan batch dari sekelompok permintaan arah rute. |
default(Azure |
Membuat instans MapsRouteClient dari kunci langganan. Contoh
|
default(Token |
Membuat instans MapsRoute dari Azure Identity Contoh
|
default(Azure |
Membuat instans MapsRoute dari Azure Identity Contoh
|
get |
Fungsi pembantu yang membangun objek Poller untuk membantu polling operasi yang berjalan lama. |
is |
|
is |
|
is |
|
is |
|
is |
|
to |
Ubah array [Lintang, Garis Bujur] menjadi string dalam format berikut: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..." |
Detail Fungsi
buildMultiCollection(string[], string)
function buildMultiCollection(items: string[], parameterName: string): string
Parameter
- items
-
string[]
- parameterName
-
string
Mengembalikan
string
createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])
Buat badan permintaan batch dari sekelompok permintaan arah rute.
function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest
Parameter
- queryParamProperties
Objek parameter kueri untuk permintaan arah rute
Mengembalikan
Permintaan batch yang terdiri.
default(AzureKeyCredential, ClientOptions)
Membuat instans MapsRouteClient dari kunci langganan.
Contoh
import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";
const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);
function default(credential: AzureKeyCredential, options?: ClientOptions): MapsRouteClient
Parameter
- credential
- AzureKeyCredential
Instans AzureKeyCredential yang digunakan untuk mengautentikasi permintaan ke layanan
- options
- ClientOptions
Opsi yang digunakan untuk mengonfigurasi Klien Rute
Mengembalikan
default(TokenCredential, string, ClientOptions)
Membuat instans MapsRoute dari Azure Identity TokenCredential
.
Contoh
import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");
function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRouteClient
Parameter
- credential
- TokenCredential
Instans TokenCredential yang digunakan untuk mengautentikasi permintaan ke layanan
- mapsAccountClientId
-
string
Id klien Azure Maps dari sumber daya peta tertentu
- options
- ClientOptions
Opsi yang digunakan untuk mengonfigurasi Klien Rute
Mengembalikan
default(AzureSASCredential, ClientOptions)
Membuat instans MapsRoute dari Azure Identity AzureSASCredential
.
Contoh
import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";
const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);
function default(credential: AzureSASCredential, options?: ClientOptions): MapsRouteClient
Parameter
- credential
- AzureSASCredential
Instans AzureSASCredential yang digunakan untuk mengautentikasi permintaan ke layanan
- options
- ClientOptions
Opsi yang digunakan untuk mengonfigurasi Klien Rute
Mengembalikan
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Fungsi pembantu yang membangun objek Poller untuk membantu polling operasi yang berjalan lama.
function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameter
- client
- Client
Klien yang digunakan untuk mengirim permintaan untuk mendapatkan halaman tambahan.
- initialResponse
-
TResult
Respons awal.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Opsi untuk mengatur status resume atau interval polling kustom.
Mengembalikan
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- Objek poller untuk polling pembaruan status operasi dan akhirnya mendapatkan respons akhir.
isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
function isUnexpected(response: RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
function isUnexpected(response: RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse): response
Parameter
Mengembalikan
response
toColonDelimitedLatLonString(LatLon[])
Ubah array [Lintang, Garis Bujur] menjadi string dalam format berikut: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."
function toColonDelimitedLatLonString(coordinates: LatLon[]): string
Parameter
- coordinates
-
LatLon[]
Array pasangan Lintang/Bujur untuk diubah.
Mengembalikan
string
String yang diubah.
Azure SDK for JavaScript