Device Management - Get Deployment Status

Layanan:: Device Update

Versi API:: 2022-10-01

Mendapatkan status penyebaran termasuk perincian berapa banyak perangkat dalam penyebaran yang sedang berlangsung, selesai, atau gagal.

GET https://{endpoint}/deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}/status?api-version=2022-10-01

Parameter URI

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

Respons

Nama	Jenis	Deskripsi
200 OK	DeploymentStatus	Permintaan telah berhasil.
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_GetDeploymentStatus

Permintaan sampel

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/management/groups/TestGroup/deployments/deploymentId/status?api-version=2022-10-01

Respon sampel

Kode status:: 200

{
  "groupId": "TestGroup",
  "deploymentState": "ActiveWithSubgroupFailures",
  "subgroupStatus": [
    {
      "groupId": "TestGroup",
      "deviceClassId": "deviceClassId1",
      "deploymentState": "Active",
      "totalDevices": 1,
      "devicesInProgressCount": 0,
      "devicesCompletedFailedCount": 0,
      "devicesCompletedSucceededCount": 1,
      "devicesCanceledCount": 0
    },
    {
      "groupId": "TestGroup",
      "deviceClassId": "deviceClassId2",
      "deploymentState": "Failed",
      "error": {
        "code": "ADMConfigurationLimitExceeded",
        "message": "The subgroup deployment failed to be created due to hitting the ADM configuration limit"
      },
      "totalDevices": 2,
      "devicesInProgressCount": 0,
      "devicesCompletedFailedCount": 1,
      "devicesCompletedSucceededCount": 1,
      "devicesCanceledCount": 0
    }
  ]
}

Definisi

Nama	Deskripsi
DeploymentState	Status penyebaran.
DeploymentStatus	Metadata status penyebaran.
DeviceClassSubgroupDeploymentState	Status penyebaran subgrup kelas perangkat.
DeviceClassSubgroupDeploymentStatus	Metadata status penyebaran subgrup kelas perangkat.
Error	Detail kesalahan.
ErrorResponse	Respons kesalahan umum.
InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.

DeploymentState

Enumerasi

Status penyebaran.

Nilai	Deskripsi
Active	Penyebaran dapat dikirim ke perangkat yang ditargetkan dalam penyebaran.
ActiveWithSubgroupFailures	Penyebaran dapat dikirim ke beberapa perangkat yang ditargetkan dalam penyebaran tetapi setidaknya 1 subgrup dalam keadaan gagal.
Failed	Penyebaran tidak akan dikirim ke perangkat apa pun. Konsultasikan kesalahan untuk detail selengkapnya tentang apa yang gagal.
Inactive	Penyebaran yang lebih baru untuk grup ini telah dibuat dan tidak ada perangkat dalam grup yang akan menerima penyebaran ini.
Canceled	Penyebaran telah dibatalkan dan tidak ada perangkat yang akan menerimanya.

DeploymentStatus

Objek

Metadata status penyebaran.

Nama	Jenis	Deskripsi
deploymentState	DeploymentState	Status penyebaran.
error	Error	Detail kesalahan status Gagal. Ini tidak ada jika status penyebaran tidak Gagal.
groupId	string	Identitas grup
subgroupStatus	DeviceClassSubgroupDeploymentStatus[]	Kumpulan objek status subgrup kelas perangkat

DeviceClassSubgroupDeploymentState

Enumerasi

Status penyebaran subgrup kelas perangkat.

Nilai	Deskripsi
Active	Penyebaran subgrup dapat dikirim ke perangkat yang ditargetkan dalam penyebaran.
Failed	Penyebaran subgrup gagal dan tidak akan dikirim ke perangkat apa pun.
Inactive	Penyebaran yang lebih baru untuk subgrup ini telah dibuat dan tidak ada perangkat dalam subgrup yang akan menerima penyebaran ini.
Canceled	Penyebaran subgrup telah dibatalkan dan tidak ada perangkat yang akan menerimanya.

DeviceClassSubgroupDeploymentStatus

Objek

Metadata status penyebaran subgrup kelas perangkat.

Nama	Jenis	Deskripsi
deploymentState	DeviceClassSubgroupDeploymentState	Status penyebaran subgrup.
deviceClassId	string	Identitas subgrup kelas perangkat
devicesCanceledCount	integer (int32)	Jumlah perangkat yang telah membatalkan penyebarannya.
devicesCompletedFailedCount	integer (int32)	Jumlah perangkat yang telah menyelesaikan penyebaran dengan kegagalan.
devicesCompletedSucceededCount	integer (int32)	Jumlah perangkat yang berhasil menyelesaikan penyebaran.
devicesInProgressCount	integer (int32)	Jumlah perangkat yang saat ini dalam penyebaran.
error	Error	Detail kesalahan status Gagal. Ini tidak ada jika status penyebaran tidak Gagal.
groupId	string	Identitas grup
totalDevices	integer (int32)	Jumlah total perangkat dalam penyebaran.

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.