切换深色模式
平台扩展 API
本页列出当前版本的完整方法及字段。方法通过 gRPC / gRPC-Web 调用；REST 注解不表示已部署 REST Gateway。
“必填：按业务校验”表示 proto3 未声明 required，不代表留空一定可用。UUID、EUI、权限、资源存在性与字段组合由服务端校验。嵌套结构详见页末消息结构。
AlinkwiseService
ListTenantDevices
接口名称： api.AlinkwiseService/ListTenantDevices
功能： 列出 TenantDevices。ListTenantDevices returns a tenant-level device list with server-side filtering, sorting, and pagination.
请求： api.ListTenantDevicesRequest；返回： api.ListTenantDevicesResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
limit | uint32 | 按业务校验 | 本次最多返回条数。 Max number of devices to return in the result-set. |
offset | uint32 | 按业务校验 | 分页起始偏移。 Offset in the result-set. |
tenant_id | string | 按业务校验 | 租户 UUID。 Tenant ID (UUID) to filter devices on. |
application_id | string | 按业务校验 | 应用 UUID。 Optional application ID (UUID). |
device_profile_id | string | 按业务校验 | 终端模版 UUID。 Optional device-profile ID (UUID). |
search | string | 按业务校验 | 搜索关键字。 Optional search over device, application, and device-profile name. |
online_state | api.ListTenantDevicesRequest.OnlineState {ALL=0, ONLINE=1, OFFLINE=2, NEVER_SEEN=3, DISABLED=4} | 按业务校验 | Optional online-state filter. |
order_by | api.ListTenantDevicesRequest.OrderBy {NAME=0, DEV_EUI=1, LAST_SEEN_AT=2, DEVICE_PROFILE_NAME=3, APPLICATION_NAME=4, CREATED_AT=5, UPDATED_AT=6} | 按业务校验 | Sorting field. |
order_by_desc | bool | 按业务校验 | Sorting direction. |
tags | map<string, string> | 按业务校验 | 自定义字符串标签。 Tags to filter devices on. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
total_count | uint32 | 按业务校验 | 符合条件的总条数。 |
result | repeated api.TenantDeviceListItem | 按业务校验 | 结果列表或结果内容。 |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
GetLicenseInfo
接口名称： api.AlinkwiseService/GetLicenseInfo
功能： 查询 LicenseInfo。GetLicenseInfo returns the current machine serial and applied offline license status.
请求： api.GetLicenseInfoRequest；返回： api.GetLicenseInfoResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
info_json | string | 按业务校验 | 信息 JSON 字符串。 JSON encoded license status payload. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
ApplyLicense
接口名称： api.AlinkwiseService/ApplyLicense
功能： 应用 License。ApplyLicense verifies and stores an offline license for this machine.
请求： api.ApplyLicenseRequest；返回： api.ApplyLicenseResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
license | string | 按业务校验 | 离线许可证。 Offline license text. First version accepts ALW1.<jwt> or raw JWT. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
info_json | string | 按业务校验 | 信息 JSON 字符串。 JSON encoded license status payload after applying. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
GetOperationsRules
接口名称： api.AlinkwiseService/GetOperationsRules
功能： 查询 OperationsRules。GetOperationsRules returns persisted operation-center alert rules for a tenant.
请求： api.GetOperationsRulesRequest；返回： api.GetOperationsRulesResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
tenant_id | string | 按业务校验 | 租户 UUID。 |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
rules_json | string | 按业务校验 | 规则 JSON 字符串。 JSON encoded operation-center alert rules. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
UpdateOperationsRules
接口名称： api.AlinkwiseService/UpdateOperationsRules
功能： 更新 OperationsRules。UpdateOperationsRules stores operation-center alert rules for a tenant.
请求： api.UpdateOperationsRulesRequest；返回： api.UpdateOperationsRulesResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
tenant_id | string | 按业务校验 | 租户 UUID。 |
rules_json | string | 按业务校验 | 规则 JSON 字符串。 JSON encoded operation-center alert rules. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
rules_json | string | 按业务校验 | 规则 JSON 字符串。 JSON encoded normalized operation-center alert rules. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
GetOperationsSnapshot
接口名称： api.AlinkwiseService/GetOperationsSnapshot
功能： 查询 OperationsSnapshot。GetOperationsSnapshot calculates operation diagnostics, alerts, health, and report.
请求： api.GetOperationsSnapshotRequest；返回： api.GetOperationsSnapshotResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
tenant_id | string | 按业务校验 | 租户 UUID。 |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
snapshot_json | string | 按业务校验 | JSON encoded operation-center diagnostics, alerts, health scores, and report. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
CreateAuditLog
接口名称： api.AlinkwiseService/CreateAuditLog
功能： 创建 AuditLog。CreateAuditLog stores one Alinkwise operation audit record.
请求： api.CreateAuditLogRequest；返回： api.CreateAuditLogResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
action | string | 按业务校验 | 消息定义未补充字段说明。 |
target_type | string | 按业务校验 | 消息定义未补充字段说明。 |
target_id | string | 按业务校验 | 消息定义未补充字段说明。 |
target_name | string | 按业务校验 | 消息定义未补充字段说明。 |
tenant_id | string | 按业务校验 | 租户 UUID。 |
result | string | 按业务校验 | 结果列表或结果内容。 |
detail_json | string | 按业务校验 | 消息定义未补充字段说明。 |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
log_json | string | 按业务校验 | 消息定义未补充字段说明。 |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
ListAuditLogs
接口名称： api.AlinkwiseService/ListAuditLogs
功能： 列出 AuditLogs。ListAuditLogs returns recent Alinkwise operation audit records.
请求： api.ListAuditLogsRequest；返回： api.ListAuditLogsResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
limit | uint32 | 按业务校验 | 本次最多返回条数。 |
offset | uint32 | 按业务校验 | 分页起始偏移。 |
search | string | 按业务校验 | 搜索关键字。 |
action | string | 按业务校验 | 消息定义未补充字段说明。 |
target_type | string | 按业务校验 | 消息定义未补充字段说明。 |
result | string | 按业务校验 | 结果列表或结果内容。 |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
logs_json | string | 按业务校验 | 消息定义未补充字段说明。 |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
GetAiAssistantStatus
接口名称： api.AlinkwiseService/GetAiAssistantStatus
功能： 查询 AiAssistantStatus。GetAiAssistantStatus returns sanitized AI assistant configuration status.
请求： api.GetAiAssistantStatusRequest；返回： api.GetAiAssistantStatusResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
status_json | string | 按业务校验 | 消息定义未补充字段说明。 |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
TestAiAssistant
接口名称： api.AlinkwiseService/TestAiAssistant
功能： 测试 AiAssistant。TestAiAssistant verifies the configured AI provider. Only global admins can use it.
请求： api.TestAiAssistantRequest；返回： api.TestAiAssistantResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
result_json | string | 按业务校验 | 消息定义未补充字段说明。 |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
GenerateAiConfigDraft
接口名称： api.AlinkwiseService/GenerateAiConfigDraft
功能： 生成 AiConfigDraft。GenerateAiConfigDraft asks the AI assistant to generate a configuration draft.
请求： api.GenerateAiConfigDraftRequest；返回： api.GenerateAiConfigDraftResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
tenant_id | string | 按业务校验 | 租户 UUID。 |
scenario | string | 按业务校验 | 消息定义未补充字段说明。 |
user_prompt | string | 按业务校验 | 消息定义未补充字段说明。 |
context_json | string | 按业务校验 | 消息定义未补充字段说明。 |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
draft_json | string | 按业务校验 | 消息定义未补充字段说明。 |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
ClearGatewayFrameLog
接口名称： api.AlinkwiseService/ClearGatewayFrameLog
功能： 清空 GatewayFrameLog。ClearGatewayFrameLog clears the cached Redis frame log for one gateway.
请求： api.ClearGatewayFrameLogRequest；返回： api.ClearGatewayFrameLogResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
gateway_id | string | 按业务校验 | 网关 EUI。 Gateway ID (EUI64). |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|
操作影响
此方法会删除、清空或重置对应资源/状态。调用前核对目标 ID；请勿通过重试重复执行有副作用的操作。
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
ClearDeviceFrameLog
接口名称： api.AlinkwiseService/ClearDeviceFrameLog
功能： 清空 DeviceFrameLog。ClearDeviceFrameLog clears the cached Redis frame log for one device.
请求： api.ClearDeviceFrameLogRequest；返回： api.ClearDeviceFrameLogResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (EUI64). |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|
操作影响
此方法会删除、清空或重置对应资源/状态。调用前核对目标 ID；请勿通过重试重复执行有副作用的操作。
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
ClearDeviceMetrics
接口名称： api.AlinkwiseService/ClearDeviceMetrics
功能： 清空 DeviceMetrics。ClearDeviceMetrics clears the cached Redis metrics for one device.
请求： api.ClearDeviceMetricsRequest；返回： api.ClearDeviceMetricsResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (EUI64). |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|
操作影响
此方法会删除、清空或重置对应资源/状态。调用前核对目标 ID；请勿通过重试重复执行有副作用的操作。
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
ClearDeviceUplinkHistory
接口名称： api.AlinkwiseService/ClearDeviceUplinkHistory
功能： 清空 DeviceUplinkHistory。ClearDeviceUplinkHistory clears persisted PostgreSQL integration history for one device.
请求： api.ClearDeviceUplinkHistoryRequest；返回： api.ClearDeviceUplinkHistoryResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (EUI64). |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
deleted_count | uint32 | 按业务校验 | 消息定义未补充字段说明。 |
操作影响
此方法会删除、清空或重置对应资源/状态。调用前核对目标 ID；请勿通过重试重复执行有副作用的操作。
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
ListDeviceUplinkHistory
接口名称： api.AlinkwiseService/ListDeviceUplinkHistory
功能： 列出 DeviceUplinkHistory。ListDeviceUplinkHistory returns persisted uplink events for one device.
请求： api.ListDeviceUplinkHistoryRequest；返回： api.ListDeviceUplinkHistoryResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
limit | uint32 | 按业务校验 | 本次最多返回条数。 Max number of uplink events to return. |
offset | uint32 | 按业务校验 | 分页起始偏移。 Offset in the result-set. |
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (EUI64). |
search | string | 按业务校验 | 搜索关键字。 Optional search over DevAddr, FCnt, FPort, payload hex, object JSON, and rx_info JSON. |
f_port | uint32 | 按业务校验 | 应用端口。 Optional FPort filter. Only used when has_f_port is true. |
has_f_port | bool | 按业务校验 | Whether f_port should be applied. |
event_type | string | 按业务校验 | Optional event type filter: up, join, ack, txack, log, status, location, integration. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
total_count | uint32 | 按业务校验 | 符合条件的总条数。 |
result | repeated api.DeviceUplinkHistoryItem | 按业务校验 | 结果列表或结果内容。 |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
GetDevicePacketLoss
接口名称： api.AlinkwiseService/GetDevicePacketLoss
功能： 查询 DevicePacketLoss。GetDevicePacketLoss returns packet-loss statistics calculated from uplink frame-counter gaps in persisted integration history.
请求： api.GetDevicePacketLossRequest；返回： api.GetDevicePacketLossResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (EUI64). |
start | google.protobuf.Timestamp | 按业务校验 | 起始时间。 Interval start timestamp. |
end | google.protobuf.Timestamp | 按业务校验 | 结束时间。 Interval end timestamp. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
received_uplinks | uint32 | 按业务校验 | Uplinks received by the server in the selected interval. |
missing_uplinks | uint32 | 按业务校验 | Missing uplinks inferred from positive FCnt gaps. |
expected_uplinks | uint32 | 按业务校验 | received_uplinks + missing_uplinks. |
loss_rate_basis_points | uint32 | 按业务校验 | Loss rate in basis points. 1234 means 12.34%. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
GetDeviceHistoryLinkMetrics
接口名称： api.AlinkwiseService/GetDeviceHistoryLinkMetrics
功能： 查询 DeviceHistoryLinkMetrics。GetDeviceHistoryLinkMetrics returns link metrics aggregated from persisted PostgreSQL integration history.
请求： api.GetDeviceHistoryLinkMetricsRequest；返回： api.GetDeviceHistoryLinkMetricsResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (EUI64). |
start | google.protobuf.Timestamp | 按业务校验 | 起始时间。 Interval start timestamp. |
end | google.protobuf.Timestamp | 按业务校验 | 结束时间。 Interval end timestamp. |
aggregation | common.Aggregation {HOUR=0, DAY=1, MONTH=2, MINUTE=3} | 按业务校验 | 聚合粒度。 Aggregation. |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
metrics_json | string | 按业务校验 | JSON encoded DeviceLinkMetricsSummary-compatible payload. |
device_status_json | string | 按业务校验 | JSON encoded latest DeviceStatus-compatible payload from history. |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
GetGatewayRemoteInfo
接口名称： api.AlinkwiseService/GetGatewayRemoteInfo
功能： 查询 GatewayRemoteInfo。GetGatewayRemoteInfo sends getInfo to the gateway-manager MQTT control topic and returns the gateway stdout JSON.
请求： api.GetGatewayRemoteInfoRequest；返回： api.GetGatewayRemoteInfoResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
gateway_id | string | 按业务校验 | 网关 EUI。 |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
info_json | string | 按业务校验 | 信息 JSON 字符串。 |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
GetGatewayRemoteConfig
接口名称： api.AlinkwiseService/GetGatewayRemoteConfig
功能： 查询 GatewayRemoteConfig。GetGatewayRemoteConfig sends getConfig to the gateway-manager MQTT control topic and returns the gateway stdout JSON.
请求： api.GetGatewayRemoteConfigRequest；返回： api.GetGatewayRemoteConfigResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
gateway_id | string | 按业务校验 | 网关 EUI。 |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
config_json | string | 按业务校验 | 配置 JSON 字符串。 |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
UpdateGatewayRemoteConfig
接口名称： api.AlinkwiseService/UpdateGatewayRemoteConfig
功能： 更新 GatewayRemoteConfig。UpdateGatewayRemoteConfig sends config to the gateway-manager MQTT control topic. The config_json payload is forwarded as the command environment.
请求： api.UpdateGatewayRemoteConfigRequest；返回： api.UpdateGatewayRemoteConfigResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
gateway_id | string | 按业务校验 | 网关 EUI。 |
config_json | string | 按业务校验 | 配置 JSON 字符串。 |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
ack_json | string | 按业务校验 | 消息定义未补充字段说明。 |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
UpgradeGatewayRemote
接口名称： api.AlinkwiseService/UpgradeGatewayRemote
功能： 升级 GatewayRemote。UpgradeGatewayRemote stores the uploaded firmware package and sends upgrade to the gateway-manager MQTT control topic with url and md5 environment.
请求： api.UpgradeGatewayRemoteRequest；返回： api.UpgradeGatewayRemoteResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
gateway_id | string | 按业务校验 | 网关 EUI。 |
file_name | string | 按业务校验 | 消息定义未补充字段说明。 |
firmware | bytes | 按业务校验 | 消息定义未补充字段说明。 |
download_base_url | string | 按业务校验 | 消息定义未补充字段说明。 |
gateway_ip | string | 按业务校验 | 消息定义未补充字段说明。 |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
ack_json | string | 按业务校验 | 消息定义未补充字段说明。 |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
ExecuteGatewayRemoteCommand
接口名称： api.AlinkwiseService/ExecuteGatewayRemoteCommand
功能： 执行 GatewayRemoteCommand。ExecuteGatewayRemoteCommand sends a limited gateway-manager remote command.
请求： api.ExecuteGatewayRemoteCommandRequest；返回： api.ExecuteGatewayRemoteCommandResponse（单次响应）。
请求参数
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
gateway_id | string | 按业务校验 | 网关 EUI。 |
command | string | 按业务校验 | 命令名称。 |
environment_json | string | 按业务校验 | 环境参数 JSON 字符串。 |
body_json | string | 按业务校验 | 命令体 JSON 字符串。 |
返回值
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
result_json | string | 按业务校验 | 消息定义未补充字段说明。 |
错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。
嵌套消息结构
api.ApplyLicenseRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
license | string | 按业务校验 | 离线许可证。 Offline license text. First version accepts ALW1.<jwt> or raw JWT. |
api.ApplyLicenseResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
info_json | string | 按业务校验 | 信息 JSON 字符串。 JSON encoded license status payload after applying. |
api.ClearDeviceFrameLogRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (EUI64). |
api.ClearDeviceFrameLogResponse
| 名称 | 类型 | 必填 | 说明 |
|---|
api.ClearDeviceMetricsRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (EUI64). |
api.ClearDeviceMetricsResponse
| 名称 | 类型 | 必填 | 说明 |
|---|
api.ClearDeviceUplinkHistoryRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (EUI64). |
api.ClearDeviceUplinkHistoryResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
deleted_count | uint32 | 按业务校验 | 消息定义未补充字段说明。 |
api.ClearGatewayFrameLogRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
gateway_id | string | 按业务校验 | 网关 EUI。 Gateway ID (EUI64). |
api.ClearGatewayFrameLogResponse
| 名称 | 类型 | 必填 | 说明 |
|---|
api.CreateAuditLogRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
action | string | 按业务校验 | 消息定义未补充字段说明。 |
target_type | string | 按业务校验 | 消息定义未补充字段说明。 |
target_id | string | 按业务校验 | 消息定义未补充字段说明。 |
target_name | string | 按业务校验 | 消息定义未补充字段说明。 |
tenant_id | string | 按业务校验 | 租户 UUID。 |
result | string | 按业务校验 | 结果列表或结果内容。 |
detail_json | string | 按业务校验 | 消息定义未补充字段说明。 |
api.CreateAuditLogResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
log_json | string | 按业务校验 | 消息定义未补充字段说明。 |
api.DeviceStatus
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
margin | int32 | 按业务校验 | The device margin status -32..32: The demodulation SNR ration in dB |
external_power_source | bool | 按业务校验 | 是否外接电源。 Device is connected to an external power source. |
battery_level | float | 按业务校验 | 电池状态。 Device battery level as a percentage. -1 when the battery level is not available. |
api.DeviceUplinkHistoryItem
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
deduplication_id | string | 按业务校验 | 消息定义未补充字段说明。 |
event_type | string | 按业务校验 | 消息定义未补充字段说明。 |
time | string | 按业务校验 | 时间。 |
dev_addr | string | 按业务校验 | 会话短地址。 |
dr | uint32 | 按业务校验 | 数据率索引。 |
f_cnt | string | 按业务校验 | 帧计数。 |
f_port | uint32 | 按业务校验 | 应用端口。 |
confirmed | bool | 按业务校验 | 是否使用确认下行。 |
data_hex | string | 按业务校验 | 消息定义未补充字段说明。 |
object_json | string | 按业务校验 | 消息定义未补充字段说明。 |
rx_info_json | string | 按业务校验 | 消息定义未补充字段说明。 |
tx_info_json | string | 按业务校验 | 消息定义未补充字段说明。 |
tags_json | string | 按业务校验 | 消息定义未补充字段说明。 |
summary_json | string | 按业务校验 | 消息定义未补充字段说明。 |
api.ExecuteGatewayRemoteCommandRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
gateway_id | string | 按业务校验 | 网关 EUI。 |
command | string | 按业务校验 | 命令名称。 |
environment_json | string | 按业务校验 | 环境参数 JSON 字符串。 |
body_json | string | 按业务校验 | 命令体 JSON 字符串。 |
api.ExecuteGatewayRemoteCommandResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
result_json | string | 按业务校验 | 消息定义未补充字段说明。 |
api.GenerateAiConfigDraftRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
tenant_id | string | 按业务校验 | 租户 UUID。 |
scenario | string | 按业务校验 | 消息定义未补充字段说明。 |
user_prompt | string | 按业务校验 | 消息定义未补充字段说明。 |
context_json | string | 按业务校验 | 消息定义未补充字段说明。 |
api.GenerateAiConfigDraftResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
draft_json | string | 按业务校验 | 消息定义未补充字段说明。 |
api.GetAiAssistantStatusRequest
| 名称 | 类型 | 必填 | 说明 |
|---|
api.GetAiAssistantStatusResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
status_json | string | 按业务校验 | 消息定义未补充字段说明。 |
api.GetDeviceHistoryLinkMetricsRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (EUI64). |
start | google.protobuf.Timestamp | 按业务校验 | 起始时间。 Interval start timestamp. |
end | google.protobuf.Timestamp | 按业务校验 | 结束时间。 Interval end timestamp. |
aggregation | common.Aggregation {HOUR=0, DAY=1, MONTH=2, MINUTE=3} | 按业务校验 | 聚合粒度。 Aggregation. |
api.GetDeviceHistoryLinkMetricsResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
metrics_json | string | 按业务校验 | JSON encoded DeviceLinkMetricsSummary-compatible payload. |
device_status_json | string | 按业务校验 | JSON encoded latest DeviceStatus-compatible payload from history. |
api.GetDevicePacketLossRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (EUI64). |
start | google.protobuf.Timestamp | 按业务校验 | 起始时间。 Interval start timestamp. |
end | google.protobuf.Timestamp | 按业务校验 | 结束时间。 Interval end timestamp. |
api.GetDevicePacketLossResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
received_uplinks | uint32 | 按业务校验 | Uplinks received by the server in the selected interval. |
missing_uplinks | uint32 | 按业务校验 | Missing uplinks inferred from positive FCnt gaps. |
expected_uplinks | uint32 | 按业务校验 | received_uplinks + missing_uplinks. |
loss_rate_basis_points | uint32 | 按业务校验 | Loss rate in basis points. 1234 means 12.34%. |
api.GetGatewayRemoteConfigRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
gateway_id | string | 按业务校验 | 网关 EUI。 |
api.GetGatewayRemoteConfigResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
config_json | string | 按业务校验 | 配置 JSON 字符串。 |
api.GetGatewayRemoteInfoRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
gateway_id | string | 按业务校验 | 网关 EUI。 |
api.GetGatewayRemoteInfoResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
info_json | string | 按业务校验 | 信息 JSON 字符串。 |
api.GetLicenseInfoRequest
| 名称 | 类型 | 必填 | 说明 |
|---|
api.GetLicenseInfoResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
info_json | string | 按业务校验 | 信息 JSON 字符串。 JSON encoded license status payload. |
api.GetOperationsRulesRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
tenant_id | string | 按业务校验 | 租户 UUID。 |
api.GetOperationsRulesResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
rules_json | string | 按业务校验 | 规则 JSON 字符串。 JSON encoded operation-center alert rules. |
api.GetOperationsSnapshotRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
tenant_id | string | 按业务校验 | 租户 UUID。 |
api.GetOperationsSnapshotResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
snapshot_json | string | 按业务校验 | JSON encoded operation-center diagnostics, alerts, health scores, and report. |
api.ListAuditLogsRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
limit | uint32 | 按业务校验 | 本次最多返回条数。 |
offset | uint32 | 按业务校验 | 分页起始偏移。 |
search | string | 按业务校验 | 搜索关键字。 |
action | string | 按业务校验 | 消息定义未补充字段说明。 |
target_type | string | 按业务校验 | 消息定义未补充字段说明。 |
result | string | 按业务校验 | 结果列表或结果内容。 |
api.ListAuditLogsResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
logs_json | string | 按业务校验 | 消息定义未补充字段说明。 |
api.ListDeviceUplinkHistoryRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
limit | uint32 | 按业务校验 | 本次最多返回条数。 Max number of uplink events to return. |
offset | uint32 | 按业务校验 | 分页起始偏移。 Offset in the result-set. |
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 Device EUI (EUI64). |
search | string | 按业务校验 | 搜索关键字。 Optional search over DevAddr, FCnt, FPort, payload hex, object JSON, and rx_info JSON. |
f_port | uint32 | 按业务校验 | 应用端口。 Optional FPort filter. Only used when has_f_port is true. |
has_f_port | bool | 按业务校验 | Whether f_port should be applied. |
event_type | string | 按业务校验 | Optional event type filter: up, join, ack, txack, log, status, location, integration. |
api.ListDeviceUplinkHistoryResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
total_count | uint32 | 按业务校验 | 符合条件的总条数。 |
result | repeated api.DeviceUplinkHistoryItem | 按业务校验 | 结果列表或结果内容。 |
api.ListTenantDevicesRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
limit | uint32 | 按业务校验 | 本次最多返回条数。 Max number of devices to return in the result-set. |
offset | uint32 | 按业务校验 | 分页起始偏移。 Offset in the result-set. |
tenant_id | string | 按业务校验 | 租户 UUID。 Tenant ID (UUID) to filter devices on. |
application_id | string | 按业务校验 | 应用 UUID。 Optional application ID (UUID). |
device_profile_id | string | 按业务校验 | 终端模版 UUID。 Optional device-profile ID (UUID). |
search | string | 按业务校验 | 搜索关键字。 Optional search over device, application, and device-profile name. |
online_state | api.ListTenantDevicesRequest.OnlineState {ALL=0, ONLINE=1, OFFLINE=2, NEVER_SEEN=3, DISABLED=4} | 按业务校验 | Optional online-state filter. |
order_by | api.ListTenantDevicesRequest.OrderBy {NAME=0, DEV_EUI=1, LAST_SEEN_AT=2, DEVICE_PROFILE_NAME=3, APPLICATION_NAME=4, CREATED_AT=5, UPDATED_AT=6} | 按业务校验 | Sorting field. |
order_by_desc | bool | 按业务校验 | Sorting direction. |
tags | map<string, string> | 按业务校验 | 自定义字符串标签。 Tags to filter devices on. |
api.ListTenantDevicesRequest.TagsEntry
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
key | string | 按业务校验 | 消息定义未补充字段说明。 |
value | string | 按业务校验 | 消息定义未补充字段说明。 |
api.ListTenantDevicesResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
total_count | uint32 | 按业务校验 | 符合条件的总条数。 |
result | repeated api.TenantDeviceListItem | 按业务校验 | 结果列表或结果内容。 |
api.TenantDeviceListItem
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
dev_eui | string | 按业务校验 | 终端完整 DevEUI。 |
name | string | 按业务校验 | 名称。 |
description | string | 按业务校验 | 描述。 |
application_id | string | 按业务校验 | 应用 UUID。 |
application_name | string | 按业务校验 | 消息定义未补充字段说明。 |
device_profile_id | string | 按业务校验 | 终端模版 UUID。 |
device_profile_name | string | 按业务校验 | 消息定义未补充字段说明。 |
created_at | google.protobuf.Timestamp | 按业务校验 | 创建时间。 |
updated_at | google.protobuf.Timestamp | 按业务校验 | 最后更新时间。 |
last_seen_at | google.protobuf.Timestamp | 按业务校验 | 最后上报时间。 |
device_status | api.DeviceStatus | 按业务校验 | 终端状态。 |
tags | map<string, string> | 按业务校验 | 自定义字符串标签。 |
join_eui | string | 按业务校验 | JoinEUI。 |
is_disabled | bool | 按业务校验 | 是否禁用。 |
is_active | bool | 按业务校验 | 是否启用。 |
class_enabled | common.DeviceClass {CLASS_A=0, CLASS_B=1, CLASS_C=2} | 按业务校验 | 已启用的 Class。 |
api.TenantDeviceListItem.TagsEntry
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
key | string | 按业务校验 | 消息定义未补充字段说明。 |
value | string | 按业务校验 | 消息定义未补充字段说明。 |
api.TestAiAssistantRequest
| 名称 | 类型 | 必填 | 说明 |
|---|
api.TestAiAssistantResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
result_json | string | 按业务校验 | 消息定义未补充字段说明。 |
api.UpdateGatewayRemoteConfigRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
gateway_id | string | 按业务校验 | 网关 EUI。 |
config_json | string | 按业务校验 | 配置 JSON 字符串。 |
api.UpdateGatewayRemoteConfigResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
ack_json | string | 按业务校验 | 消息定义未补充字段说明。 |
api.UpdateOperationsRulesRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
tenant_id | string | 按业务校验 | 租户 UUID。 |
rules_json | string | 按业务校验 | 规则 JSON 字符串。 JSON encoded operation-center alert rules. |
api.UpdateOperationsRulesResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
rules_json | string | 按业务校验 | 规则 JSON 字符串。 JSON encoded normalized operation-center alert rules. |
api.UpgradeGatewayRemoteRequest
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
gateway_id | string | 按业务校验 | 网关 EUI。 |
file_name | string | 按业务校验 | 消息定义未补充字段说明。 |
firmware | bytes | 按业务校验 | 消息定义未补充字段说明。 |
download_base_url | string | 按业务校验 | 消息定义未补充字段说明。 |
gateway_ip | string | 按业务校验 | 消息定义未补充字段说明。 |
api.UpgradeGatewayRemoteResponse
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
ack_json | string | 按业务校验 | 消息定义未补充字段说明。 |