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)
    }
  ],
  "appReport": [
    {
      object (AppReport)
    }
  ],
  "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 的降序排序。

appReport[]

object (AppReport)

仅限输出。定期收集的应用报告按 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

仅限输出。是否已配置 Key Locker。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 标签。示例:Core 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 内存加密算法使用 AES_XTS 加密算法,并采用 128 位分组加密。
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

仅限输出。网络连接 GUID。

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 映像的新平台版本。只有当更新状态为 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)

仅限输出。电池剩余容量(毫安小时)。

temperature

integer

仅限输出。温度(摄氏度)。

dischargeRate

integer

仅限输出。电池放电速率(毫瓦)。如果电池正在放电,则为正值;如果电池正在充电,则为负值。

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

列出所有遥测设备。