终端模版 API

本页列出当前版本的完整方法及字段。方法通过 gRPC / gRPC-Web 调用；REST 注解不表示已部署 REST Gateway。

“必填：按业务校验”表示 proto3 未声明 required，不代表留空一定可用。UUID、EUI、权限、资源存在性与字段组合由服务端校验。嵌套结构详见页末消息结构。

调用方式、鉴权与错误处理

DeviceProfileService

Create

接口名称： api.DeviceProfileService/Create

功能： 创建 对应资源。Create the given device-profile.

请求： api.CreateDeviceProfileRequest；返回： api.CreateDeviceProfileResponse（单次响应）。

请求参数

名称	类型	必填	说明
device_profile	api.DeviceProfile	按业务校验	终端模版对象。 Object to create.

返回值

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 ID (UUID).

错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。

Get

接口名称： api.DeviceProfileService/Get

功能： 查询 对应资源。Get the device-profile for the given ID.

请求： api.GetDeviceProfileRequest；返回： api.GetDeviceProfileResponse（单次响应）。

请求参数

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 ID (UUID).

返回值

名称	类型	必填	说明
device_profile	api.DeviceProfile	按业务校验	终端模版对象。 Device-profile object.
created_at	google.protobuf.Timestamp	按业务校验	创建时间。 Created at timestamp.
updated_at	google.protobuf.Timestamp	按业务校验	最后更新时间。 Last update timestamp.

错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。

GetByProfileId

接口名称： api.DeviceProfileService/GetByProfileId

功能： 查询 ByProfileId。GetByProfileId tries to get the device-profile for the given ProfileID (see TR0005).

请求： api.GetDeviceProfileByProfileIdRequest；返回： api.GetDeviceProfileByProfileIdResponse（单次响应）。

请求参数

名称	类型	必填	说明
vendor_id	uint32	按业务校验	Vendor ID.
vendor_profile_id	uint32	按业务校验	Vendor Profile ID.

返回值

名称	类型	必填	说明
device_profile	api.DeviceProfile	按业务校验	终端模版对象。 Device-profile object.
created_at	google.protobuf.Timestamp	按业务校验	创建时间。 Created at timestamp.
updated_at	google.protobuf.Timestamp	按业务校验	最后更新时间。 Last update timestamp.

错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。

Update

接口名称： api.DeviceProfileService/Update

功能： 更新 对应资源。Update the given device-profile.

请求： api.UpdateDeviceProfileRequest；返回： google.protobuf.Empty（单次响应）。

请求参数

名称	类型	必填	说明
device_profile	api.DeviceProfile	按业务校验	终端模版对象。 Device-profile object.

返回值

无字段。

错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。

Delete

接口名称： api.DeviceProfileService/Delete

功能： 删除 对应资源。Delete the device-profile with the given ID.

请求： api.DeleteDeviceProfileRequest；返回： google.protobuf.Empty（单次响应）。

请求参数

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 ID (UUID).

返回值

无字段。

操作影响

此方法会删除、清空或重置对应资源/状态。调用前核对目标 ID；请勿通过重试重复执行有副作用的操作。

错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。

List

接口名称： api.DeviceProfileService/List

功能： 列出 对应资源。List the available device-profiles.

请求： api.ListDeviceProfilesRequest；返回： api.ListDeviceProfilesResponse（单次响应）。

请求参数

名称	类型	必填	说明
limit	uint32	按业务校验	本次最多返回条数。 Max number of device-profiles to return in the result-set. If not set, it will be treated as 0, and the response will only return the total_count.
offset	uint32	按业务校验	分页起始偏移。 Offset in the result-set (for pagination).
search	string	按业务校验	搜索关键字。 If set, the given string will be used to search on name.
tenant_id	string	按业务校验	租户 UUID。 Tenant ID to list the device-profiles for. This value must be set, unless global_only is set to true. The result will be the list of device-profiles matching the tenant_id and global tenants. If you only wish to list the device-profiles matching the tenant_id, you must set tenant_only to true.
device_id	string	按业务校验	Device-profile device ID. Note that his is the device-profile ID, not the DevEUI. This value requires global_only to be set to true.
global_only	bool	按业务校验	Only list global (non-tenant) device-profiles.
tenant_only	bool	按业务校验	Only list device-profiles matching the tenant_id.

