REST Resource: customers.telemetry.devices

资源:TelemetryDevice

从受管设备收集的遥测数据。

  • 需要细化权限:TELEMETRY_API_DEVICE
JSON 表示法
{
  "name": string,
  "customer": string,
  "orgUnitId": string,
  "deviceId": string,
  "serialNumber": string,
  "cpuInfo": [
    {
      object (CpuInfo)
    }
  ],
  "cpuStatusReport": [
    {
      object (CpuStatusReport)
    }
  ],
  "memoryInfo": {
    object (MemoryInfo)
  },
  "memoryStatusReport": [
    {
      object (MemoryStatusReport)
    }
  ],
  "networkInfo": {
    object (NetworkInfo)
  },
  "networkStatusReport": [
    {
      object (NetworkStatusReport)
    }
  ],
  "networkDiagnosticsReport": [
    {
      object (NetworkDiagnosticsReport)
    }
  ],
  "osUpdateStatus": [
    {
      object (OsUpdateStatus)
    }
  ],
  "graphicsInfo": {
    object (GraphicsInfo)
  },
  "graphicsStatusReport": [
    {
      object (GraphicsStatusReport)
    }
  ],
  "batteryInfo": [
    {
      object (BatteryInfo)
    }
  ],
  "batteryStatusReport": [
    {
      object (BatteryStatusReport)
    }
  ],
  "storageInfo": {
    object (StorageInfo)
  },
  "storageStatusReport": [
    {
      object (StorageStatusReport)
    }
  ],
  "thunderboltInfo": [
    {
      object (ThunderboltInfo)
    }
  ],
  "audioStatusReport": [
    {
      object (AudioStatusReport)
    }
  ],
  "bootPerformanceReport": [
    {
      object (BootPerformanceReport)
    }
  ],
  "heartbeatStatusReport": [
    {
      object (HeartbeatStatusReport)
    }
  ],
  "kioskAppStatusReport": [
    {
      object (KioskAppStatusReport)
    }
  ],
  "networkBandwidthReport": [
    {
      object (NetworkBandwidthReport)
    }
  ],
  "peripheralsReport": [
    {
      object (PeripheralsReport)
    }
  ],
  "runtimeCountersReport": [
    {
      object (RuntimeCountersReport)
    }
  ]
}
字段
name

string

仅供输出。设备的资源名称。

customer

string

仅供输出。企业注册该设备的 Google Workspace 客户。

orgUnitId

string

仅供输出。设备的组织部门 ID。

deviceId

string

仅供输出。设备的唯一 Directory API ID。此值与管理控制台的“ChromeOS 设备”标签页中的 Directory API ID 相同

serialNumber

string

仅供输出。设备序列号。此值与管理控制台的 ChromeOS 设备标签页中的序列号相同。

cpuInfo[]

object (CpuInfo)

仅供输出。与设备 CPU 规格相关的信息。

cpuStatusReport[]

object (CpuStatusReport)

仅供输出。收集的 CPU 状态报告,按 reportTime 的降序顺序定期排序。

memoryInfo

object (MemoryInfo)

仅供输出。有关设备内存规格的信息。

memoryStatusReport[]

object (MemoryStatusReport)

仅供输出。收集的内存状态报告定期按reportTime降序排列。

networkInfo

object (NetworkInfo)

仅供输出。网络设备信息。

networkStatusReport[]

object (NetworkStatusReport)

仅供输出。定期收集的网络规范。

networkDiagnosticsReport[]

object (NetworkDiagnosticsReport)

仅供输出。定期收集的网络诊断信息。

osUpdateStatus[]

object (OsUpdateStatus)

仅供输出。包含与 ChromeOS 更新状态相关的信息。

graphicsInfo

object (GraphicsInfo)

仅供输出。包含设备图形外围设备的相关信息。

graphicsStatusReport[]

object (GraphicsStatusReport)

仅供输出。定期收集的图形报告。

batteryInfo[]

object (BatteryInfo)

仅供输出。有关设备的电池规格的信息。

batteryStatusReport[]

object (BatteryStatusReport)

仅供输出。定期收集的电池报告。

storageInfo

object (StorageInfo)

仅供输出。设备存储规格信息。

storageStatusReport[]

object (StorageStatusReport)

仅供输出。定期收集的存储报告。

thunderboltInfo[]

object (ThunderboltInfo)

仅供输出。有关 Thunderbolt 总线的信息。

audioStatusReport[]

object (AudioStatusReport)

仅供输出。收集的音频报告,按 reportTime 的降序顺序定期排序。

bootPerformanceReport[]

object (BootPerformanceReport)

仅供输出。设备的启动性能报告。

heartbeatStatusReport[]

object (HeartbeatStatusReport)

仅供输出。检测信号状态报告包含按 reportTime 降序排列的时间戳

kioskAppStatusReport[]

object (KioskAppStatusReport)

仅供输出。自助服务终端设备的自助服务终端应用状态报告

networkBandwidthReport[]

object (NetworkBandwidthReport)

仅供输出。收集的网络带宽报告,按 reportTime 的降序顺序定期排序。

peripheralsReport[]

object (PeripheralsReport)

仅供输出。收集的外围设备报告,按 reportTime 的降序顺序定期排序。

runtimeCountersReport[]

object (RuntimeCountersReport)

仅供输出。运行时计数器会报告收集到的设备生命周期运行时,以及 S0->S3、S0->S4 以及 S0->S5 转换(表示进入休眠、休眠和关机状态)计数

CpuInfo

设备的 CPU 规格

  • 此字段提供的设备信息是静态的,不会随时间发生变化。
  • 此字段的数据通过政策控制:ReportDeviceCpuInfo
  • 数据收集频率:仅在上传时
  • 默认数据报告频率:3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:否
  • 仅为关联用户报告:不适用
  • 需要细化权限:TELEMETRY_API_CPU_INFO
JSON 表示法
{
  "model": string,
  "architecture": enum (Architecture),
  "maxClockSpeed": integer,
  "keylockerSupported": boolean,
  "keylockerConfigured": boolean
}
字段
model

string

仅供输出。CPU 型号名称。例如:Intel(R) Core(TM) i5-8250U CPU @ 1.60GHz

architecture

enum (Architecture)

仅供输出。CPU 的架构类型。

  • 此字段提供的设备信息是静态的,不会随时间发生变化。
  • 此字段的数据通过政策控制:ReportDeviceCpuInfo
  • 数据收集频率:仅在上传时
  • 默认数据报告频率:3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:否
  • 仅为关联用户报告:不适用
maxClockSpeed

integer

仅供输出。最大 CPU 时钟速度,以 kHz 为单位。

keylockerSupported

boolean

仅供输出。是否支持 Keylocker。

keylockerConfigured

boolean

仅供输出。是否配置了 Keylocker。TRUE = 已启用;FALSE = 已停用。仅在 keylockerSupported = TRUE 时报告。

架构

CPU 的架构类型。

枚举
ARCHITECTURE_UNSPECIFIED 架构未知。
X64 x64 架构

CpuStatusReport

提供有关 CPU 状态的信息。

  • 此字段是遥测信息,会随着设备的使用而不断变化。
  • 此字段的数据通过政策控制:ReportDeviceCpuInfo
  • 数据收集频率:每 10 分钟
  • 默认数据报告频率:3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:否
  • 仅为关联用户报告:不适用
  • 需要细化权限:TELEMETRY_API_CPU_REPORT
JSON 表示法
{
  "reportTime": string,
  "sampleFrequency": string,
  "cpuUtilizationPct": integer,
  "cpuTemperatureInfo": [
    {
      object (CpuTemperatureInfo)
    }
  ]
}
字段
reportTime

string (Timestamp format)

仅供输出。以毫秒为单位的时间戳,表示此报告的抽样时间。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

sampleFrequency

string (Duration format)

仅供输出。报告的抽样频率。

此时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

cpuUtilizationPct

integer

仅供输出。CPU 利用率样本 (0-100%)。

cpuTemperatureInfo[]

object (CpuTemperatureInfo)

仅供输出。每个 CPU 核心的 CPU 温度样本信息(以摄氏度为单位)

CpuTemperatureInfo

设备的 CPU 温度。每个 CPU 核心采样(以摄氏度为单位)。

  • 此字段是遥测信息,会随着设备的使用而不断变化。
  • 此字段的数据通过政策控制:ReportDeviceCpuInfo
  • 数据收集频率:每 10 分钟
  • 默认数据报告频率:3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:否
  • 仅为关联用户报告:不适用
JSON 表示法
{
  "temperatureCelsius": integer,
  "label": string
}
字段
temperatureCelsius

integer

仅供输出。CPU 温度(以摄氏度为单位)。

label

string

仅供输出。CPU 标签。示例:核心 0

MemoryInfo

设备的内存信息。

  • 此字段包含遥测和设备信息:
    • totalRamBytes - 设备信息
    • availableRamBytes - 遥测信息
    • totalMemoryEncryption - 设备信息
  • 此字段的数据通过政策控制:ReportDeviceMemoryInfo
  • 数据收集频率:
    • totalRamBytes - 仅在上传时
    • availableRamBytes - 每 10 分钟
    • totalMemoryEncryption - 设备启动时
  • 默认的数据报告频率:
    • totalRamBytes - 3 小时
    • availableRamBytes - 3 小时
    • totalMemoryEncryption - 设备启动时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:仅针对 totalMemoryEncryption
  • 仅为关联用户报告:不适用
  • 需要细化权限:TELEMETRY_API_MEMORY_INFO
JSON 表示法
{
  "totalRamBytes": string,
  "availableRamBytes": string,
  "totalMemoryEncryption": {
    object (TotalMemoryEncryptionInfo)
  }
}
字段
totalRamBytes

