Share via

Device Registration State - Query

  • Referensi
Service:
IoT Hub Device Provisioning Service
API Version:
2021-10-01

Mendapatkan status pendaftaran perangkat dalam pendaftaranGroup ini.

POST https://your-dps.azure-devices-provisioning.net/registrations/{id}/query?api-version=2021-10-01

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
id
 path True

string

ID grup pendaftaran.
api-version
 query True

string

Versi API yang digunakan untuk permintaan. Versi yang didukung meliputi: 2021-10-01

Header Permintaan

Nama Diperlukan Jenis Deskripsi
x-ms-max-item-count

integer

int32

pageSize
x-ms-continuation

string

token kelanjutan

Respons

Nama Jenis Deskripsi
200 OK

DeviceRegistrationState[]

Berhasil

Headers

  • x-ms-continuation: string
  • x-ms-max-item-count: integer
  • x-ms-item-type: string
Other Status Codes

ProvisioningServiceErrorDetails

Respons kesalahan

Headers

x-ms-error-code: string

Definisi

Nama Deskripsi
DeviceRegistrationState

Status pendaftaran perangkat.
ProvisioningServiceErrorDetails

Berisi properti kesalahan yang dikembalikan oleh Layanan Provisi Azure IoT Hub.

DeviceRegistrationState

Status pendaftaran perangkat.

Nama Jenis Deskripsi
assignedHub

string

Ditetapkan Azure IoT Hub.
createdDateTimeUtc

string

Waktu tanggal pembuatan pendaftaran (dalam UTC).
deviceId

string

ID perangkat.
errorCode

integer

Kode Kesalahan.
errorMessage

string

Pesan kesalahan.
etag

string

Tag entitas yang terkait dengan sumber daya.
lastUpdatedDateTimeUtc

string

Waktu tanggal terakhir diperbarui (dalam UTC).
payload

object

registrationId

string

Id ini digunakan untuk mengidentifikasi pendaftaran pendaftaran perangkat secara unik. String yang tidak peka huruf besar/kecil (panjangnya hingga 128 karakter) karakter alfanumerik ditambah karakter khusus tertentu: . _ -. Tidak ada karakter khusus yang diperbolehkan di awal atau akhir.
status enum:
  • assigned
  • assigning
  • disabled
  • failed
  • unassigned

Status pendaftaran.
substatus enum:
  • deviceDataMigrated
  • deviceDataReset
  • initialAssignment
  • reprovisionedToInitialAssignment

Substatus untuk perangkat 'Ditetapkan'. Nilai yang mungkin termasuk - 'initialAssignment': Perangkat telah ditetapkan ke hub IoT untuk pertama kalinya, 'deviceDataMigrated': Perangkat telah ditetapkan ke hub IoT yang berbeda dan data perangkatnya dimigrasikan dari hub IoT yang ditetapkan sebelumnya. Data perangkat dihapus dari hub IoT yang ditetapkan sebelumnya, 'deviceDataReset': Perangkat telah ditetapkan ke hub IoT yang berbeda dan data perangkatnya diisi dari status awal yang disimpan dalam pendaftaran. Data perangkat dihapus dari hub IoT yang ditetapkan sebelumnya, 'reprovisionedToInitialAssignment': Perangkat telah diprovisikan ulang ke hub IoT yang ditetapkan sebelumnya.

ProvisioningServiceErrorDetails

Berisi properti kesalahan yang dikembalikan oleh Layanan Provisi Azure IoT Hub.

Nama Jenis Deskripsi
errorCode

integer

info

object

message

string

timestampUtc

string

trackingId

string