返回值

名称	类型	必填	说明
total_count	uint32	按业务校验	符合条件的总条数。 Total number of device-profiles.
result	repeated api.DeviceProfileListItem	按业务校验	结果列表或结果内容。 Result-set.

错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。

ListVendors

接口名称： api.DeviceProfileService/ListVendors

功能： 列出 Vendors。List the available device-profile vendors.

请求： api.ListDeviceProfileVendorsRequest；返回： api.ListDeviceProfileVendorsResponse（单次响应）。

请求参数

名称	类型	必填	说明
limit	uint32	按业务校验	本次最多返回条数。 Max number of device-profile vendors to return in the result-set. If not set, it will be treated as 0, and the response will only return the total_count.
offset	uint32	按业务校验	分页起始偏移。 Offset in the result-set (for pagination).

返回值

名称	类型	必填	说明
total_count	uint32	按业务校验	符合条件的总条数。 Total number of vendors.
result	repeated api.DeviceProfileVendorListItem	按业务校验	结果列表或结果内容。 Result-set.

错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。

GetVendor

接口名称： api.DeviceProfileService/GetVendor

功能： 查询 Vendor。Get the device-profile vendor.

请求： api.GetDeviceProfileVendorRequest；返回： api.GetDeviceProfileVendorResponse（单次响应）。

请求参数

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Vendor ID (UUID).

返回值

名称	类型	必填	说明
vendor	api.DeviceProfileVendor	按业务校验	Vendor object.
created_at	google.protobuf.Timestamp	按业务校验	创建时间。 Created at timestamp.
updated_at	google.protobuf.Timestamp	按业务校验	最后更新时间。 Last update timestamp.

错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。

DeleteVendor

接口名称： api.DeviceProfileService/DeleteVendor

功能： 删除 Vendor。Delete the given device-profile vendor.

请求： api.DeleteDeviceProfileVendorRequest；返回： google.protobuf.Empty（单次响应）。

请求参数

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Vendor ID (UUID).

返回值

无字段。

操作影响

此方法会删除、清空或重置对应资源/状态。调用前核对目标 ID；请勿通过重试重复执行有副作用的操作。

错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。

ListDevices

接口名称： api.DeviceProfileService/ListDevices

功能： 列出 Devices。List the available device-profile devices.

请求： api.ListDeviceProfileDevicesRequest；返回： api.ListDeviceProfileDevicesResponse（单次响应）。

请求参数

名称	类型	必填	说明
limit	uint32	按业务校验	本次最多返回条数。 Max number of device-profile vendors to return in the result-set. If not set, it will be treated as 0, and the response will only return the total_count.
offset	uint32	按业务校验	分页起始偏移。 Offset in the result-set (for pagination).
vendor_id	string	按业务校验	Vendor ID (UUID).

返回值

名称	类型	必填	说明
total_count	uint32	按业务校验	符合条件的总条数。 Total number of devices.
result	repeated api.DeviceProfileDeviceListItem	按业务校验	结果列表或结果内容。 Result-set.

错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。

GetDevice

接口名称： api.DeviceProfileService/GetDevice

功能： 查询 Device。Get the device-profile device.

请求： api.GetDeviceProfileDeviceRequest；返回： api.GetDeviceProfileDeviceResponse（单次响应）。

请求参数

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Device-profile device ID.

返回值

名称	类型	必填	说明
device	api.DeviceProfileDevice	按业务校验	终端对象。 Device object.
created_at	google.protobuf.Timestamp	按业务校验	创建时间。 Created at timestamp.
updated_at	google.protobuf.Timestamp	按业务校验	最后更新时间。 Last update timestamp.

错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。

DeleteDevice

接口名称： api.DeviceProfileService/DeleteDevice

功能： 删除 Device。Delete the given device-profile device.

请求： api.DeleteDeviceProfileDeviceRequest；返回： google.protobuf.Empty（单次响应）。

请求参数

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Device ID (UUID).

返回值

无字段。

操作影响

此方法会删除、清空或重置对应资源/状态。调用前核对目标 ID；请勿通过重试重复执行有副作用的操作。

错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。

ListAdrAlgorithms

接口名称： api.DeviceProfileService/ListAdrAlgorithms