string (int64 format)

仅供输出。RAM 总容量(以字节为单位)。

availableRamBytes

string (int64 format)

仅供输出。可用 RAM 容量(以字节为单位)。

totalMemoryEncryption

object (TotalMemoryEncryptionInfo)

仅供输出。设备的总内存加密信息。

TotalMemoryEncryptionInfo

设备的内存加密信息。

  • 此字段提供的设备信息是静态的,不会随时间发生变化。
  • 此字段的数据通过政策控制:ReportDeviceMemoryInfo
  • 数据收集频率:设备启动时
  • 默认数据报告频率:设备启动时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:是
  • 仅为关联用户报告:不适用
JSON 表示法
{
  "encryptionState": enum (MemoryEncryptionState),
  "maxKeys": string,
  "keyLength": string,
  "encryptionAlgorithm": enum (MemoryEncryptionAlgorithm)
}
字段
encryptionState

enum (MemoryEncryptionState)

设备上的内存加密状态。

maxKeys

string (int64 format)

可用于加密的密钥数上限。

keyLength

string (int64 format)

加密密钥的长度。

encryptionAlgorithm

enum (MemoryEncryptionAlgorithm)

内存加密算法。

MemoryEncryptionState

设备上的内存加密状态。

枚举
MEMORY_ENCRYPTION_STATE_UNSPECIFIED 未设置内存加密状态。
MEMORY_ENCRYPTION_STATE_UNKNOWN 内存加密状态未知。
MEMORY_ENCRYPTION_STATE_DISABLED 设备上的内存加密已停用。
MEMORY_ENCRYPTION_STATE_TME 设备上的内存加密采用的是全内存加密。
MEMORY_ENCRYPTION_STATE_MKTME 设备上的内存加密采用多密钥总内存加密。

MemoryEncryptionAlgorithm

设备上使用的加密算法。

枚举
MEMORY_ENCRYPTION_ALGORITHM_UNSPECIFIED 未设置内存加密算法。
MEMORY_ENCRYPTION_ALGORITHM_UNKNOWN 所使用的内存加密算法未知。
MEMORY_ENCRYPTION_ALGORITHM_AES_XTS_128 内存加密算法使用采用 128 位块加密的 AES_XTS 加密算法。
MEMORY_ENCRYPTION_ALGORITHM_AES_XTS_256 内存加密算法使用采用 256 位块加密的 AES_XTS 加密算法。

MemoryStatusReport

包含内存状态报告的示例。

  • 此字段是遥测信息,会随着设备的使用而不断变化。
  • 此字段的数据通过政策控制:ReportDeviceMemoryInfo
  • 数据收集频率:系统仅在上传时,每 10 分钟收集一次 SystemRamFreeByes
  • 默认数据报告频率:每 3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:否
  • 仅为关联用户报告:不适用
  • 需要细化权限:TELEMETRY_API_MEMORY_REPORT
JSON 表示法
{
  "reportTime": string,
  "sampleFrequency": string,
  "systemRamFreeBytes": string,
  "pageFaults": integer
}
字段
reportTime

string (Timestamp format)

仅供输出。以毫秒为单位的时间戳,表示此报告的抽样时间。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

sampleFrequency

string (Duration format)

仅供输出。报告的抽样频率。

此时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

systemRamFreeBytes

string (int64 format)

仅供输出。以字节为单位的可用 RAM 量(由于垃圾回收而不可靠)。

pageFaults

integer

仅供输出。此收集期间的页面故障数

NetworkInfo

网络设备信息。

  • 此字段提供的设备信息是静态的,不会随时间发生变化。
  • 此字段的数据通过政策控制:ReportNetworkDeviceConfiguration
  • 数据收集频率:设备启动时
  • 默认数据报告频率:设备启动时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:是
  • 仅为关联用户报告:不适用
  • 需要细化权限:TELEMETRY_API_NETWORK_INFO
JSON 表示法
{
  "networkDevices": [
    {
      object (NetworkDevice)
    }
  ]
}
字段
networkDevices[]

object (NetworkDevice)

仅供输出。网络设备列表。

NetworkDevice

有关网络设备的详细信息。

  • 此字段提供的设备信息是静态的,不会随时间发生变化。
  • 此字段的数据通过政策控制:ReportNetworkDeviceConfiguration
  • 数据收集频率:设备启动时
  • 默认数据报告频率:设备启动时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:是
  • 仅为关联用户报告:不适用
JSON 表示法
{
  "type": enum (NetworkDeviceType),
  "macAddress": string,
  "meid": string,
  "imei": string,
  "iccid": string,
  "mdn": string
}
字段
type

enum (NetworkDeviceType)

仅供输出。网络设备类型。

macAddress

string

仅供输出。相应网络设备的 MAC 地址(如适用)。

meid

string

仅供输出。相应网络设备的 MEID(如果适用)。

imei

string

仅供输出。相应网络设备的 IMEI(如果适用)。

iccid

string

仅供输出。与设备的 SIM 卡关联的集成电路卡 ID。

mdn

string

仅供输出。与设备的 SIM 卡关联的移动目录号码。

NetworkDeviceType

网络设备类型。

枚举
NETWORK_DEVICE_TYPE_UNSPECIFIED 未指定网络设备类型。
CELLULAR_DEVICE 移动设备。
ETHERNET_DEVICE 以太网设备。
WIFI_DEVICE Wi-Fi 设备。

NetworkStatusReport

可见/已配置网络的状态。

  • 此字段是遥测信息,会随着设备的使用而不断变化。
  • 此字段的数据通过政策进行控制:ReportNetworkStatus
  • 数据收集频率:60 分钟
  • 默认数据报告频率:3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:是
  • 仅针对关联用户报告:是
  • 需要细化权限:TELEMETRY_API_NETWORK_REPORT
JSON 表示法
{
  "reportTime": string,
  "sampleFrequency": string,
  "signalStrengthDbm": integer,
  "lanIpAddress": string,
  "gatewayIpAddress": string,
  "transmissionBitRateMbps": string,
  "receivingBitRateMbps": string,
  "transmissionPowerDbm": integer,
  "encryptionOn": boolean,
  "wifiLinkQuality": string,
  "wifiPowerManagementEnabled": boolean,
  "guid": string,
  "connectionState": enum (NetworkConnectionState),
  "connectionType": enum (NetworkType)
}
字段
reportTime

string (Timestamp format)

仅供输出。报告网络状态的时间。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

sampleFrequency

string (Duration format)

仅供输出。报告的抽样频率。

此时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

signalStrengthDbm

integer

仅供输出。无线网络的信号强度(以分贝为单位)。

lanIpAddress

string

仅供输出。LAN IP 地址。

gatewayIpAddress

string

仅供输出。网关 IP 地址。

transmissionBitRateMbps

string (int64 format)

仅供输出。传输比特率(以兆比特/秒为单位)。

receivingBitRateMbps

string (int64 format)

仅供输出。接收比特率(以兆比特/秒为单位)。

transmissionPowerDbm

integer

仅供输出。传输功率(以分贝为单位)。

encryptionOn

boolean

仅供输出。Wi-Fi 加密密钥是否处于关闭状态。

wifiPowerManagementEnabled

boolean

仅供输出。已启用 Wi-Fi 电源管理

guid

string

仅供输出。网络连接指导

connectionState

enum (NetworkConnectionState)

仅供输出。网络的当前连接状态。

connectionType

enum (NetworkType)

仅供输出。网络连接类型。

NetworkType

网络连接类型。

枚举
NETWORK_TYPE_UNSPECIFIED 未指定网络连接类型
CELLULAR 移动网络连接。
ETHERNET 以太网网络连接。
TETHER 网络共享网络连接。
VPN VPN 网络连接。
WIFI Wi-Fi 网络连接。

NetworkDiagnosticsReport

网络测试结果,用于确定设备的网络连接状况,例如 HTTPS 延迟时间是高还是正常。

  • 需要细化权限:TELEMETRY_API_NETWORK_REPORT
JSON 表示法
{
  "reportTime": string,
  "httpsLatencyData": {
    object (HttpsLatencyRoutineData)
  }
}
字段
reportTime

string (Timestamp format)

仅供输出。收集诊断信息时的时间戳。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

httpsLatencyData

object (HttpsLatencyRoutineData)

仅供输出。HTTPS 延迟时间测试数据。

OsUpdateStatus

包含有关当前操作系统更新状态的信息。

  • 此字段是遥测信息,会随着设备的使用而不断变化。
  • 此字段的数据通过政策进行控制:ReportDeviceOsUpdateStatus
  • 数据收集频率:仅在上传时
  • 默认数据报告频率:3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:否
  • 仅为关联用户报告:不适用
  • 需要细化权限:TELEMETRY_API_OS_REPORT
JSON 表示法
{
  "updateState": enum (UpdateState),
  "newPlatformVersion": string,
  "newRequestedPlatformVersion": string,
  "lastUpdateTime": string,
  "lastUpdateCheckTime": string,
  "lastRebootTime": string
}
字段
updateState

enum (UpdateState)

仅供输出。操作系统更新的当前状态。

newPlatformVersion

string

仅供输出。正在下载和应用操作系统映像的新平台版本。仅当更新状态为 OS_IMAGE_DOWNLOAD_IN_PROGRESS 或 OS_UPDATE_NEED_REBOOT 时,才会设置此字段。请注意,在某些极端情况下,这可能是 OS_UPDATE_NEED_REBOOT 状态的虚拟“0.0.0.0”(例如,更新引擎在不重新启动的情况下重启)。

newRequestedPlatformVersion

string

仅供输出。待处理的更新自助服务终端应用请求的新平台版本。

lastUpdateTime

string (Timestamp format)

仅供输出。上次成功更新的时间戳。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

lastUpdateCheckTime

string (Timestamp format)

仅供输出。上次更新检查的时间戳。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

lastRebootTime

string (Timestamp format)

仅供输出。上次重新启动的时间戳。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

UpdateState

操作系统更新的状态

枚举
UPDATE_STATE_UNSPECIFIED 状态未指定。
OS_IMAGE_DOWNLOAD_NOT_STARTED 操作系统尚未开始下载。
OS_IMAGE_DOWNLOAD_IN_PROGRESS 操作系统已开始在设备上下载。
OS_UPDATE_NEED_REBOOT 设备需要重新启动才能完成上传。

GraphicsInfo

图形子系统的信息。

  • 此字段提供的设备信息是静态的,不会随时间发生变化。
  • 此字段的数据通过政策控制:ReportDeviceGraphicsStatus
  • 数据收集频率:仅在上传时
  • 默认数据报告频率:3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:否
  • 仅为关联用户报告:不适用
  • 需要细化权限:TELEMETRY_API_GRAPHICS_INFO
JSON 表示法
{
  "adapterInfo": {
    object (GraphicsAdapterInfo)
  },
  "eprivacySupported": boolean,
  "displayDevices": [
    {
      object (DisplayDevice)
    }
  ],
  "touchScreenInfo": {
    object (TouchScreenInfo)
  }
}
字段
adapterInfo

object (GraphicsAdapterInfo)

仅供输出。有关图形适配器 (GPU) 的信息。

eprivacySupported

boolean

仅供输出。是否支持电子隐私保护屏幕。

displayDevices[]

object (DisplayDevice)

仅供输出。与设备显示屏相关的信息。

touchScreenInfo

object (TouchScreenInfo)

仅供输出。与设备内部触摸屏相关的信息。

GraphicsAdapterInfo

图形适配器 (GPU) 的信息。

JSON 表示法
{
  "adapter": string,
  "driverVersion": string,
  "deviceId": string
}
字段
adapter

string

仅供输出。适配器名称。示例:Mesa DRI Intel(R) UHD Graphics 620 (Kabylake GT2)。

driverVersion

string

仅供输出。GPU 驱动程序的版本。

deviceId

string (int64 format)

仅供输出。表示显卡设备 ID。

DisplayDevice

显示设备的信息。

JSON 表示法
{
  "displayName": string,
  "displayWidthMm": integer,
  "displayHeightMm": integer,
  "internal": boolean,
  "manufacturerId": string,
  "modelId": integer,
  "manufactureYear": integer
}
字段
displayName

string

仅供输出。显示设备名称。

displayWidthMm

integer

仅供输出。显示宽度(以毫米为单位)。

displayHeightMm

integer

仅供输出。显示高度(以毫米为单位)。

internal

boolean

仅供输出。是否为内部显示屏。

manufacturerId

string

仅供输出。制造商 ID(三个字母)。

modelId

integer

仅供输出。制造商商品代码。

manufactureYear

integer

仅供输出。制造年份。

TouchScreenInfo

设备触摸屏上的信息。

JSON 表示法
{
  "touchpadLibrary": string,
  "devices": [
    {
      object (TouchScreenDevice)
    }
  ]
}
字段
touchpadLibrary

string

仅供输出。输入堆栈使用的触控板库名称。

devices[]

object (TouchScreenDevice)

仅供输出。内部触摸屏设备列表。

TouchScreenDevice

内部触摸屏设备的信息。

JSON 表示法
{
  "displayName": string,
  "touchPointCount": integer,
  "stylusCapable": boolean
}
字段
displayName

string

仅供输出。触摸屏设备的显示名称。

touchPointCount

integer

仅供输出。设备上支持的接触点数量。

stylusCapable

boolean

仅供输出。触摸屏设备是否支持触控笔。

GraphicsStatusReport

图形子系统的信息。

  • 此字段是遥测信息,会随着设备的使用而不断变化。
  • 此字段的数据通过政策控制:ReportDeviceGraphicsInfo
  • 数据收集频率:3 小时。
  • 默认数据报告频率:3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:否
  • 仅为关联用户报告:不适用
  • 需要细化权限:TELEMETRY_API_GRAPHICS_REPORT
JSON 表示法
{
  "reportTime": string,
  "displays": [
    {
      object (DisplayInfo)
    }
  ]
}
字段
reportTime

string (Timestamp format)

仅供输出。报告图形数据的时间。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

displays[]

object (DisplayInfo)

仅供输出。设备显示屏的相关信息。

DisplayInfo

显示的信息。

JSON 表示法
{
  "deviceId": string,
  "resolutionWidth": integer,
  "resolutionHeight": integer,
  "refreshRate": integer,
  "isInternal": boolean,
  "displayName": string
}
字段
deviceId

string (int64 format)

仅供输出。表示显卡设备 ID。

resolutionWidth

integer

仅供输出。分辨率宽度(以像素为单位)。

resolutionHeight

integer

仅供输出。分辨率高度(以像素为单位)。

refreshRate

integer

仅供输出。刷新率,以 Hz 为单位。

isInternal

boolean

仅供输出。指明显示屏是否为内部显示屏。

displayName

string

仅供输出。显示设备名称。

BatteryInfo

电池的相关信息。

  • 此字段提供的设备信息是静态的,不会随时间发生变化。
  • 此字段的数据通过政策控制:ReportDevicePowerStatus
  • 数据收集频率:仅在上传时
  • 默认数据报告频率:3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:否
  • 仅为关联用户报告:不适用
  • 需要细化权限:TELEMETRY_API_BATTERY_INFO
JSON 表示法
{
  "serialNumber": string,
  "manufacturer": string,
  "designCapacity": string,
  "designMinVoltage": integer,
  "manufactureDate": {
    object (Date)
  },
  "technology": string
}
字段
serialNumber

string

仅供输出。电池序列号。

manufacturer

string

仅供输出。电池制造商。

designCapacity

string (int64 format)

仅供输出。设计容量(毫安小时)。

designMinVoltage

integer

仅供输出。设计的最低输出电压 (mV)

manufactureDate

object (Date)

仅供输出。电池的制造日期。

technology

string

仅供输出。电池的技术。示例:锂电池

BatteryStatusReport

电池状态数据。

  • 此字段是遥测信息,会随着设备的使用而不断变化。
  • 此字段的数据通过政策控制:ReportDevicePowerStatus
  • 数据收集频率:仅在上传时
  • 默认数据报告频率:3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:否
  • 仅为关联用户报告:不适用
  • 需要细化权限:TELEMETRY_API_BATTERY_REPORT
JSON 表示法
{
  "reportTime": string,
  "serialNumber": string,
  "sample": [
    {
      object (BatterySampleReport)
    }
  ],
  "batteryHealth": enum (BatteryHealth),
  "fullChargeCapacity": string,
  "cycleCount": integer
}
字段
reportTime

string (Timestamp format)

仅供输出。表示在设备上收集样本时的时间戳

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

serialNumber

string

仅供输出。电池序列号。

sample[]

object (BatterySampleReport)

仅供输出。按 reportTime 以降序排序的电池采样数据。

batteryHealth

enum (BatteryHealth)

仅供输出。电池健康度。

fullChargeCapacity

string (int64 format)

仅供输出。满电容量(毫安小时)。

cycleCount

integer

仅供输出。充电循环次数。

BatterySampleReport

电池采样数据。

  • 此字段是遥测信息,会随着设备的使用而不断变化。
  • 此字段的数据通过政策控制:ReportDevicePowerStatus
  • 数据收集频率:仅在上传时
  • 默认数据报告频率:3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:否
  • 仅为关联用户报告:不适用
JSON 表示法
{
  "reportTime": string,
  "voltage": string,
  "remainingCapacity": string,
  "temperature": integer,
  "dischargeRate": integer,
  "chargeRate": integer,
  "current": string,
  "status": string
}
字段
reportTime

string (Timestamp format)

仅供输出。表示在设备上收集样本时的时间戳

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

voltage

string (int64 format)

仅供输出。电池电压(毫伏)。

remainingCapacity

string (int64 format)

仅供输出。电池剩余容量 (mAmpere-hours)。

temperature

integer

仅供输出。温度(以摄氏度为单位)。

dischargeRate

integer

仅供输出。电池放电率(以 mW 为单位)。如果电池正在放电,则为正值;如果正在充电,则为负值。

chargeRate

integer

仅供输出。电池充电百分比。

current

string (int64 format)

仅供输出。电池电流(毫安)。

status

string

仅供输出。从 sysfs 读取电池状态。示例:正在放电

BatteryHealth

表示电池的当前运行状况。

  • 此状态并非电量计或电池有缺陷的迹象。计算方法是将当前充满电容量除以设计容量。
  • 电池完整性和保修政策由制造商自行定义。
枚举
BATTERY_HEALTH_UNSPECIFIED 健康状况未知。
BATTERY_HEALTH_NORMAL 电池状况良好,充满电容量 / 设计容量 > 80%
BATTERY_REPLACE_SOON 电池状况不太健康,建议尽快更换。满电容量 / 设计容量为 75% - 80%
BATTERY_REPLACE_NOW 电池健康状况不佳,建议更换;满电容量 / 设计容量 < 75%

StorageInfo

存储的状态数据。

  • 此字段是遥测信息,会随着设备的使用而不断变化。
  • 此字段的数据通过政策控制:ReportDeviceStorageStatus
  • 数据收集频率:仅在上传时
  • 默认数据报告频率:3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:否
  • 仅为关联用户报告:不适用
  • 需要细化权限:TELEMETRY_API_STORAGE_INFO
