Device Management - Get Operation Status

Layanan:

Device Update

Versi API:

2022-10-01

Mengambil status operasi.

GET https://{endpoint}/deviceUpdate/{instanceId}/management/operations/{operationId}?api-version=2022-10-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (url)	Titik akhir akun Device Update for IoT Hub (hanya nama host, tanpa protokol).
instanceId	path	True	string	Pengidentifikasi instans akun Device Update for IoT Hub.
operationId	path	True	string minLength: 1 maxLength: 256	Pengidentifikasi operasi.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
If-None-Match		string	Menentukan kondisi If-None-Match. Operasi akan dilakukan hanya jika ETag pada server tidak cocok dengan nilai ini.

Respons

Nama	Jenis	Deskripsi
200 OK	DeviceOperation	Permintaan telah berhasil. Header Retry-After: string
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
https://api.adu.microsoft.com/.default

Contoh

DeviceManagement_GetOperationStatus

Permintaan sampel

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/management/operations/e4491c54-916f-443d-9094-bcca546ace2f?api-version=2022-10-01

Respon sampel

Kode status:

200

{
  "operationId": "e4491c54-916f-443d-9094-bcca546ace2f",
  "status": "Succeeded",
  "traceId": "2b881ef9deaf5d45b0a716ca5b4145ec",
  "createdDateTime": "2020-04-22T14:00:53.2548897-07:00",
  "lastActionDateTime": "2020-04-22T14:01:43.940142-07:00",
  "etag": "\"a0f7b6f2-3f6c-4eb6-8a59-2f5411c23888\""
}

Definisi

Nama	Deskripsi
DeviceOperation	Metadata operasi.
Error	Detail kesalahan.
ErrorResponse	Respons kesalahan umum.
InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
OperationStatus	Status operasi.

DeviceOperation

Objek

Metadata operasi.

Nama	Jenis	Deskripsi
createdDateTime	string (date-time)	Tanggal dan waktu dalam UTC saat operasi dibuat.
error	Error	Terjadi kesalahan operasi, jika ada.
etag	string	Operasi ETag.
lastActionDateTime	string (date-time)	Tanggal dan waktu dalam UTC ketika status operasi terakhir diperbarui.
operationId	string	Id Operasi.
status	OperationStatus	Status operasi.
traceId	string	Identitas korelasi operasi yang dapat digunakan oleh Dukungan Microsoft untuk pemecahan masalah.

Error

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan yang ditentukan server.
details	Error[]	Array kesalahan yang menyebabkan kesalahan yang dilaporkan.
innererror	InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
occurredDateTime	string (date-time)	Tanggal dan waktu dalam UTC ketika kesalahan terjadi.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan umum.

Nama	Jenis	Deskripsi
error	Error	Detail kesalahan.

InnerError

Objek

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

Nama	Jenis	Deskripsi
code	string	Kode kesalahan yang lebih spesifik daripada yang disediakan oleh kesalahan yang berisi.
errorDetail	string	Pesan kesalahan internal atau pengecualian.
innerError	InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.

OperationStatus

Enumerasi

Status operasi.

Nilai	Deskripsi
NotStarted	Operasi latar belakang dibuat tetapi belum dimulai.
Running	Operasi latar belakang saat ini sedang berjalan.
Succeeded	Operasi latar belakang selesai dengan sukses.
Failed	Operasi latar belakang selesai dengan kegagalan.