功能： 列出 AdrAlgorithms。List available ADR algorithms.

请求： google.protobuf.Empty；返回： api.ListDeviceProfileAdrAlgorithmsResponse（单次响应）。

请求参数

无字段。

返回值

名称	类型	必填	说明
total_count	uint32	按业务校验	符合条件的总条数。 Total number of algorithms.
result	repeated api.AdrAlgorithmListItem	按业务校验	结果列表或结果内容。 Result-set.

错误处理：按 统一错误说明 检查 gRPC 状态；本页不将通用状态码冒充每个方法的固定错误集合。

嵌套消息结构

api.AdrAlgorithmListItem

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Algorithm ID.
name	string	按业务校验	名称。 Algorithm name.

api.AppLayerParams

名称	类型	必填	说明
ts003_version	api.Ts003Version {TS003_NOT_IMPLEMENTED=0, TS003_V100=1, TS003_v200=2}	按业务校验	TS003 version (Application Layer Clock Sync).
ts003_f_port	uint32	按业务校验	TS003 fPort.
ts004_version	api.Ts004Version {TS004_NOT_IMPLEMENTED=0, TS004_V100=1, TS004_V200=2}	按业务校验	TS004 version (Fragmented Data Block Transport).
ts004_f_port	uint32	按业务校验	TS004 fPort.
ts005_version	api.Ts005Version {TS005_NOT_IMPLEMENTED=0, TS005_V100=1, TS005_V200=2}	按业务校验	TS005 version (Remote Multicast Setup).
ts005_f_port	uint32	按业务校验	TS005 fPort.

api.CreateDeviceProfileRequest

名称	类型	必填	说明
device_profile	api.DeviceProfile	按业务校验	终端模版对象。 Object to create.

api.CreateDeviceProfileResponse

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 ID (UUID).

api.DeleteDeviceProfileDeviceRequest

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Device ID (UUID).

api.DeleteDeviceProfileRequest

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 ID (UUID).

api.DeleteDeviceProfileVendorRequest

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Vendor ID (UUID).