JSON 表示法
{
  "volume": [
    {
      object (DiskVolume)
    }
  ],
  "availableDiskBytes": string,
  "totalDiskBytes": string
}
字段
volume[]

object (DiskVolume)

磁盘卷的信息

availableDiskBytes

string (int64 format)

设备中的用户数据存储可用空间(以字节为单位)。

totalDiskBytes

string (int64 format)

设备中的用户数据存储总空间(以字节为单位)。

DiskVolume

磁盘卷的信息

JSON 表示法
{
  "volumeId": string,
  "storageFreeBytes": string,
  "storageTotalBytes": string
}
字段
volumeId

string

磁盘卷 ID。

storageFreeBytes

string (int64 format)

可用存储空间(以字节为单位)。

storageTotalBytes

string (int64 format)

总存储空间(以字节为单位)。

StorageStatusReport

存储的状态数据。

  • 此字段是遥测信息,会随着设备的使用而不断变化。
  • 此字段的数据通过政策控制:ReportDeviceStorageStatus
  • 数据收集频率:仅在上传时
  • 默认数据报告频率:3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:否
  • 仅为关联用户报告:不适用
  • 需要细化权限:TELEMETRY_API_STORAGE_REPORT
JSON 表示法
{
  "reportTime": string,
  "disk": [
    {
      object (DiskInfo)
    }
  ]
}
字段
reportTime

string (Timestamp format)

仅供输出。表示在设备上收集样本时的时间戳

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

disk[]

object (DiskInfo)

仅供输出。磁盘报告。

DiskInfo

单个存储设备的状态。

JSON 表示法
{
  "serialNumber": string,
  "manufacturer": string,
  "model": string,
  "sizeBytes": string,
  "type": string,
  "health": string,
  "volumeIds": [
    string
  ],
  "bytesReadThisSession": string,
  "bytesWrittenThisSession": string,
  "readTimeThisSession": string,
  "writeTimeThisSession": string,
  "ioTimeThisSession": string,
  "discardTimeThisSession": string
}
字段
serialNumber

string

仅供输出。磁盘序列号。

manufacturer

string

仅供输出。磁盘制造商。

model

string

仅供输出。磁盘模型。

sizeBytes

string (int64 format)

仅供输出。磁盘大小。

type

string

仅供输出。磁盘类型:eMMC / NVMe / ATA / SCSI。

health

string

仅供输出。磁盘健康状况。

volumeIds[]

string

仅供输出。磁盘卷。

bytesReadThisSession

string (int64 format)

仅供输出。自上次启动后读取的字节数。

bytesWrittenThisSession

string (int64 format)

仅供输出。自上次启动后写入的字节数。

readTimeThisSession

string (Duration format)

仅供输出。自上次启动后从磁盘读取数据所花费的时间。

此时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

writeTimeThisSession

string (Duration format)

仅供输出。自上次启动后写入磁盘所用的时间。

此时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

ioTimeThisSession

string (Duration format)

仅供输出。计算磁盘和队列处于忙碌状态的时间,因此与以上字段不同,并行请求不会重复计数。

此时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

discardTimeThisSession

string (Duration format)

仅供输出。自上次启动以来舍弃内容所用的时间。舍弃操作会写入到不再使用的块。在内核 4.18 及更高版本上受支持。

此时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

ThunderboltInfo

Thunderbolt 公交车信息。

  • 此字段提供的设备信息是静态的,不会随时间发生变化。
  • 此字段的数据通过政策进行控制:ReportDeviceSecurityStatus
  • 数据收集频率:设备启动时
  • 默认数据报告频率:设备启动时
    • 由政策控制:否
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:是
  • 仅为关联用户报告:不适用
  • 需要细化权限:TELEMETRY_API_BUS_DEVICE_INFO
JSON 表示法
{
  "securityLevel": enum (ThunderboltSecurityLevel)
}
字段
securityLevel

enum (ThunderboltSecurityLevel)

Thunderbolt 总线的安全等级。

ThunderboltSecurityLevel

Thunderbolt 总线的安全等级。

枚举
THUNDERBOLT_SECURITY_LEVEL_UNSPECIFIED 未设置 Thunderbolt 安全级别。
THUNDERBOLT_SECURITY_NONE_LEVEL 所有设备均通过固件自动连接。无需用户批准。
THUNDERBOLT_SECURITY_USER_LEVEL 系统会询问用户是否允许连接设备。
THUNDERBOLT_SECURITY_SECURE_LEVEL 系统会询问用户是否允许连接设备。此外,系统会根据写入密钥 sysfs 属性的随机密钥,向设备发送一个验证,该验证应与预期匹配
THUNDERBOLT_SECURITY_DP_ONLY_LEVEL 固件会自动为 Thunderbolt 创建隧道。
THUNDERBOLT_SECURITY_USB_ONLY_LEVEL 该固件会自动为基座中的 USB 控制器和显示端口创建隧道。基座下的所有 PCIe 链路都会被移除。
THUNDERBOLT_SECURITY_NO_PCIE_LEVEL PCIE 隧道已停用。

BootPerformanceReport

设备的启动性能报告。

  • 此字段是遥测信息,会随着设备的使用而不断变化。
  • 此字段的数据通过政策进行控制:ReportDeviceBootMode
  • 数据收集频率:每当有启动事件发生时
  • 默认数据报告频率:3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:是
  • 仅为关联用户报告:不适用
  • 需要细化权限:TELEMETRY_API_OS_REPORT
JSON 表示法
{
  "bootUpDuration": string,
  "bootUpTime": string,
  "shutdownDuration": string,
  "shutdownTime": string,
  "shutdownReason": enum (ShutdownReason),
  "reportTime": string
}
字段
bootUpDuration

string (Duration format)

总启动时间。

此时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

bootUpTime

string (Timestamp format)

接通电源时的时间戳。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

shutdownDuration

string (Duration format)

自关机开始后关机的总时长。

此时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

shutdownTime

string (Timestamp format)

关停时的时间戳。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

shutdownReason

enum (ShutdownReason)

关停原因。

reportTime

string (Timestamp format)

收集报告的时间戳。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

ShutdownReason

关停原因。

枚举
SHUTDOWN_REASON_UNSPECIFIED 未指定关闭原因。
USER_REQUEST 由用户发起。
SYSTEM_UPDATE 已启动系统更新。
LOW_BATTERY 因电量不足而关机。
OTHER 因其他原因关机。

HeartbeatStatusReport

设备的检测信号状态报告。

  • 适用于自助服务终端
  • 此字段提供设备的在线/离线/未知状态,并且只有在状态发生变化(如在线 -> 离线)时才会显示此字段
  • 此字段的数据通过政策控制:HeartbeatEnabled 了解详情
  • 检测信号频率:2 分钟
    • 注意:如果设备离线,其在线状态最长可能需要 12 分钟才能更新
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:不适用
  • 仅为关联用户报告:不适用
  • 需要细化权限:TELEMETRY_API_DEVICE_ACTIVITY_REPORT
JSON 表示法
{
  "reportTime": string,
  "state": enum (State)
}
字段
reportTime

string (Timestamp format)

检测到状态更改时的时间戳

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

state

enum (State)

设备更改为的状态

状态

设备状态

枚举
STATE_UNSPECIFIED 未指定状态
UNKNOWN 设备不符合检测信号监控功能的条件
ONLINE 设备处于在线状态
OFFLINE 设备处于离线状态

KioskAppStatusReport

设备的自助服务终端应用状态报告。

  • 适用于自助服务终端
  • 此字段会提供自助服务终端设备上运行的应用 ID 和版本号,以及报告上次更新时间的时间戳
  • 此字段的数据通过政策控制:ReportDeviceSessionStatus
  • 数据收集频率:仅在上传时
  • 默认数据报告频率:3 小时
    • 受政策控制:是
  • 缓存:如果设备处于离线状态,则收集的数据存储在本地,并在设备下次联网时报告:否
  • 仅为关联用户报告:不适用
  • 所需的细化权限:TELEMETRY_API_APPS_REPORT
JSON 表示法
{
  "reportTime": string,
  "appId": string,
  "appVersion": string
}
字段
reportTime

string (Timestamp format)

收集报告的时间戳

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

appId

string

自助服务终端应用的应用 ID(例如“mdmkkicfmmkgmpkmkdikhlbggogpicma”)

appVersion

string

自助服务终端应用的应用版本号,例如“1.10.118”

RuntimeCountersReport

从 CPU 检索的运行时计数器。目前,只有第 14 代及以上版本的 Intel vPro PSR 支持运行时计数器遥测。

JSON 表示法
{
  "reportTime": string,
  "uptimeRuntimeDuration": string,
  "enterSleepCount": string,
  "enterHibernationCount": string,
  "enterPoweroffCount": string
}
字段
reportTime

string (Timestamp format)

收集报告的时间戳。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

uptimeRuntimeDuration

string (Duration format)

总生命周期运行时。目前始终采用 Intel vPro PSR 的 S0 运行时。

此时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

enterSleepCount

string (int64 format)

设备进入休眠状态的次数。目前通过 PSR 获取,从 S0 到 S3 的计数。

enterHibernationCount

string (int64 format)

设备进入休眠状态的次数。目前通过 PSR 获取,从 S0 到 S4 的计数。

enterPoweroffCount

string (int64 format)

设备进入关机状态的次数。目前通过 PSR 获取,从 S0 到 S5 的计数。

方法

get

获取遥测设备。

list

列出所有遥测设备。