Data - List Preview

Referensi

Service:: Maps

API Version:: 1.0

Permintaan Daftar memungkinkan penelepon untuk mengambil daftar semua konten yang sebelumnya diunggah menggunakan Pengunggahan Data.
Berlaku untuk: Tingkat harga S1.

API ini memungkinkan pemanggil untuk mengambil daftar semua konten yang diunggah sebelumnya menggunakan API Pengunggahan Data.

Catatan

Azure Maps Penghentian layanan Data

Layanan Azure Maps Data (v1 dan v2) sekarang tidak digunakan lagi dan akan dihentikan pada 16/9/24. Untuk menghindari gangguan layanan, semua panggilan ke layanan Data perlu diperbarui untuk menggunakan layanan Azure Maps Data Registry sebesar 16/9/24. Untuk informasi selengkapnya, lihat Cara membuat registri data.

Kirim Permintaan Daftar

Untuk mencantumkan semua konten data peta, Anda akan mengeluarkan GET permintaan tanpa parameter tambahan.

Respons Data Daftar

API Daftar Data mengembalikan daftar lengkap semua data dalam json format. Respons berisi detail berikut untuk setiap sumber daya data:

udid - Id data unik untuk sumber daya data.

location - Lokasi sumber daya data. Jalankan HTTP GET di lokasi ini untuk mengunduh data.

Berikut adalah respons sampel yang mengembalikan udid dan location dari 3 sumber daya data:

{
    "mapDataList": 
    [
        {
            "udid": "9a1288fa-1858-4a3b-b68d-13a8j5af7d7c",
            "location": "https://atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0",
            "sizeInBytes": 29920,
            "uploadStatus": "Completed"
        },
        {
            "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
            "location": "https://atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
            "sizeInBytes": 1339,
            "uploadStatus": "Completed"
        },
        {
            "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
            "location": "https://atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
            "sizeInBytes": 1650,
            "uploadStatus": "Pending"
        }]
}

GET https://{geography}.atlas.microsoft.com/mapData?api-version=1.0

With optional parameters:

GET https://{geography}.atlas.microsoft.com/mapData?subscription-key={subscription-key}&api-version=1.0

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
geography	path	True	string	Parameter ini menentukan lokasi sumber daya Azure Maps Creator. Nilai yang valid adalah kita dan Uni Eropa.
api-version	query	True	string	Nomor versi API Azure Maps. Versi saat ini adalah 1.0
subscription-key	query		string	Salah satu kunci Azure Maps yang disediakan dari Akun Azure Maps. Silakan lihat artikel ini untuk detail tentang cara mengelola autentikasi.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-id		string	Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan Microsoft Entra ID. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan Microsoft Entra ID di Azure Maps lihat artikel berikut untuk panduan.

Respons

Nama	Jenis	Deskripsi
200 OK	MapDataListResponse	Permintaan data daftar berhasil diselesaikan. Isi respons berisi daftar semua data yang diunggah sebelumnya. Headers Content-Type: string
400 Bad Request	ODataErrorResponse	Permintaan buruk: satu atau beberapa parameter salah ditentukan atau saling eksklusif.
401 Unauthorized	ODataErrorResponse	Akses ditolak karena kunci langganan tidak valid atau token pembawa Microsoft Entra ID tidak valid. Pastikan untuk menyediakan kunci yang valid untuk langganan Azure aktif dan sumber daya Maps. Jika tidak, verifikasi header WWW-Authenticate untuk kode kesalahan dan deskripsi token pembawa Microsoft Entra ID yang disediakan. Headers WWW-Authenticate: string
403 Forbidden	ODataErrorResponse	Masalah izin, kapasitas, atau autentikasi.
404 Not Found	ODataErrorResponse	Tidak Ditemukan: sumber daya yang diminta tidak dapat ditemukan, tetapi mungkin tersedia lagi di masa mendatang.
500 Internal Server Error	ODataErrorResponse	Terjadi kesalahan saat memproses permintaan ini. Coba lagi nanti.

Keamanan

AADToken

Ini adalah alur OAuth 2.0 Microsoft Entra. Saat dipasangkan dengan kontrol akses berbasis peran Azure, kontrol akses tersebut dapat digunakan untuk mengontrol akses ke Azure Maps REST API. 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 untuk Azure Maps REST API.

Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk pemodelan 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 Microsoft Entra ID. * Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API. * Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.

Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat gambaran umum platform identitas Microsoft.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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 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 diterbitkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses Azure Maps REST API sehingga kunci Anda dapat disimpan dengan aman.

Type: apiKey
In: 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 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 fine-grain ke kedaluwarsa, tarif, 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 spesifik asal yang diizinkan pada sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.

Type: apiKey
In: header

Contoh

List all the previously uploaded data

Sample Request

HTTP

GET https://us.atlas.microsoft.com/mapData?subscription-key=[subscription-key]&api-version=1.0

Sample Response

Status code:: 200

{
  "mapDataList": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "location": "https://atlas.microsoft.com/mapData/f6495f62-94f8-0ec2-c252-45626f82fcb2?api-version=1.0",
      "sizeInBytes": 29920,
      "uploadStatus": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "location": "https://atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
      "sizeInBytes": 1339,
      "uploadStatus": "Completed"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "location": "https://atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
      "sizeInBytes": 1650,
      "uploadStatus": "Pending"
    }
  ]
}

Status code:: 400

{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}

Status code:: 401

{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}

Status code:: 403

{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}

Status code:: 404

{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}

Status code:: 500

{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Definisi

Nama	Deskripsi
MapDataDetailInfo	Informasi detail untuk data.
MapDataListResponse	Model respons untuk API Daftar Data. Mengembalikan daftar semua data yang diunggah sebelumnya.
ODataError	Objek ini dikembalikan ketika terjadi kesalahan di API Azure Maps.
ODataErrorResponse	Objek respons ini dikembalikan ketika kesalahan terjadi di API Azure Maps.

MapDataDetailInfo

Informasi detail untuk data.

Nama	Jenis	Deskripsi
location	string	Lokasi data. Jalankan HTTP `GET` di lokasi ini untuk mengunduh data.
sizeInBytes	integer	Ukuran konten dalam byte.
udid	string	Id data unik untuk data.
uploadStatus	string	Status unggahan konten saat ini.

MapDataListResponse

Model respons untuk API Daftar Data. Mengembalikan daftar semua data yang diunggah sebelumnya.

Nama	Jenis	Deskripsi
mapDataList	MapDataDetailInfo[]	Daftar semua data yang diunggah sebelumnya.

ODataError

Objek ini dikembalikan ketika terjadi kesalahan di API Azure Maps.

Nama	Jenis	Deskripsi
code	string	Kode ODataError.
details	ODataError[]	Objek ini dikembalikan ketika terjadi kesalahan di API Azure Maps.
message	string	Jika tersedia, deskripsi kesalahan yang dapat dibaca manusia.
target	string	Jika tersedia, target menyebabkan kesalahan.

ODataErrorResponse

Objek respons ini dikembalikan ketika kesalahan terjadi di API Azure Maps.

Nama	Jenis	Deskripsi
error	ODataError	Objek ini dikembalikan ketika terjadi kesalahan di API Azure Maps.

Share via

Data - List Preview

Kirim Permintaan Daftar

Respons Data Daftar

Parameter URI

Header Permintaan

Respons

Keamanan

AADToken

Catatan

Scopes

subscription-key

SAS Token

Contoh

List all the previously uploaded data

Sample Request

Sample Response

Definisi

MapDataDetailInfo

MapDataListResponse

ODataError

ODataErrorResponse

Sumber Daya Tambahan: