Device Management - List Log Collections

Layanan:: Device Update

Versi API:: 2022-10-01

Mendapatkan semua koleksi log diagnostik perangkat

GET https://{endpoint}/deviceUpdate/{instanceId}/management/deviceDiagnostics/logCollections?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.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	LogCollectionList	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_ListLogCollections

Permintaan sampel

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/management/deviceDiagnostics/logCollections?api-version=2022-10-01

Respon sampel

Kode status:: 200

{
  "value": [
    {
      "operationId": "LogCollectionId",
      "deviceList": [
        {
          "deviceId": "DeviceA"
        },
        {
          "deviceId": "DeviceB",
          "moduleId": "ModuleB"
        }
      ],
      "description": "Log collection description",
      "createdDateTime": "2021-09-30T02:23:41.59Z",
      "lastActionDateTime": "2021-09-30T02:23:41.59Z",
      "status": "NotStarted"
    }
  ],
  "nextLink": "https://contoso.api.adu.microsoft.com/deviceUpdate/blue/management/deviceDiagnostics/logCollections?api-version=2022-10-01&$skiptoken=abc"
}

Definisi

Nama	Deskripsi
DeviceUpdateAgentId	Id agen Pembaruan Perangkat
Error	Detail kesalahan.
ErrorResponse	Respons kesalahan umum.
InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
LogCollection	Isi permintaan diagnostik
LogCollectionList	Daftar koleksi log dengan dukungan halaman server.
OperationStatus	Status operasi.

DeviceUpdateAgentId

Objek

Id agen Pembaruan Perangkat

Nama	Jenis	Deskripsi
deviceId	string	Id Perangkat
moduleId	string	Id Modul

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.

LogCollection

Objek

Isi permintaan diagnostik

Nama	Jenis	Deskripsi
createdDateTime	string	Tanda waktu saat operasi dibuat.
description	string maxLength: 512	Deskripsi operasi diagnostik.
deviceList	DeviceUpdateAgentId[]	Array id agen Pembaruan Perangkat
lastActionDateTime	string	Tanda waktu ketika status saat ini dimasukkan.
operationId	string	Id koleksi log.
status	OperationStatus	Status operasi.

LogCollectionList

Objek

Daftar koleksi log dengan dukungan halaman server.

Nama	Jenis	Deskripsi
nextLink	string (uri)	Tautan ke halaman item berikutnya
value	LogCollection[]	Item LogCollection di halaman ini

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.