Share via

IoT Hub REST

  • Artikel

REST API untuk IoT Hub menawarkan akses terprogram ke perangkat, pesan, dan layanan pekerjaan, serta penyedia sumber daya, di IoT Hub. Anda dapat mengakses layanan olahpesan dari dalam layanan IoT yang berjalan di Azure, atau langsung melalui Internet dari aplikasi apa pun yang dapat mengirim permintaan HTTPS dan menerima respons HTTPS.

Layanan

  • Gunakan API ini untuk mengelola perangkat kembar IoT Hub. Anda dapat mengambil dan memperbarui properti kembar perangkat dan memanggil metode langsung di perangkat.
  • Gunakan API ini untuk mengelola identitas perangkat dalam registri identitas hub IoT.
  • Gunakan API ini untuk mengelola Pekerjaan di IoT Hub. Anda dapat menjadwalkan, membatalkan, atau mendapatkan pekerjaan.

Semua operasi tugas sesuai dengan spesifikasi protokol HTTP/1.1 dan setiap operasi mengembalikan x-ms-request-id header yang dapat digunakan untuk mendapatkan informasi tentang permintaan. Anda harus memastikan bahwa permintaan yang dibuat ke sumber daya ini aman. Untuk informasi selengkapnya, lihat IoT Hub Panduan Pengembang – Keamanan untuk informasi spesifik tentang cara membuat token keamanan.

Olahpesan Perangkat

Gunakan API ini dari perangkat untuk mengirim pesan perangkat ke cloud ke hub IoT, dan menerima pesan cloud-ke-perangkat dari hub IoT. Semua operasi tugas sesuai dengan spesifikasi protokol HTTP/1.1. Anda harus memastikan bahwa permintaan yang dibuat ke sumber daya ini aman. Untuk informasi selengkapnya, lihat Panduan Pengembang IoT Hub - Keamanan untuk informasi spesifik tentang cara membuat token keamanan.

Penyedia Sumber Daya

Gunakan API ini untuk mengelola penyebaran sumber daya IoT Hub Anda. Untuk informasi tentang cara mengamankan permintaan ini, lihat Referensi Azure REST API.

Parameter dan header umum

Informasi berikut ini umum untuk semua tugas yang terkait dengan IoT Hub:

  • Ganti {api-version} dengan "2018-06-30" di URI.

  • Ganti {subscription-id} dengan pengidentifikasi langganan Anda di URI.

  • Ganti {resourceGroupName} dengan nama grup sumber daya yang berisi (atau akan berisi) hub IoT Anda.

  • Ganti {IoTHubName} dengan nama hub IoT Anda.

  • Atur header Jenis-Konten ke aplikasi/json.

  • Atur header Otorisasi ke token SAS yang dibuat seperti yang ditentukan di bagian token keamanandari Menggunakan token keamanan IoT Hub.

  • Header Etag dikembalikan dalam semua permintaan yang terlingkup ke satu identitas perangkat, sesuai RFC7232.

  • Semua operasi PUT/PATCH memerlukan header berikut untuk ditentukan: If-Match = [*|<etag from get>]

  • Operasi DELETE dapat mencakup header berikut: If-Match = [*|<etag from get>]

Perilaku untuk ETag dapat dilihat di bawah ini:

PUT Sumber daya tidak ada Sumber daya ada
If-Match = "" / absen 201 Dibuat 200 OK
If-Match = "*" Prasyarat 412 Gagal 200 OK
If-Match = "xyz" Prasyarat 412 Gagal 200 OK / 412 Prasyarat Gagal
If-None-Match = "*" 201 Dibuat Prasyarat 412 Gagal
DELETE Sumber daya tidak ada Sumber daya ada
If-Match = "" / absen 204 Tidak Ada Konten 200 OK
If-Match = "*" 204 Tidak Ada Konten 200 OK
If-Match = "xyz" 204 Tidak Ada Konten 200 OK / 412 Prasyarat Gagal

Untuk panggilan asinkron:

  • PUT merespons dengan 201 Dibuat dengan header Azure-AsyncOperation untuk setiap operasi yang asinkron. Semua operasi sinkron (pembaruan) mengembalikan 200 OK.

  • DELETE mengembalikan header 202 Diterima dengan Lokasi dan Retry-After serta header Azure-AsyncOperation untuk sumber daya yang ada.

  • Header lokasi berisi URL untuk hasil operasi

  • header Retry-After berisi interval coba lagi yang sesuai dalam hitungan detik

  • header Azure-AsyncOperation berisi URL untuk status hasil operasi Asinkron

  • Setelah selesai, URL hasil operasi GET ke operasi menghasilkan hasil yang sama persis seolah-olah operasi asli telah selesai secara sinkron