你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Device Management - List Log Collections

获取所有设备诊断日志集合

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

URI 参数

名称 必需 类型 说明
endpoint
path True

string

url

IoT 中心帐户的设备更新终结点仅 (主机名,不) 协议。

instanceId
path True

string

IoT 中心帐户实例标识符的设备更新。

api-version
query True

string

要与客户端请求一起使用的 API 的版本。

响应

名称 类型 说明
200 OK

LogCollectionList

所有日志集合的列表

Other Status Codes

ErrorResponse

默认响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
https://api.adu.microsoft.com/.default 默认授权范围。

示例

DeviceManagement_ListLogCollections

示例请求

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

示例响应

{
  "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": "string"
}

定义

名称 说明
DeviceUpdateAgentId

设备更新代理 ID

Error

错误详细信息。

ErrorResponse

常见错误响应。

InnerError

一个 对象,该对象包含比当前对象更具体的错误信息。

LogCollection

诊断请求正文

LogCollectionList

支持服务器分页的日志集合的列表。

OperationStatus

操作状态。

DeviceUpdateAgentId

设备更新代理 ID

名称 类型 说明
deviceId

string

设备 ID

moduleId

string

模块 ID

Error

错误详细信息。

名称 类型 说明
code

string

服务器定义的错误代码。

details

Error[]

导致报告错误的错误数组。

innererror

InnerError

一个 对象,该对象包含比当前对象更具体的错误信息。

message

string

错误的用户可读表示形式。

occurredDateTime

string

发生错误的日期和时间(UTC)。

target

string

错误的目标。

ErrorResponse

常见错误响应。

名称 类型 说明
error

Error

错误详细信息。

InnerError

一个 对象,该对象包含比当前对象更具体的错误信息。

名称 类型 说明
code

string

比包含的错误提供的更具体的错误代码。

errorDetail

string

内部错误或异常消息。

innerError

InnerError

一个 对象,该对象包含比当前对象更具体的错误信息。

message

string

错误的用户可读表示形式。

LogCollection

诊断请求正文

名称 类型 说明
createdDateTime

string

创建操作时的时间戳。

description

string

诊断操作的说明。

deviceList

DeviceUpdateAgentId[]

设备更新代理 ID 数组

lastActionDateTime

string

输入当前状态的时间戳。

operationId

string

日志集合 ID。

status

OperationStatus

操作状态。

LogCollectionList

支持服务器分页的日志集合的列表。

名称 类型 说明
nextLink

string

指向下一页项的链接。

value

LogCollection[]

可分页项的集合。

OperationStatus

操作状态。

名称 类型 说明
Failed

string

后台操作已完成但失败。

NotStarted

string

已创建后台操作,但尚未启动。

Running

string

后台操作当前正在运行。

Succeeded

string

后台操作已成功完成。