Data - List

Referensi

Service:: Maps

API Version:: 2.0

Gunakan untuk mengambil daftar semua konten yang sebelumnya diunggah menggunakan Unggahan 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.

Data List API adalah permintaan HTTP GET yang memungkinkan pemanggil untuk mengambil daftar semua konten yang sebelumnya diunggah menggunakan API Pengunggahan 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 permintaan 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://us.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://us.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://us.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=2.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.

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	MapDataListResult	Permintaan data daftar berhasil diselesaikan. Isi respons berisi daftar semua data yang diunggah sebelumnya.
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga.

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 Azure Maps akun sumber daya atau sub-sumber daya. 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 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 diminta 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 Create 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 dikeluarkan.

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

Type: apiKey
In: header

Contoh

List all the previously uploaded data

Sample Request

HTTP

GET https://us.atlas.microsoft.com/mapData?api-version=2.0

Sample Response

Status code:: 200

{
  "mapDataList": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "location": "https://us.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://us.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://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
      "sizeInBytes": 1650,
      "uploadStatus": "Pending"
    }
  ]
}

Definisi

Nama	Deskripsi
DataFormat	Format data konten yang diunggah.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
MapData	Informasi detail untuk data.
MapDataListResult	Model respons untuk API Daftar Data. Mengembalikan daftar semua data yang diunggah sebelumnya.
UploadStatus	Status unggahan konten saat ini.

DataFormat

Format data konten yang diunggah.

Nama	Jenis	Deskripsi
dwgzippackage	string	Paket ZIP yang berisi file DWG.
geojson	string	GeoJSON adalah format pertukaran data geospasial berbasis JSON.
zip	string	Format data terkompresi.

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	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

MapData

Informasi detail untuk data.

Nama	Jenis	Deskripsi
dataFormat	DataFormat	Format data konten yang diunggah.
description	string	Deskripsi saat ini.
location	string	Lokasi data. Jalankan permintaan HTTP `GET` di lokasi ini untuk mengunduh data.
sizeInBytes	integer	Ukuran konten dalam byte.
udid	string	Id data unik untuk data.
uploadStatus	UploadStatus	Status unggahan konten saat ini.

MapDataListResult

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

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

UploadStatus

Status unggahan konten saat ini.

Nama	Jenis	Deskripsi
Completed	string	Validasi dan pemrosesan unggahan selesai
Failed	string	Validasi unggah dan/atau kegagalan pemrosesan
Pending	string	Pengunggahan sedang diproses

Share via

Data - List

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

DataFormat

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

MapData

MapDataListResult

UploadStatus

Sumber Daya Tambahan: