RequestRouteMatrixSync interface

Paket:
@azure-rest/maps-route

Metode

post(RouteRequestRouteMatrixSyncParameters)

API Post Route Matrix Sync adalah permintaan http POST yang memungkinkan perhitungan matriks ringkasan rute untuk serangkaian rute yang ditentukan oleh lokasi asal dan tujuan dengan menggunakan satu permintaan sinkron (sinkronisasi). Untuk membuat permintaan asinkron (asinkron), lihat Post Route Matrix. 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 Sinkron

Jika 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).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Kirim Permintaan Matriks Rute Asinkron

API 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 waitForResults dalam permintaan diatur ke true, pengguna akan mendapatkan respons 200 jika permintaan selesai di bawah 120 detik.

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.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Berikut adalah urutan khas operasi asinkron:

  1. Klien mengirim permintaan Route Matrix POST ke Azure Maps

  2. Server akan merespons dengan salah satu hal berikut:

    HTTP 202 Accepted - Permintaan Route Matrix telah diterima.

    HTTP Error - Terjadi kesalahan saat memproses permintaan Route Matrix Anda. Ini bisa menjadi 400 Permintaan Buruk atau kode status Kesalahan lainnya.

  3. Jika permintaan Rute Matriks berhasil diterima, header Lokasi dalam respons berisi URL untuk mengunduh hasil permintaan. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klien mengeluarkan permintaan GET pada URL unduhan yang diperoleh di Langkah 3 untuk mengunduh hasilnya

Unduh Hasil Sinkronisasi

Saat 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 Asinkron

Saat permintaan mengeluarkan respons 202 Accepted, permintaan sedang diproses menggunakan alur asinkron kami. Anda akan diberi URL untuk memeriksa kemajuan permintaan asinkron Anda di header lokasi respons. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan GET dikeluarkan.

HTTP 202 Accepted - Permintaan Matriks diterima tetapi masih diproses. Silakan coba lagi dalam beberapa waktu.

HTTP 200 OK - Permintaan matriks berhasil diproses. Isi respons berisi semua hasilnya.

Detail Metode

post(RouteRequestRouteMatrixSyncParameters)

API Post Route Matrix Sync adalah permintaan http POST yang memungkinkan perhitungan matriks ringkasan rute untuk serangkaian rute yang ditentukan oleh lokasi asal dan tujuan dengan menggunakan satu permintaan sinkron (sinkronisasi). Untuk membuat permintaan asinkron (asinkron), lihat Post Route Matrix. 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 Sinkron

Jika 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).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Kirim Permintaan Matriks Rute Asinkron

API 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 waitForResults dalam permintaan diatur ke true, pengguna akan mendapatkan respons 200 jika permintaan selesai di bawah 120 detik.

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.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Berikut adalah urutan khas operasi asinkron:

  1. Klien mengirim permintaan Route Matrix POST ke Azure Maps

  2. Server akan merespons dengan salah satu hal berikut:

    HTTP 202 Accepted - Permintaan Route Matrix telah diterima.

    HTTP Error - Terjadi kesalahan saat memproses permintaan Route Matrix Anda. Ini bisa menjadi 400 Permintaan Buruk atau kode status Kesalahan lainnya.

  3. Jika permintaan Rute Matriks berhasil diterima, header Lokasi dalam respons berisi URL untuk mengunduh hasil permintaan. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klien mengeluarkan permintaan GET pada URL unduhan yang diperoleh di Langkah 3 untuk mengunduh hasilnya

Unduh Hasil Sinkronisasi

Saat 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 Asinkron

Saat permintaan mengeluarkan respons 202 Accepted, permintaan sedang diproses menggunakan alur asinkron kami. Anda akan diberi URL untuk memeriksa kemajuan permintaan asinkron Anda di header lokasi respons. URI status ini terlihat seperti berikut ini:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

URL yang disediakan oleh header lokasi akan mengembalikan respons berikut saat permintaan GET dikeluarkan.

HTTP 202 Accepted - Permintaan Matriks diterima tetapi masih diproses. Silakan coba lagi dalam beberapa waktu.

HTTP 200 OK - Permintaan matriks berhasil diproses. Isi respons berisi semua hasilnya.

function post(options: RouteRequestRouteMatrixSyncParameters): StreamableMethod<RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse>

Parameter

options
RouteRequestRouteMatrixSyncParameters

Mengembalikan

StreamableMethod<RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse>