- 资源:TelemetryDevice
- CpuInfo
- 架构
- CpuStatusReport
- CpuTemperatureInfo
- MemoryInfo
- TotalMemoryEncryptionInfo
- MemoryEncryptionState
- MemoryEncryptionAlgorithm
- MemoryStatusReport
- NetworkInfo
- NetworkDevice
- NetworkDeviceType
- NetworkStatusReport
- NetworkType
- NetworkDiagnosticsReport
- OsUpdateStatus
- UpdateState
- GraphicsInfo
- GraphicsAdapterInfo
- DisplayDevice
- TouchScreenInfo
- TouchScreenDevice
- GraphicsStatusReport
- DisplayInfo
- BatteryInfo
- BatteryStatusReport
- BatterySampleReport
- BatteryHealth
- StorageInfo
- DiskVolume
- StorageStatusReport
- DiskInfo
- ThunderboltInfo
- ThunderboltSecurityLevel
- BootPerformanceReport
- ShutdownReason
- HeartbeatStatusReport
- 状态
- KioskAppStatusReport
- RuntimeCountersReport
- 方法
资源:TelemetryDevice
从受管设备收集的遥测数据。
- 所需精细化权限:TELEMETRY_API_DEVICE
| JSON 表示法 |
|---|
{ "name": string, "customer": string, "orgUnitId": string, "deviceId": string, "serialNumber": string, "cpuInfo": [ { object ( |
| 字段 | |
|---|---|
name |
仅限输出。设备的资源名称。 |
customer |
仅限输出。Google Workspace 客户,其企业已注册相应设备。 |
orgUnitId |
仅限输出。设备的组织部门 ID。 |
deviceId |
仅限输出。设备的唯一 Directory API ID。此值与“ChromeOS 设备”标签页中管理控制台的 Directory API ID 相同 |
serialNumber |
仅限输出。设备序列号。此值与 ChromeOS 设备标签页中管理控制台的序列号相同。 |
cpuInfo[] |
仅限输出。与设备 CPU 规格相关的信息。 |
cpuStatusReport[] |
仅限输出。定期收集的 CPU 状态报告,按 |
memoryInfo |
仅限输出。有关设备内存规格的信息。 |
memoryStatusReport[] |
仅限输出。定期收集的内存状态报告,按 |
networkInfo |
仅限输出。网络设备信息。 |
networkStatusReport[] |
仅限输出。定期收集网络规范。 |
networkDiagnosticsReport[] |
仅限输出。定期收集网络诊断数据。 |
osUpdateStatus[] |
仅限输出。包含有关 ChromeOS 更新状态的相关信息。 |
graphicsInfo |
仅限输出。包含有关设备图形外围设备的信息。 |
graphicsStatusReport[] |
仅限输出。定期收集的图形报告。 |
batteryInfo[] |
仅限输出。有关设备电池规格的信息。 |
batteryStatusReport[] |
仅限输出。定期收集电池报告。 |
storageInfo |
仅限输出。设备存储规格信息。 |
storageStatusReport[] |
仅限输出。定期收集的存储空间报告。 |
thunderboltInfo[] |
仅限输出。有关 Thunderbolt 总线的信息。 |
audioStatusReport[] |
仅限输出。定期收集的音频报告,按 |
bootPerformanceReport[] |
仅限输出。设备的启动性能报告。 |
heartbeatStatusReport[] |
仅限输出。包含时间戳的检测信号状态报告,时间戳按 |
kioskAppStatusReport[] |
仅限输出。自助服务终端设备的自助服务终端应用状态报告 |
networkBandwidthReport[] |
仅限输出。定期收集的网络带宽报告,按 |
peripheralsReport[] |
仅限输出。定期收集的外围设备报告,按 |
appReport[] |
仅限输出。定期收集的应用报告,按 |
runtimeCountersReport[] |
仅限输出。运行时计数器报告收集了设备生命周期运行时,以及 S0->S3、S0->S4 和 S0->S5 转换的次数,这意味着进入睡眠、休眠和关机状态 |
CpuInfo
设备的 CPU 规格
- 此字段提供设备信息,这些信息是静态的,不会随时间变化。
- 此字段的数据通过政策 ReportDeviceCpuInfo 进行控制
- 数据收集频率:仅在上传时
- 默认数据报告频率:3 小时
- 受政策控制:是
- 缓存:如果设备处于离线状态,收集的数据会存储在本地,并在设备下次联网时报告:否
- 仅针对关联用户报告:不适用
- 所需精细化权限:TELEMETRY_API_CPU_INFO
| JSON 表示法 |
|---|
{
"model": string,
"architecture": enum ( |
| 字段 | |
|---|---|
model |
仅限输出。CPU 型号名称。示例:Intel(R) Core(TM) i5-8250U CPU (1.60GHz) |
architecture |
仅限输出。CPU 的架构类型。
|
maxClockSpeed |
仅限输出。最大 CPU 时钟速度(以 kHz 为单位)。 |
keylockerSupported |
仅限输出。是否支持 Key Locker。 |
keylockerConfigured |
仅限输出。是否已配置 Key Locker。 |
架构
CPU 的架构类型。
| 枚举 | |
|---|---|
ARCHITECTURE_UNSPECIFIED |
架构未知。 |
X64 |
x64 架构 |
CpuStatusReport
提供有关 CPU 状态的信息。
- 此字段是遥测信息,会随着设备的使用而随时间变化。
- 此字段的数据通过政策 ReportDeviceCpuInfo 进行控制
- 数据收集频率:每 10 分钟一次
- 默认数据报告频率:3 小时
- 受政策控制:是
- 缓存:如果设备处于离线状态,收集的数据会存储在本地,并在设备下次联网时报告:否
- 仅针对关联用户报告:不适用
- 所需精细权限:TELEMETRY_API_CPU_REPORT
| JSON 表示法 |
|---|
{
"reportTime": string,
"sampleFrequency": string,
"cpuUtilizationPct": integer,
"cpuTemperatureInfo": [
{
object ( |
| 字段 | |
|---|---|
reportTime |
仅限输出。表示此报告的抽样时间的时间戳(以毫秒为单位)。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
sampleFrequency |
仅限输出。报告的抽样频率。 该时长以秒为单位,最多包含九个小数位,以“ |
cpuUtilizationPct |
仅限输出。CPU 利用率(0-100%)的样本。 |
cpuTemperatureInfo[] |
仅限输出。每个 CPU 内核的 CPU 温度样本信息(以摄氏度为单位) |
CpuTemperatureInfo
设备的 CPU 温度。以摄氏度为单位,按 CPU 核心进行采样。
- 此字段是遥测信息,会随着设备的使用而随时间变化。
- 此字段的数据通过政策 ReportDeviceCpuInfo 进行控制
- 数据收集频率:每 10 分钟一次
- 默认数据报告频率:3 小时
- 受政策控制:是
- 缓存:如果设备处于离线状态,收集的数据会存储在本地,并在设备下次联网时报告:否
- 仅针对关联用户报告:不适用
| JSON 表示法 |
|---|
{ "temperatureCelsius": integer, "label": string } |
| 字段 | |
|---|---|
temperatureCelsius |
仅限输出。CPU 温度(以摄氏度为单位)。 |
label |
仅限输出。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 ( |
| 字段 | |
|---|---|
totalRamBytes |
仅限输出。总 RAM(以字节为单位)。 |
availableRamBytes |
仅限输出。可用 RAM 的量(以字节为单位)。 |
totalMemoryEncryption |
仅限输出。设备的总内存加密信息。 |
TotalMemoryEncryptionInfo
设备的内存加密信息。
- 此字段提供设备信息,这些信息是静态的,不会随时间变化。
- 此字段的数据通过政策 ReportDeviceMemoryInfo 进行控制
- 数据收集频率:在设备启动时
- 默认数据报告频率:在设备启动时
- 受政策控制:是
- 缓存:如果设备处于离线状态,收集的数据会存储在本地,并在设备下次联网时报告:是
- 仅针对关联用户报告:不适用
| JSON 表示法 |
|---|
{ "encryptionState": enum ( |
| 字段 | |
|---|---|
encryptionState |
设备上内存加密的状态。 |
maxKeys |
可用于加密的密钥数量上限。 |
keyLength |
加密密钥的长度。 |
encryptionAlgorithm |
内存加密算法。 |
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 |
内存加密算法使用 AES_XTS 加密算法,并采用 256 位分组加密。 |
MemoryStatusReport
包含内存状态报告的示例。
- 此字段是遥测信息,会随着设备的使用而随时间变化。
- 此字段的数据通过政策 ReportDeviceMemoryInfo 进行控制
- 数据收集频率:仅在上传时,每 10 分钟收集一次 SystemRamFreeByes
- 默认数据报告频率:每 3 小时一次
- 受政策控制:是
- 缓存:如果设备处于离线状态,收集的数据会存储在本地,并在设备下次联网时报告:否
- 仅针对关联用户报告:不适用
- 所需的精细权限:TELEMETRY_API_MEMORY_REPORT
| JSON 表示法 |
|---|
{ "reportTime": string, "sampleFrequency": string, "systemRamFreeBytes": string, "pageFaults": integer } |
| 字段 | |
|---|---|
reportTime |
仅限输出。表示此报告的抽样时间的时间戳(以毫秒为单位)。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
sampleFrequency |
仅限输出。报告的抽样频率。 该时长以秒为单位,最多包含九个小数位,以“ |
systemRamFreeBytes |
仅限输出。可用 RAM 的数量(以字节为单位,由于垃圾回收而不可靠)。 |
pageFaults |
仅限输出。相应收集期间的页面错误数 |
NetworkInfo
网络设备信息。
- 此字段提供设备信息,这些信息是静态的,不会随时间变化。
- 此字段的数据通过政策 ReportNetworkDeviceConfiguration 进行控制
- 数据收集频率:在设备启动时
- 默认数据报告频率:在设备启动时
- 受政策控制:是
- 缓存:如果设备处于离线状态,收集的数据会存储在本地,并在设备下次联网时报告:是
- 仅针对关联用户报告:不适用
- 所需精细化权限:TELEMETRY_API_NETWORK_INFO
| JSON 表示法 |
|---|
{
"networkDevices": [
{
object ( |
| 字段 | |
|---|---|
networkDevices[] |
仅限输出。网络设备列表。 |
NetworkDevice
有关网络设备的详细信息。
- 此字段提供设备信息,这些信息是静态的,不会随时间变化。
- 此字段的数据通过政策 ReportNetworkDeviceConfiguration 进行控制
- 数据收集频率:在设备启动时
- 默认数据报告频率:在设备启动时
- 受政策控制:是
- 缓存:如果设备处于离线状态,收集的数据会存储在本地,并在设备下次联网时报告:是
- 仅针对关联用户报告:不适用
| JSON 表示法 |
|---|
{
"type": enum ( |
| 字段 | |
|---|---|
type |
仅限输出。网络设备类型。 |
macAddress |
仅限输出。相应网络设备的 MAC 地址(如适用)。 |
meid |
仅限输出。相应网络设备的 MEID(如适用)。 |
imei |
仅限输出。相应网络设备的 IMEI(如适用)。 |
iccid |
仅限输出。与设备的 SIM 卡关联的集成电路卡 ID。 |
mdn |
仅限输出。与设备的 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 ( |
| 字段 | |
|---|---|
reportTime |
仅限输出。报告网络状态的时间。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
sampleFrequency |
仅限输出。报告的抽样频率。 该时长以秒为单位,最多包含九个小数位,以“ |
signalStrengthDbm |
仅限输出。无线网络的信号强度(以分贝为单位)。 |
lanIpAddress |
仅限输出。LAN IP 地址。 |
gatewayIpAddress |
仅限输出。网关 IP 地址。 |
transmissionBitRateMbps |
仅限输出。传输比特率(以每秒兆比特为单位)。 |
receivingBitRateMbps |
仅限输出。接收比特率(以每秒兆比特为单位)。 |
transmissionPowerDbm |
仅限输出。传输功率(以分贝为单位)。 |
encryptionOn |
仅限输出。Wi-Fi 加密密钥是否已关闭。 |
wifiLinkQuality |
仅限输出。Wi-Fi 连接质量。值的范围为 [0, 70]。0 表示没有信号,70 表示信号强。 |
wifiPowerManagementEnabled |
仅限输出。已启用 Wi-Fi 电源管理 |
guid |
仅限输出。网络连接 GUID。 |
connectionState |
仅限输出。网络的当前连接状态。 |
connectionType |
仅限输出。网络连接类型。 |
ipv6Address[] |
仅限输出。分配给相应网络的 IPv6 地址(如有)。每个地址都是采用标准 IPv6 文本表示形式(例如“2001:db8::1”)的字符串。 |
gatewayIpv6Address |
仅限输出。相应接口的网关 IPv6(如果检测到) |
metered |
仅限输出。网络是否被检测为按流量计费。 |
linkDownSpeedKbps |
仅限输出。网络接口或连接报告的最大下行带宽(以千位/秒 [Kbps] 为单位)。 |
NetworkType
网络连接类型。
| 枚举 | |
|---|---|
NETWORK_TYPE_UNSPECIFIED |
未指定网络连接类型 |
CELLULAR |
移动网络连接。 |
ETHERNET |
以太网网络连接。 |
TETHER |
网络共享网络连接。 |
VPN |
VPN 网络连接。 |
WIFI |
Wi-Fi 网络连接。 |
NetworkDiagnosticsReport
网络测试结果,用于确定设备网络连接的健康状况,例如 HTTPS 延迟是高还是正常。
- 所需精细权限:TELEMETRY_API_NETWORK_REPORT
| JSON 表示法 |
|---|
{
"reportTime": string,
"httpsLatencyData": {
object ( |
| 字段 | |
|---|---|
reportTime |
仅限输出。收集诊断数据时的时间戳。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
httpsLatencyData |
仅限输出。HTTPS 延迟时间测试数据。 |
OsUpdateStatus
包含有关当前操作系统更新状态的信息。
- 此字段是遥测信息,会随着设备的使用而随时间变化。
- 此字段的数据通过以下政策进行控制:ReportDeviceOsUpdateStatus
- 数据收集频率:仅在上传时
- 默认数据报告频率:3 小时
- 受政策控制:是
- 缓存:如果设备处于离线状态,收集的数据会存储在本地,并在设备下次联网时报告:否
- 仅针对关联用户报告:不适用
- 所需精细权限:TELEMETRY_API_OS_REPORT
| JSON 表示法 |
|---|
{
"updateState": enum ( |
| 字段 | |
|---|---|
updateState |
仅限输出。操作系统更新的当前状态。 |
newPlatformVersion |
仅限输出。正在下载并应用操作系统映像的新平台版本。仅当更新状态为 OS_IMAGE_DOWNLOAD_IN_PROGRESS 或 OS_UPDATE_NEED_REBOOT 时设置。请注意,在某些极端情况下,对于 OS_UPDATE_NEED_REBOOT 状态,这可能是虚拟的“0.0.0.0”,例如,更新引擎在未重启的情况下重启。 |
newRequestedPlatformVersion |
仅限输出。待更新的自助服务终端应用请求的新平台版本。 |
lastUpdateTime |
仅限输出。上次成功更新的时间戳。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
lastUpdateCheckTime |
仅限输出。上次更新检查的时间戳。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
lastRebootTime |
仅限输出。上次重新启动的时间戳。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
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 ( |
| 字段 | |
|---|---|
adapterInfo |
仅限输出。有关显卡 (GPU) 的信息。 |
eprivacySupported |
仅限输出。是否支持电子隐私屏幕。 |
displayDevices[] |
仅限输出。与设备显示屏相关的信息。 |
touchScreenInfo |
仅限输出。有关设备内部触摸屏的信息。 |
GraphicsAdapterInfo
显卡 (GPU) 的信息。
| JSON 表示法 |
|---|
{ "adapter": string, "driverVersion": string, "deviceId": string } |
| 字段 | |
|---|---|
adapter |
仅限输出。适配器名称。示例:Mesa DRI Intel(R) UHD Graphics 620 (Kabylake GT2)。 |
driverVersion |
仅限输出。GPU 驱动程序的版本。 |
deviceId |
仅限输出。表示显卡设备 ID。 |
DisplayDevice
显示设备的信息。
| JSON 表示法 |
|---|
{ "displayName": string, "displayWidthMm": integer, "displayHeightMm": integer, "internal": boolean, "manufacturerId": string, "modelId": integer, "manufactureYear": integer, "serialNumber": integer, "edidVersion": string } |
| 字段 | |
|---|---|
displayName |
仅限输出。显示设备名称。 |
displayWidthMm |
仅限输出。显示宽度(以毫米为单位)。 |
displayHeightMm |
仅限输出。显示屏高度(以毫米为单位)。 |
internal |
仅限输出。显示屏是否为内部显示屏。 |
manufacturerId |
仅限输出。三字母制造商 ID。 |
modelId |
仅限输出。制造商产品代码。 |
manufactureYear |
仅限输出。制造年份。 |
serialNumber |
仅限输出。序列号。 |
edidVersion |
仅限输出。EDID 版本。 |
TouchScreenInfo
设备触摸屏上的信息。
| JSON 表示法 |
|---|
{
"touchpadLibrary": string,
"devices": [
{
object ( |
| 字段 | |
|---|---|
touchpadLibrary |
仅限输出。输入堆栈使用的触控板库名称。 |
devices[] |
仅限输出。内部触摸屏设备的列表。 |
TouchScreenDevice
内部触摸屏设备的信息。
| JSON 表示法 |
|---|
{ "displayName": string, "touchPointCount": integer, "stylusCapable": boolean } |
| 字段 | |
|---|---|
displayName |
仅限输出。触摸屏设备显示名称。 |
touchPointCount |
仅限输出。设备上支持的触控点数量。 |
stylusCapable |
仅限输出。触摸屏设备是否支持触控笔。 |
GraphicsStatusReport
图形子系统的信息。
- 此字段是遥测信息,会随着设备的使用而随时间变化。
- 此字段的数据通过政策 ReportDeviceGraphicsInfo 进行控制
- 数据收集频率:3 小时。
- 默认数据报告频率:3 小时
- 受政策控制:是
- 缓存:如果设备处于离线状态,收集的数据会存储在本地,并在设备下次联网时报告:否
- 仅针对关联用户报告:不适用
- 所需精细权限:TELEMETRY_API_GRAPHICS_REPORT
| JSON 表示法 |
|---|
{
"reportTime": string,
"displays": [
{
object ( |
| 字段 | |
|---|---|
reportTime |
仅限输出。报告图形数据的时间。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
displays[] |
仅限输出。有关设备显示屏的信息。 |
DisplayInfo
显示屏的相关信息。
| JSON 表示法 |
|---|
{ "deviceId": string, "resolutionWidth": integer, "resolutionHeight": integer, "refreshRate": integer, "isInternal": boolean, "displayName": string, "serialNumber": integer, "edidVersion": string } |
| 字段 | |
|---|---|
deviceId |
仅限输出。表示显卡设备 ID。 |
resolutionWidth |
仅限输出。分辨率宽度(以像素为单位)。 |
resolutionHeight |
仅限输出。分辨率高度(以像素为单位)。 |
refreshRate |
仅限输出。刷新率(以 Hz 为单位)。 |
isInternal |
仅限输出。指示显示屏是否为内部显示屏。 |
displayName |
仅限输出。显示设备名称。 |
serialNumber |
仅限输出。序列号。 |
edidVersion |
仅限输出。EDID 版本。 |
BatteryInfo
电池相关信息。
- 此字段提供设备信息,这些信息是静态的,不会随时间变化。
- 此字段的数据通过政策 ReportDevicePowerStatus 进行控制
- 数据收集频率:仅在上传时
- 默认数据报告频率:3 小时
- 受政策控制:是
- 缓存:如果设备处于离线状态,收集的数据会存储在本地,并在设备下次联网时报告:否
- 仅针对关联用户报告:不适用
- 所需精细化权限:TELEMETRY_API_BATTERY_INFO
| JSON 表示法 |
|---|
{
"serialNumber": string,
"manufacturer": string,
"designCapacity": string,
"designMinVoltage": integer,
"manufactureDate": {
object ( |
| 字段 | |
|---|---|
serialNumber |
仅限输出。电池序列号。 |
manufacturer |
仅限输出。电池制造商。 |
designCapacity |
仅限输出。设计容量(毫安时)。 |
designMinVoltage |
仅限输出。设计的最低输出电压(毫伏) |
manufactureDate |
仅限输出。电池的制造日期。 |
technology |
仅限输出。电池技术。示例:Li-ion |
BatteryStatusReport
电池的状态数据。
- 此字段是遥测信息,会随着设备的使用而随时间变化。
- 此字段的数据通过政策 ReportDevicePowerStatus 进行控制
- 数据收集频率:仅在上传时
- 默认数据报告频率:3 小时
- 受政策控制:是
- 缓存:如果设备处于离线状态,收集的数据会存储在本地,并在设备下次联网时报告:否
- 仅针对关联用户报告:不适用
- 所需精细权限:TELEMETRY_API_BATTERY_REPORT
| JSON 表示法 |
|---|
{ "reportTime": string, "serialNumber": string, "sample": [ { object ( |
| 字段 | |
|---|---|
reportTime |
仅限输出。在设备上收集样本时的时间戳 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
serialNumber |
仅限输出。电池序列号。 |
sample[] |
仅限输出。按 |
batteryHealth |
仅限输出。电池健康度。 |
fullChargeCapacity |
仅限输出。满电容量(毫安时)。 |
cycleCount |
仅限输出。循环次数。 |
BatterySampleReport
电池的抽样数据。
- 此字段是遥测信息,会随着设备的使用而随时间变化。
- 此字段的数据通过政策 ReportDevicePowerStatus 进行控制
- 数据收集频率:仅在上传时
- 默认数据报告频率:3 小时
- 受政策控制:是
- 缓存:如果设备处于离线状态,收集的数据会存储在本地,并在设备下次联网时报告:否
- 仅针对关联用户报告:不适用
| JSON 表示法 |
|---|
{ "reportTime": string, "voltage": string, "remainingCapacity": string, "temperature": integer, "dischargeRate": integer, "chargeRate": integer, "current": string, "status": string } |
| 字段 | |
|---|---|
reportTime |
仅限输出。在设备上收集样本时的时间戳 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
voltage |
仅限输出。电池电压(毫伏)。 |
remainingCapacity |
仅限输出。电池剩余容量(毫安时)。 |
temperature |
仅限输出。温度(摄氏度)。 |
dischargeRate |
仅限输出。电池放电速率(毫瓦)。如果电池正在放电,则为正值;如果电池正在充电,则为负值。 |
chargeRate |
仅限输出。电池电量百分比。 |
current |
仅限输出。电池电流(毫安)。 |
status |
仅限输出。从 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 ( |
| 字段 | |
|---|---|
volume[] |
磁盘卷的相关信息 |
availableDiskBytes |
设备上可用于存储用户数据的空间(以字节为单位)。 |
totalDiskBytes |
设备中用于存储用户数据的总空间(以字节为单位)。 |
DiskVolume
磁盘卷的相关信息
| JSON 表示法 |
|---|
{ "volumeId": string, "storageFreeBytes": string, "storageTotalBytes": string } |
| 字段 | |
|---|---|
volumeId |
磁盘卷 ID。 |
storageFreeBytes |
可用存储空间(以字节为单位)。 |
storageTotalBytes |
总存储空间(以字节为单位)。 |
StorageStatusReport
存储空间的状态数据。
- 此字段是遥测信息,会随着设备的使用而随时间变化。
- 此字段的数据通过以下政策进行控制:ReportDeviceStorageStatus
- 数据收集频率:仅在上传时
- 默认数据报告频率:3 小时
- 受政策控制:是
- 缓存:如果设备处于离线状态,收集的数据会存储在本地,并在设备下次联网时报告:否
- 仅针对关联用户报告:不适用
- 所需精细化权限:TELEMETRY_API_STORAGE_REPORT
| JSON 表示法 |
|---|
{
"reportTime": string,
"disk": [
{
object ( |
| 字段 | |
|---|---|
reportTime |
仅限输出。在设备上收集样本时的时间戳 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
disk[] |
仅限输出。磁盘上的报告。 |
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 |
仅限输出。磁盘序列号。 |
manufacturer |
仅限输出。磁盘制造商。 |
model |
仅限输出。磁盘型号。 |
sizeBytes |
仅限输出。磁盘大小。 |
type |
仅限输出。磁盘类型:eMMC / NVMe / ATA / SCSI。 |
health |
仅限输出。磁盘健康状况。 |
volumeIds[] |
仅限输出。磁盘卷。 |
bytesReadThisSession |
仅限输出。自上次启动以来读取的字节数。 |
bytesWrittenThisSession |
仅限输出。自上次启动以来写入的字节数。 |
readTimeThisSession |
仅限输出。自上次启动以来,从磁盘读取数据所用的时间。 该时长以秒为单位,最多包含九个小数位,以“ |
writeTimeThisSession |
仅限输出。自上次启动以来,写入磁盘所用的时间。 该时长以秒为单位,最多包含九个小数位,以“ |
ioTimeThisSession |
仅限输出。统计磁盘和队列处于繁忙状态的时间,因此与上述字段不同,并行请求不会被多次统计。 该时长以秒为单位,最多包含九个小数位,以“ |
discardTimeThisSession |
仅限输出。自上次启动以来,丢弃所花费的时间。舍弃是指写入不再使用的空白块。在内核 4.18 及更高版本上受支持。 该时长以秒为单位,最多包含九个小数位,以“ |
ThunderboltInfo
雷雳总线信息。
- 此字段提供设备信息,这些信息是静态的,不会随时间变化。
- 此字段的数据通过政策 ReportDeviceSecurityStatus 进行控制
- 数据收集频率:在设备启动时
- 默认数据报告频率:在设备启动时
- 受政策控制:否
- 缓存:如果设备处于离线状态,收集的数据会存储在本地,并在设备下次联网时报告:是
- 仅针对关联用户报告:不适用
- 所需的精细化权限:TELEMETRY_API_BUS_DEVICE_INFO
| JSON 表示法 |
|---|
{
"securityLevel": enum ( |
| 字段 | |
|---|---|
securityLevel |
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 控制器和 Display Port 创建隧道。移除了基座下游的所有 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 ( |
| 字段 | |
|---|---|
bootUpDuration |
启动所用总时间。 该时长以秒为单位,最多包含九个小数位,以“ |
bootUpTime |
开机时的时间戳。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
shutdownDuration |
从关闭开始到关机所用的总时间。 该时长以秒为单位,最多包含九个小数位,以“ |
shutdownTime |
关机时的时间戳。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
shutdownReason |
关停原因。 |
reportTime |
收集报告时的时间戳。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
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 ( |
| 字段 | |
|---|---|
reportTime |
检测到状态变化时的时间戳 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
state |
设备更改为的状态 |
州
设备状态
| 枚举 | |
|---|---|
STATE_UNSPECIFIED |
未指定状态 |
UNKNOWN |
设备不符合使用心跳监控功能的条件 |
ONLINE |
设备处于在线状态 |
OFFLINE |
设备处于离线状态 |
DEVICE_OUTDATED |
设备版本过旧 |
KioskAppStatusReport
设备的自助服务终端应用状态报告。
- 适用于自助服务终端
- 此字段提供在信息亭设备上运行的应用 ID 和版本号,以及报告上次更新的时间戳
- 此字段的数据通过以下政策进行控制:ReportDeviceSessionStatus
- 数据收集频率:仅在上传时
- 默认数据报告频率:3 小时
- 受政策控制:是
- 缓存:如果设备处于离线状态,收集的数据会存储在本地,并在设备下次联网时报告:否
- 仅针对关联用户报告:不适用
- 所需精细化权限:TELEMETRY_API_APPS_REPORT
| JSON 表示法 |
|---|
{ "reportTime": string, "appId": string, "appVersion": string } |
| 字段 | |
|---|---|
reportTime |
报告收集时间的时间戳 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
appId |
自助服务终端应用的 ID,例如“mdmkkicfmmkgmpkmkdikhlbggogpicma” |
appVersion |
自助服务终端应用的 app 版本号,例如“1.10.118” |
RuntimeCountersReport
从 CPU 检索的运行时计数器。目前,运行时计数器遥测仅受第 14 代及更高版本的 Intel vPro PSR 支持。
| JSON 表示法 |
|---|
{ "reportTime": string, "uptimeRuntimeDuration": string, "enterSleepCount": string, "enterHibernationCount": string, "enterPoweroffCount": string } |
| 字段 | |
|---|---|
reportTime |
收集报告时的时间戳。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例: |
uptimeRuntimeDuration |
总生命周期运行时长。目前始终是 Intel vPro PSR 的 S0 运行时。 该时长以秒为单位,最多包含九个小数位,以“ |
enterSleepCount |
设备进入休眠状态的次数。目前通过 PSR 获取,从 S0 到 S3 的计数。 |
enterHibernationCount |
设备进入休眠状态的次数。目前通过 PSR 获取,从 S0 到 S4 的计数。 |
enterPoweroffCount |
设备进入关机状态的次数。目前通过 PSR 获取,从 S0 到 S5 的计数。 |
方法 |
|
|---|---|
|
获取遥测设备。 |
|
列出所有遥测设备。 |