api.DeviceProfile

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Device-profile ID (UUID). Note: on create this will be automatically generated.
tenant_id	string	按业务校验	租户 UUID。 Tenant ID (UUID).
name	string	按业务校验	名称。 Name.
description	string	按业务校验	描述。 Description.
region	common.Region {EU868=0, US915=2, CN779=3, EU433=4, AU915=5, CN470=6, AS923=7, AS923_2=12, AS923_3=13, AS923_4=14, KR920=8, IN865=9, RU864=10, ISM2400=11}	按业务校验	区域枚举。 Region.
mac_version	common.MacVersion {LORAWAN_1_0_0=0, LORAWAN_1_0_1=1, LORAWAN_1_0_2=2, LORAWAN_1_0_3=3, LORAWAN_1_0_4=4, LORAWAN_1_1_0=5}	按业务校验	LoRaWAN MAC 版本。 LoRaWAN mac-version.
reg_params_revision	common.RegParamsRevision {A=0, B=1, RP002_1_0_0=2, RP002_1_0_1=3, RP002_1_0_2=4, RP002_1_0_3=5, RP002_1_0_4=6, RP002_1_0_5=7}	按业务校验	区域参数版本。 Regional parameters revision.
adr_algorithm_id	string	按业务校验	ADR algorithm ID.
payload_codec_runtime	api.CodecRuntime {NONE=0, CAYENNE_LPP=1, JS=2}	按业务校验	Payload codec runtime.
payload_codec_script	string	按业务校验	Payload codec script.
flush_queue_on_activate	bool	按业务校验	Flush queue on device activation.
uplink_interval	uint32	按业务校验	预期上行间隔。 Uplink interval (seconds). This defines the expected uplink interval which the device uses for communication. If the uplink interval has expired and no uplink has been received, the device is considered inactive.
device_status_req_interval	uint32	按业务校验	Device-status request interval (times / day). This defines the times per day that ChirpStack will request the device-status from the device.
supports_otaa	bool	按业务校验	是否支持 OTAA。 Supports OTAA.
supports_class_b	bool	按业务校验	是否支持 Class B。 Supports Class B.
supports_class_c	bool	按业务校验	是否支持 Class C。 Supports Class-C.
class_b_timeout	uint32	按业务校验	Class-B timeout (seconds). This is the maximum time ChirpStack will wait to receive an acknowledgement from the device (if requested).
class_b_ping_slot_periodicity	uint32	按业务校验	Class-B ping-slot periodicity. Valid options are: 0 - 7. Number of ping-slots per beacon-period: pingNb = 2^(7-periodicity) Periodicity: 0 = 128 ping-slots per beacon period = ~ every 1 sec Periodicity: 7 = 1 ping-slot per beacon period = ~ every 128 sec
class_b_ping_slot_dr	uint32	按业务校验	Class-B ping-slot DR.
class_b_ping_slot_freq	uint32	按业务校验	Class-B ping-slot freq (Hz).
class_c_timeout	uint32	按业务校验	Class-C timeout (seconds). This is the maximum time ChirpStack will wait to receive an acknowledgement from the device (if requested).
abp_rx1_delay	uint32	按业务校验	RX1 delay (for ABP).
abp_rx1_dr_offset	uint32	按业务校验	RX1 DR offset (for ABP).
abp_rx2_dr	uint32	按业务校验	RX2 DR (for ABP).
abp_rx2_freq	uint32	按业务校验	RX2 frequency (for ABP, Hz).
tags	map<string, string>	按业务校验	自定义字符串标签。 Tags (user defined). These tags can be used to add additional information the the device-profile. These tags are exposed in all the integration events of devices using this device-profile.
measurements	map<string, api.Measurement>	按业务校验	Measurements. If defined, ChirpStack will visualize these metrics in the web-interface.
auto_detect_measurements	bool	按业务校验	Auto-detect measurements. If set to true, measurements will be automatically added based on the keys of the decoded payload. In cases where the decoded payload contains random keys in the data, you want to set this to false.
region_config_id	string	按业务校验	区域配置 ID。 Region configuration ID. If set, devices will only use the associated region. If let blank, then devices will use all regions matching the selected common-name. Note that multiple region configurations can exist for the same common-name, e.g. to provide an 8 channel and 16 channel configuration for the US915 band.
is_relay	bool	按业务校验	Device is a Relay device. Enable this in case the device is a Relay. A Relay device implements TS011 and is able to relay data from relay capable devices. See for more information the TS011 specification.
is_relay_ed	bool	按业务校验	Device is a Relay end-device. Enable this in case the device is an end-device that can operate under a Relay. Please refer to the TS011 specification for more information.
relay_ed_relay_only	bool	按业务校验	End-device only accept data through relay. Only accept data for this device through a relay. This setting is useful for testing as in case of a test-setup, the end-device is usually within range of the gateway.
relay_enabled	bool	按业务校验	Relay must be enabled.
relay_cad_periodicity	api.CadPeriodicity {SEC_1=0, MS_500=1, MS_250=2, MS_100=3, MS_50=4, MS_20=5}	按业务校验	Relay CAD periodicity.
relay_default_channel_index	uint32	按业务校验	Relay default channel index. Valid values are 0 and 1, please refer to the RP002 specification for the meaning of these values.
relay_second_channel_freq	uint32	按业务校验	Relay second channel frequency (Hz).
relay_second_channel_dr	uint32	按业务校验	Relay second channel DR.
relay_second_channel_ack_offset	api.SecondChAckOffset {KHZ_0=0, KHZ_200=1, KHZ_400=2, KHZ_800=3, KHZ_1600=4, KHZ_3200=5}	按业务校验	Relay second channel ACK offset.
relay_ed_activation_mode	api.RelayModeActivation {DISABLE_RELAY_MODE=0, ENABLE_RELAY_MODE=1, DYNAMIC=2, END_DEVICE_CONTROLLED=3}	按业务校验	Relay end-device activation mode.
relay_ed_smart_enable_level	uint32	按业务校验	Relay end-device smart-enable level.
relay_ed_back_off	uint32	按业务校验	Relay end-device back-off (in case it does not receive WOR ACK frame). 0 = Always send a LoRaWAN uplink 1..63 = Send a LoRaWAN uplink after X WOR frames without a WOR ACK
relay_ed_uplink_limit_bucket_size	uint32	按业务校验	Relay end-device uplink limit bucket size. This field indicates the multiplier to determine the bucket size according to the following formula: BucketSize TOKEN = _reload_rate x _bucket_size Valid values (0 - 3): 0 = 1 1 = 2 2 = 4 3 = 12
relay_ed_uplink_limit_reload_rate	uint32	按业务校验	Relay end-device uplink limit reload rate. Valid values: * 0 - 62 = X tokens every hour * 63 = no limitation
relay_join_req_limit_reload_rate	uint32	按业务校验	Relay join-request limit reload rate. Valid values: * 0 - 126 = X tokens every hour * 127 = no limitation
relay_notify_limit_reload_rate	uint32	按业务校验	Relay notify limit reload rate. Valid values: * 0 - 126 = X tokens every hour * 127 = no limitation
relay_global_uplink_limit_reload_rate	uint32	按业务校验	Relay global uplink limit reload rate. Valid values: * 0 - 126 = X tokens every hour * 127 = no limitation
relay_overall_limit_reload_rate	uint32	按业务校验	Relay overall limit reload rate. Valid values: * 0 - 126 = X tokens every hour * 127 = no limitation
relay_join_req_limit_bucket_size	uint32	按业务校验	Relay join-request limit bucket size. This field indicates the multiplier to determine the bucket size according to the following formula: BucketSize TOKEN = _reload_rate x _bucket_size Valid values (0 - 3): 0 = 1 1 = 2 2 = 4 3 = 12
relay_notify_limit_bucket_size	uint32	按业务校验	Relay notify limit bucket size. This field indicates the multiplier to determine the bucket size according to the following formula: BucketSize TOKEN = _reload_rate x _bucket_size Valid values (0 - 3): 0 = 1 1 = 2 2 = 4 3 = 12
relay_global_uplink_limit_bucket_size	uint32	按业务校验	Relay globak uplink limit bucket size. This field indicates the multiplier to determine the bucket size according to the following formula: BucketSize TOKEN = _reload_rate x _bucket_size Valid values (0 - 3): 0 = 1 1 = 2 2 = 4 3 = 12
relay_overall_limit_bucket_size	uint32	按业务校验	Relay overall limit bucket size. This field indicates the multiplier to determine the bucket size according to the following formula: BucketSize TOKEN = _reload_rate x _bucket_size Valid values (0 - 3): 0 = 1 1 = 2 2 = 4 3 = 12
allow_roaming	bool	按业务校验	Allow roaming. If set to true, it means that the device is allowed to use roaming.
rx1_delay	uint32	按业务校验	RX1 Delay. This makes it possible to override the system RX1 Delay. Please note that this values only has effect in case it is higher than the system value. In other words, it can be used to increase the RX1 Delay but not to decrease it. Valid options are 1 - 15 (0 = always use system RX1 Delay).
app_layer_params	api.AppLayerParams	按业务校验	Application Layer parameters.
device_id	string	按业务校验	Device-profile device ID (UUID) (optiona).
firmware_version	string	按业务校验	Firmware version.
supported_uplink_data_rates	repeated uint32	按业务校验	Supported uplink data-rates. This option configures the data-rates that are supported by the devices using this device-profile. If not set, the default min / max data-rates will be used. Example: In case you would like to use also SF5 and SF6 in EU868, you would set this option to: 0, 1, 2, 3, 4, 5, 6, 7, 12, 13.

api.DeviceProfile.MeasurementsEntry

名称	类型	必填	说明
key	string	按业务校验	消息定义未补充字段说明。
value	api.Measurement	按业务校验	消息定义未补充字段说明。

api.DeviceProfile.TagsEntry

名称	类型	必填	说明
key	string	按业务校验	消息定义未补充字段说明。
value	string	按业务校验	消息定义未补充字段说明。

api.DeviceProfileDevice

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Device ID (UUID).
vendor_id	string	按业务校验	Vendor ID (UUID).
name	string	按业务校验	名称。 Name.
description	string	按业务校验	描述。 Description.
metadata	map<string, string>	按业务校验	Metadata.

api.DeviceProfileDevice.MetadataEntry

名称	类型	必填	说明
key	string	按业务校验	消息定义未补充字段说明。
value	string	按业务校验	消息定义未补充字段说明。

api.DeviceProfileDeviceListItem

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Device ID (UUID).
created_at	google.protobuf.Timestamp	按业务校验	创建时间。 Created at timestamp.
updated_at	google.protobuf.Timestamp	按业务校验	最后更新时间。 Last update timestamp.
name	string	按业务校验	名称。 Name.

api.DeviceProfileListItem

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Device-profile ID (UUID).
created_at	google.protobuf.Timestamp	按业务校验	创建时间。 Created at timestamp.
updated_at	google.protobuf.Timestamp	按业务校验	最后更新时间。 Last update timestamp.
name	string	按业务校验	名称。 Name.
region	common.Region {EU868=0, US915=2, CN779=3, EU433=4, AU915=5, CN470=6, AS923=7, AS923_2=12, AS923_3=13, AS923_4=14, KR920=8, IN865=9, RU864=10, ISM2400=11}	按业务校验	区域枚举。 Region.
mac_version	common.MacVersion {LORAWAN_1_0_0=0, LORAWAN_1_0_1=1, LORAWAN_1_0_2=2, LORAWAN_1_0_3=3, LORAWAN_1_0_4=4, LORAWAN_1_1_0=5}	按业务校验	LoRaWAN MAC 版本。 LoRaWAN mac-version.
reg_params_revision	common.RegParamsRevision {A=0, B=1, RP002_1_0_0=2, RP002_1_0_1=3, RP002_1_0_2=4, RP002_1_0_3=5, RP002_1_0_4=6, RP002_1_0_5=7}	按业务校验	区域参数版本。 Regional parameters revision.
supports_otaa	bool	按业务校验	是否支持 OTAA。 Supports OTAA.
supports_class_b	bool	按业务校验	是否支持 Class B。 Supports Class-B.
supports_class_c	bool	按业务校验	是否支持 Class C。 Supports Class-C.
vendor_id	string	按业务校验	Vendor ID. This value is only available for global device-profiles.
vendor_name	string	按业务校验	Vendor name. This value is only available for global device-profiles.
device_id	string	按业务校验	Device ID. This value is only available for global device-profiles.
device_name	string	按业务校验	Device name. This value is only available for global device-profiles.
firmware_version	string	按业务校验	Firmware version.

api.DeviceProfileVendor

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Vendor ID (UUID).
name	string	按业务校验	名称。 Name.
vendor_id	uint32	按业务校验	LoRa Alliance Vendor ID.
ouis	repeated string	按业务校验	OUIs.
metadata	map<string, string>	按业务校验	Metadata.

api.DeviceProfileVendor.MetadataEntry

名称	类型	必填	说明
key	string	按业务校验	消息定义未补充字段说明。
value	string	按业务校验	消息定义未补充字段说明。

api.DeviceProfileVendorListItem

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Vendor ID (UUID).
created_at	google.protobuf.Timestamp	按业务校验	创建时间。 Created at timestamp.
updated_at	google.protobuf.Timestamp	按业务校验	最后更新时间。 Last update timestamp.
name	string	按业务校验	名称。 Name.
vendor_id	uint32	按业务校验	LoRa Alliance Vendor ID.
ouis	repeated string	按业务校验	OUIs.
metadata	map<string, string>	按业务校验	Metadata.

api.DeviceProfileVendorListItem.MetadataEntry

名称	类型	必填	说明
key	string	按业务校验	消息定义未补充字段说明。
value	string	按业务校验	消息定义未补充字段说明。

api.GetDeviceProfileByProfileIdRequest

名称	类型	必填	说明
vendor_id	uint32	按业务校验	Vendor ID.
vendor_profile_id	uint32	按业务校验	Vendor Profile ID.

api.GetDeviceProfileByProfileIdResponse

名称	类型	必填	说明
device_profile	api.DeviceProfile	按业务校验	终端模版对象。 Device-profile object.
created_at	google.protobuf.Timestamp	按业务校验	创建时间。 Created at timestamp.
updated_at	google.protobuf.Timestamp	按业务校验	最后更新时间。 Last update timestamp.

api.GetDeviceProfileDeviceRequest

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Device-profile device ID.

api.GetDeviceProfileDeviceResponse

名称	类型	必填	说明
device	api.DeviceProfileDevice	按业务校验	终端对象。 Device object.
created_at	google.protobuf.Timestamp	按业务校验	创建时间。 Created at timestamp.
updated_at	google.protobuf.Timestamp	按业务校验	最后更新时间。 Last update timestamp.

