Bagikan melalui

Data Registry - Get Operation

  • Referensi
Layanan:
Maps
Versi API:
2023-06-01

Gunakan untuk memeriksa status pendaftaran data atau mengganti permintaan.
Get Operation API adalah permintaan HTTP GET yang digunakan untuk mendapatkan status pendaftaran data atau permintaan penggantian dikembalikan di header register atau mengganti respons sebagai nilai Operation-Location kunci. Saat sedang berlangsung, respons HTTP 200 OK akan dikembalikan dengan Retry-After header - diikuti oleh HTTP 200 OK tanpa header tambahan setelah selesai.

Titik akhir layanan registri data dibatasi dalam cakupan ke wilayah akun Azure Maps Anda dan tidak tersedia untuk akun Azure Maps global.

GET https://{geography}.atlas.microsoft.com/dataRegistries/operations/{operationId}?api-version=2023-06-01

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
geography
 path True

string

Parameter ini menentukan tempat Akun Azure Maps berada. Nilai yang valid adalah kita (US Timur, US Tengah Barat, AS Barat 2) dan Eropa (Eropa Utara, Eropa Barat).
operationId
 path True

string

ID yang digunakan untuk mengkueri status permintaan pendaftaran data.

Pola regex: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
api-version
 query True

string

Nomor versi Azure Maps API.

Respons

Nama Jenis Deskripsi
200 OK

LongRunningOperationResult

Status operasi jangka panjang.

Header

Retry-After: integer
Other Status Codes

MapsErrorResponse

Terjadi kesalahan tak terduga.

Header

x-ms-error-code: string

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 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 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 berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.

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 membuat sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Microsoft Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan kunci ini, aplikasi apa pun berwenang untuk mengakses semua REST API. Dengan kata lain, ini saat ini dapat diperlakukan sebagai kunci master ke akun tempat kunci tersebut dikeluarkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan akses server-ke-server dari REST API Azure Maps tempat kunci ini dapat disimpan dengan aman.

Jenis: apiKey
Dalam: header

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

Jenis: apiKey
Dalam: header

Contoh

Get the status of an operation that failed
Get the status of an operation that finished successfully
Get the status of an operation that is still running

Get the status of an operation that failed

Permintaan sampel

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Respon sampel

Kode status:
200 
{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Failed",
  "error": {
    "code": "InvalidData",
    "message": "The data is not a valid GeoJSON."
  }
}

Get the status of an operation that finished successfully

Permintaan sampel

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Respon sampel

Kode status:
200 
{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Completed"
}

Get the status of an operation that is still running

Permintaan sampel

GET https://us.atlas.microsoft.com/dataRegistries/operations/0522b4fe-0539-4c6c-ba70-e35ec865d8e2?api-version=2023-06-01

Respon sampel

Kode status:
200 
Retry-After: 10
{
  "id": "0522b4fe-0539-4c6c-ba70-e35ec865d8e2",
  "status": "Running"
}

Definisi

Nama Deskripsi
LongRunningOperationResult

Model respons untuk operasi jangka panjang.
LongRunningOperationStatus

Status operasi yang berjalan lama.
MapsErrorDetail

Detail kesalahan.
MapsErrorResponse

Respons kesalahan umum untuk API Azure Maps untuk mengembalikan detail kesalahan untuk operasi yang gagal.
MapsInnerError

Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.

LongRunningOperationResult

Model respons untuk operasi jangka panjang.

Nama Jenis Deskripsi
error

MapsErrorDetail

Detail kesalahan.
id

string

OperationId
status

LongRunningOperationStatus

Status operasi yang berjalan lama.

LongRunningOperationStatus

Status operasi yang berjalan lama.

Nama Jenis Deskripsi
Completed

string

Permintaan berhasil diselesaikan.
Failed

string

Permintaan memiliki satu atau beberapa kegagalan.
Running

string

Permintaan saat ini sedang diproses.

MapsErrorDetail

Detail kesalahan.

Nama Jenis Deskripsi
code

string

Salah satu set kode kesalahan yang ditentukan server.
details

MapsErrorDetail[]

Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror

MapsInnerError

Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message

string

Representasi kesalahan yang dapat dibaca manusia.
target

string

Target kesalahan.

MapsErrorResponse

Respons kesalahan umum untuk API Azure Maps untuk mengembalikan detail kesalahan untuk operasi yang gagal.

Nama Jenis Deskripsi
error

MapsErrorDetail

Detail kesalahan.

MapsInnerError

Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.

Nama Jenis Deskripsi
code

string

Kode kesalahan.
innererror

MapsInnerError

Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.