api.GetDeviceProfileRequest

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 ID (UUID).

api.GetDeviceProfileResponse

名称	类型	必填	说明
device_profile	api.DeviceProfile	按业务校验	终端模版对象。 Device-profile object.
created_at	google.protobuf.Timestamp	按业务校验	创建时间。 Created at timestamp.
updated_at	google.protobuf.Timestamp	按业务校验	最后更新时间。 Last update timestamp.

api.GetDeviceProfileVendorRequest

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Vendor ID (UUID).

api.GetDeviceProfileVendorResponse

名称	类型	必填	说明
vendor	api.DeviceProfileVendor	按业务校验	Vendor object.
created_at	google.protobuf.Timestamp	按业务校验	创建时间。 Created at timestamp.
updated_at	google.protobuf.Timestamp	按业务校验	最后更新时间。 Last update timestamp.

api.ListDeviceProfileAdrAlgorithmsResponse

名称	类型	必填	说明
total_count	uint32	按业务校验	符合条件的总条数。 Total number of algorithms.
result	repeated api.AdrAlgorithmListItem	按业务校验	结果列表或结果内容。 Result-set.

api.ListDeviceProfileDevicesRequest

名称	类型	必填	说明
limit	uint32	按业务校验	本次最多返回条数。 Max number of device-profile vendors to return in the result-set. If not set, it will be treated as 0, and the response will only return the total_count.
offset	uint32	按业务校验	分页起始偏移。 Offset in the result-set (for pagination).
vendor_id	string	按业务校验	Vendor ID (UUID).

api.ListDeviceProfileDevicesResponse

名称	类型	必填	说明
total_count	uint32	按业务校验	符合条件的总条数。 Total number of devices.
result	repeated api.DeviceProfileDeviceListItem	按业务校验	结果列表或结果内容。 Result-set.

api.ListDeviceProfileVendorsRequest

名称	类型	必填	说明
limit	uint32	按业务校验	本次最多返回条数。 Max number of device-profile vendors to return in the result-set. If not set, it will be treated as 0, and the response will only return the total_count.
offset	uint32	按业务校验	分页起始偏移。 Offset in the result-set (for pagination).

api.ListDeviceProfileVendorsResponse

名称	类型	必填	说明
total_count	uint32	按业务校验	符合条件的总条数。 Total number of vendors.
result	repeated api.DeviceProfileVendorListItem	按业务校验	结果列表或结果内容。 Result-set.

api.ListDeviceProfilesRequest

名称	类型	必填	说明
limit	uint32	按业务校验	本次最多返回条数。 Max number of device-profiles to return in the result-set. If not set, it will be treated as 0, and the response will only return the total_count.
offset	uint32	按业务校验	分页起始偏移。 Offset in the result-set (for pagination).
search	string	按业务校验	搜索关键字。 If set, the given string will be used to search on name.
tenant_id	string	按业务校验	租户 UUID。 Tenant ID to list the device-profiles for. This value must be set, unless global_only is set to true. The result will be the list of device-profiles matching the tenant_id and global tenants. If you only wish to list the device-profiles matching the tenant_id, you must set tenant_only to true.
device_id	string	按业务校验	Device-profile device ID. Note that his is the device-profile ID, not the DevEUI. This value requires global_only to be set to true.
global_only	bool	按业务校验	Only list global (non-tenant) device-profiles.
tenant_only	bool	按业务校验	Only list device-profiles matching the tenant_id.

api.ListDeviceProfilesResponse

名称	类型	必填	说明
total_count	uint32	按业务校验	符合条件的总条数。 Total number of device-profiles.
result	repeated api.DeviceProfileListItem	按业务校验	结果列表或结果内容。 Result-set.

api.Measurement

名称	类型	必填	说明
name	string	按业务校验	名称。 Name (user defined).
kind	api.MeasurementKind {UNKNOWN=0, COUNTER=1, ABSOLUTE=2, GAUGE=3, STRING=4}	按业务校验	Kind.

api.UpdateDeviceProfileRequest

名称	类型	必填	说明
device_profile	api.DeviceProfile	按业务校验	终端模版对象。 Device-profile object.