应用与数据集成 API

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

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

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

ApplicationService

Create

接口名称： api.ApplicationService/Create

功能： 创建 对应资源。Create creates the given application.

请求： api.CreateApplicationRequest；返回： api.CreateApplicationResponse（单次响应）。

请求参数

名称	类型	必填	说明
application	api.Application	按业务校验	应用对象。 Application object to create.

返回值

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

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

Get

接口名称： api.ApplicationService/Get

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

请求： api.GetApplicationRequest；返回： api.GetApplicationResponse（单次响应）。

请求参数

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

返回值

名称	类型	必填	说明
application	api.Application	按业务校验	应用对象。 Application object.
created_at	google.protobuf.Timestamp	按业务校验	创建时间。 Created at timestamp.
updated_at	google.protobuf.Timestamp	按业务校验	最后更新时间。 Last update timestamp.
measurement_keys	repeated string	按业务校验	Measurement keys. This contains the measurement keys from all the device-profiles that are used by the devices under this application.

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

Update

接口名称： api.ApplicationService/Update

功能： 更新 对应资源。Update updates the given application.

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

请求参数

名称	类型	必填	说明
application	api.Application	按业务校验	应用对象。 Application object.

返回值

无字段。

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

Delete

接口名称： api.ApplicationService/Delete

功能： 删除 对应资源。Delete the application for the given ID.

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

请求参数

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

返回值

无字段。

操作影响

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

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

List

接口名称： api.ApplicationService/List

功能： 列出 对应资源。Get the list of applications.

请求： api.ListApplicationsRequest；返回： api.ListApplicationsResponse（单次响应）。

请求参数

名称	类型	必填	说明
limit	uint32	按业务校验	本次最多返回条数。 Max number of applications 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 (optional).
tenant_id	string	按业务校验	租户 UUID。 Tenant ID to list the applications for.

返回值

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

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

ListIntegrations

接口名称： api.ApplicationService/ListIntegrations

功能： 列出 Integrations。List all configured integrations.

请求： api.ListIntegrationsRequest；返回： api.ListIntegrationsResponse（单次响应）。

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

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

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

CreateHttpIntegration

接口名称： api.ApplicationService/CreateHttpIntegration

功能： 创建 HttpIntegration。Create HTTP integration.

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

请求参数

名称	类型	必填	说明
integration	api.HttpIntegration	按业务校验	Integration object to create.

返回值

无字段。

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

GetHttpIntegration

接口名称： api.ApplicationService/GetHttpIntegration

功能： 查询 HttpIntegration。Get the configured HTTP integration.

请求： api.GetHttpIntegrationRequest；返回： api.GetHttpIntegrationResponse（单次响应）。

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

名称	类型	必填	说明
integration	api.HttpIntegration	按业务校验	Integration object.

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

UpdateHttpIntegration

接口名称： api.ApplicationService/UpdateHttpIntegration

功能： 更新 HttpIntegration。Update the HTTP integration.

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

请求参数

名称	类型	必填	说明
integration	api.HttpIntegration	按业务校验	Integration object to update.

返回值

无字段。

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

DeleteHttpIntegration

接口名称： api.ApplicationService/DeleteHttpIntegration

功能： 删除 HttpIntegration。Delete the HTTP integration.

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

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

无字段。

操作影响

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

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

CreateInfluxDbIntegration

接口名称： api.ApplicationService/CreateInfluxDbIntegration

功能： 创建 InfluxDbIntegration。Create InfluxDb integration.

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

请求参数

名称	类型	必填	说明
integration	api.InfluxDbIntegration	按业务校验	Integration object to create.

返回值

无字段。

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

GetInfluxDbIntegration

接口名称： api.ApplicationService/GetInfluxDbIntegration

功能： 查询 InfluxDbIntegration。Get InfluxDb integration.

请求： api.GetInfluxDbIntegrationRequest；返回： api.GetInfluxDbIntegrationResponse（单次响应）。

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

名称	类型	必填	说明
integration	api.InfluxDbIntegration	按业务校验	Integration object.

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

UpdateInfluxDbIntegration

接口名称： api.ApplicationService/UpdateInfluxDbIntegration

功能： 更新 InfluxDbIntegration。Update InfluxDb integration.

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

请求参数

名称	类型	必填	说明
integration	api.InfluxDbIntegration	按业务校验	Integration object to update.

返回值

无字段。

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

DeleteInfluxDbIntegration

接口名称： api.ApplicationService/DeleteInfluxDbIntegration

功能： 删除 InfluxDbIntegration。Delete InfluxDb integration.

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

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

无字段。

操作影响

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

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

CreateThingsBoardIntegration

接口名称： api.ApplicationService/CreateThingsBoardIntegration

功能： 创建 ThingsBoardIntegration。Create ThingsBoard integration.

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

请求参数

名称	类型	必填	说明
integration	api.ThingsBoardIntegration	按业务校验	Integration object to create.

返回值

无字段。

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

GetThingsBoardIntegration

接口名称： api.ApplicationService/GetThingsBoardIntegration

功能： 查询 ThingsBoardIntegration。Get ThingsBoard integration.

请求： api.GetThingsBoardIntegrationRequest；返回： api.GetThingsBoardIntegrationResponse（单次响应）。

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

名称	类型	必填	说明
integration	api.ThingsBoardIntegration	按业务校验	Integration object.

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

UpdateThingsBoardIntegration

接口名称： api.ApplicationService/UpdateThingsBoardIntegration

功能： 更新 ThingsBoardIntegration。Update ThingsBoard integration.

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

请求参数

名称	类型	必填	说明
integration	api.ThingsBoardIntegration	按业务校验	Integration object to update.

返回值

无字段。

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

DeleteThingsBoardIntegration

接口名称： api.ApplicationService/DeleteThingsBoardIntegration

功能： 删除 ThingsBoardIntegration。Delete ThingsBoard integration.

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

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

无字段。

操作影响

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

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

CreateMyDevicesIntegration

接口名称： api.ApplicationService/CreateMyDevicesIntegration

功能： 创建 MyDevicesIntegration。Create myDevices integration.

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

请求参数

名称	类型	必填	说明
integration	api.MyDevicesIntegration	按业务校验	Integration object to create.

返回值

无字段。

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

GetMyDevicesIntegration

接口名称： api.ApplicationService/GetMyDevicesIntegration

功能： 查询 MyDevicesIntegration。Get myDevices integration.

请求： api.GetMyDevicesIntegrationRequest；返回： api.GetMyDevicesIntegrationResponse（单次响应）。

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

名称	类型	必填	说明
integration	api.MyDevicesIntegration	按业务校验	Integration object.

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

UpdateMyDevicesIntegration

接口名称： api.ApplicationService/UpdateMyDevicesIntegration

功能： 更新 MyDevicesIntegration。Update myDevices integration.

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

请求参数

名称	类型	必填	说明
integration	api.MyDevicesIntegration	按业务校验	Integration object to update.

返回值

无字段。

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

DeleteMyDevicesIntegration

接口名称： api.ApplicationService/DeleteMyDevicesIntegration

功能： 删除 MyDevicesIntegration。Delete myDevices integration.

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

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

无字段。

操作影响

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

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

CreateGcpPubSubIntegration

接口名称： api.ApplicationService/CreateGcpPubSubIntegration

功能： 创建 GcpPubSubIntegration。Create GCP Pub/Sub integration.

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

请求参数

名称	类型	必填	说明
integration	api.GcpPubSubIntegration	按业务校验	Integration object to create.

返回值

无字段。

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

GetGcpPubSubIntegration

接口名称： api.ApplicationService/GetGcpPubSubIntegration

功能： 查询 GcpPubSubIntegration。Get GCP Pub/Sub integration.

请求： api.GetGcpPubSubIntegrationRequest；返回： api.GetGcpPubSubIntegrationResponse（单次响应）。

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

名称	类型	必填	说明
integration	api.GcpPubSubIntegration	按业务校验	Integration object.

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

UpdateGcpPubSubIntegration

接口名称： api.ApplicationService/UpdateGcpPubSubIntegration

功能： 更新 GcpPubSubIntegration。Update GCP Pub/Sub integration.

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

请求参数

名称	类型	必填	说明
integration	api.GcpPubSubIntegration	按业务校验	Integration object to update.

返回值

无字段。

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

DeleteGcpPubSubIntegration

接口名称： api.ApplicationService/DeleteGcpPubSubIntegration

功能： 删除 GcpPubSubIntegration。Delete GCP Pub/Sub integration.

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

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

无字段。

操作影响

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

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

CreateAwsSnsIntegration

接口名称： api.ApplicationService/CreateAwsSnsIntegration

功能： 创建 AwsSnsIntegration。Create AWS SNS integration.

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

请求参数

名称	类型	必填	说明
integration	api.AwsSnsIntegration	按业务校验	Integration object to create.

返回值

无字段。

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

GetAwsSnsIntegration

接口名称： api.ApplicationService/GetAwsSnsIntegration

功能： 查询 AwsSnsIntegration。Get AWS SNS integration.

请求： api.GetAwsSnsIntegrationRequest；返回： api.GetAwsSnsIntegrationResponse（单次响应）。

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

名称	类型	必填	说明
integration	api.AwsSnsIntegration	按业务校验	Integration object.

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

UpdateAwsSnsIntegration

接口名称： api.ApplicationService/UpdateAwsSnsIntegration

功能： 更新 AwsSnsIntegration。Update AWS SNS integration.

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

请求参数

名称	类型	必填	说明
integration	api.AwsSnsIntegration	按业务校验	Integration object to update.

返回值

无字段。

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

DeleteAwsSnsIntegration

接口名称： api.ApplicationService/DeleteAwsSnsIntegration

功能： 删除 AwsSnsIntegration。Delete AWS SNS integration.

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

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

无字段。

操作影响

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

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

CreateAzureServiceBusIntegration

接口名称： api.ApplicationService/CreateAzureServiceBusIntegration

功能： 创建 AzureServiceBusIntegration。Create Azure Service-Bus integration.

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

请求参数

名称	类型	必填	说明
integration	api.AzureServiceBusIntegration	按业务校验	Integration object to create.

返回值

无字段。

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

GetAzureServiceBusIntegration

接口名称： api.ApplicationService/GetAzureServiceBusIntegration

功能： 查询 AzureServiceBusIntegration。Get Azure Service-Bus integration.

请求： api.GetAzureServiceBusIntegrationRequest；返回： api.GetAzureServiceBusIntegrationResponse（单次响应）。

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

名称	类型	必填	说明
integration	api.AzureServiceBusIntegration	按业务校验	Integration object.

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

UpdateAzureServiceBusIntegration

接口名称： api.ApplicationService/UpdateAzureServiceBusIntegration

功能： 更新 AzureServiceBusIntegration。Update Azure Service-Bus integration.

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

请求参数

名称	类型	必填	说明
integration	api.AzureServiceBusIntegration	按业务校验	Integration object to create.

返回值

无字段。

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

DeleteAzureServiceBusIntegration

接口名称： api.ApplicationService/DeleteAzureServiceBusIntegration

功能： 删除 AzureServiceBusIntegration。Delete Azure Service-Bus integration.

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

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

无字段。

操作影响

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

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

CreatePilotThingsIntegration

接口名称： api.ApplicationService/CreatePilotThingsIntegration

功能： 创建 PilotThingsIntegration。Create Pilot Things integration.

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

请求参数

名称	类型	必填	说明
integration	api.PilotThingsIntegration	按业务校验	Integration object to create.

返回值

无字段。

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

GetPilotThingsIntegration

接口名称： api.ApplicationService/GetPilotThingsIntegration

功能： 查询 PilotThingsIntegration。Get Pilot Things integration.

请求： api.GetPilotThingsIntegrationRequest；返回： api.GetPilotThingsIntegrationResponse（单次响应）。

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

名称	类型	必填	说明
integration	api.PilotThingsIntegration	按业务校验	Integration object.

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

UpdatePilotThingsIntegration

接口名称： api.ApplicationService/UpdatePilotThingsIntegration

功能： 更新 PilotThingsIntegration。Update Pilot Things integration.

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

请求参数

名称	类型	必填	说明
integration	api.PilotThingsIntegration	按业务校验	Integration object to update.

返回值

无字段。

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

DeletePilotThingsIntegration

接口名称： api.ApplicationService/DeletePilotThingsIntegration

功能： 删除 PilotThingsIntegration。Delete Pilot Things integration.

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

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

无字段。

操作影响

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

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

CreateIftttIntegration

接口名称： api.ApplicationService/CreateIftttIntegration

功能： 创建 IftttIntegration。Create IFTTT integration.

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

请求参数

名称	类型	必填	说明
integration	api.IftttIntegration	按业务校验	Integration object.

返回值

无字段。

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

GetIftttIntegration

接口名称： api.ApplicationService/GetIftttIntegration

功能： 查询 IftttIntegration。Get IFTTT integration.

请求： api.GetIftttIntegrationRequest；返回： api.GetIftttIntegrationResponse（单次响应）。

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

名称	类型	必填	说明
integration	api.IftttIntegration	按业务校验	Integration object.

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

UpdateIftttIntegration

接口名称： api.ApplicationService/UpdateIftttIntegration

功能： 更新 IftttIntegration。Update IFTTT integration.

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

请求参数

名称	类型	必填	说明
integration	api.IftttIntegration	按业务校验	Integration object to update.

返回值

无字段。

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

DeleteIftttIntegration

接口名称： api.ApplicationService/DeleteIftttIntegration

功能： 删除 IftttIntegration。Delete IFTTT integration.

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

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

无字段。

操作影响

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

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

CreateBlynkIntegration

接口名称： api.ApplicationService/CreateBlynkIntegration

功能： 创建 BlynkIntegration。Create Blynk integration.

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

请求参数

名称	类型	必填	说明
integration	api.BlynkIntegration	按业务校验	Integration object to create.

返回值

无字段。

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

GetBlynkIntegration

接口名称： api.ApplicationService/GetBlynkIntegration

功能： 查询 BlynkIntegration。Get Blynk integration.

请求： api.GetBlynkIntegrationRequest；返回： api.GetBlynkIntegrationResponse（单次响应）。

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

名称	类型	必填	说明
integration	api.BlynkIntegration	按业务校验	Integration object.

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

UpdateBlynkIntegration

接口名称： api.ApplicationService/UpdateBlynkIntegration

功能： 更新 BlynkIntegration。Update Blynk integration.

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

请求参数

名称	类型	必填	说明
integration	api.BlynkIntegration	按业务校验	Integration object to update.

返回值

无字段。

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

DeleteBlynkIntegration

接口名称： api.ApplicationService/DeleteBlynkIntegration

功能： 删除 BlynkIntegration。Delete Blynk integration.

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

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

无字段。

操作影响

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

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

GenerateMqttIntegrationClientCertificate

接口名称： api.ApplicationService/GenerateMqttIntegrationClientCertificate

功能： 生成 MqttIntegrationClientCertificate。Generates application ID specific client-certificate.

请求： api.GenerateMqttIntegrationClientCertificateRequest；返回： api.GenerateMqttIntegrationClientCertificateResponse（单次响应）。

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

名称	类型	必填	说明
tls_cert	string	按业务校验	TLS 证书。 TLS certificate.
tls_key	string	按业务校验	TLS 私钥。 TLS key.
ca_cert	string	按业务校验	CA 证书。 CA certificate.
expires_at	google.protobuf.Timestamp	按业务校验	过期时间。 Expires at defines the expiration date of the certificate.

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

ListDeviceProfiles

接口名称： api.ApplicationService/ListDeviceProfiles

功能： 列出 DeviceProfiles。List device-profiles used within the given application.

请求： api.ListApplicationDeviceProfilesRequest；返回： api.ListApplicationDeviceProfilesResponse（单次响应）。

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

名称	类型	必填	说明
result	repeated api.ApplicationDeviceProfileListItem	按业务校验	结果列表或结果内容。 Device-profiles.

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

ListDeviceTags

接口名称： api.ApplicationService/ListDeviceTags

功能： 列出 DeviceTags。List device tags used within the given application.

请求： api.ListApplicationDeviceTagsRequest；返回： api.ListApplicationDeviceTagsResponse（单次响应）。

请求参数

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

返回值

名称	类型	必填	说明
result	repeated api.ApplicationDeviceTagListItem	按业务校验	结果列表或结果内容。 Device tags.

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

嵌套消息结构

api.Application

名称	类型	必填	说明
id	string	按业务校验	资源 ID。 Application ID (UUID). Note: on create this will be automatically generated.
name	string	按业务校验	名称。 Application name.
description	string	按业务校验	描述。 Application description.
tenant_id	string	按业务校验	租户 UUID。 Tenant ID (UUID).
tags	map<string, string>	按业务校验	自定义字符串标签。 Tags (user defined). These tags can be used to add additional information to the application. These tags are exposed in all the integration events of devices under this application.

api.Application.TagsEntry

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

api.ApplicationDeviceProfileListItem

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

api.ApplicationDeviceTagListItem

名称	类型	必填	说明
key	string	按业务校验	Tag key.
values	repeated string	按业务校验	Used values.

api.ApplicationListItem

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

api.AwsSnsIntegration

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).
encoding	api.Encoding {JSON=0, PROTOBUF=1}	按业务校验	Encoding.
region	string	按业务校验	区域枚举。 AWS region.
access_key_id	string	按业务校验	AWS Access Key ID.
secret_access_key	string	按业务校验	AWS Secret Access Key.
topic_arn	string	按业务校验	Topic ARN.

api.AzureServiceBusIntegration

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).
encoding	api.Encoding {JSON=0, PROTOBUF=1}	按业务校验	Encoding.
connection_string	string	按业务校验	Connection string.
publish_name	string	按业务校验	Publish name. This is the name of the topic or queue.

api.BlynkIntegration

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).
token	string	按业务校验	API 调用令牌。 Blynk integration token.

api.CreateApplicationRequest

名称	类型	必填	说明
application	api.Application	按业务校验	应用对象。 Application object to create.

api.CreateApplicationResponse

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

api.CreateAwsSnsIntegrationRequest

名称	类型	必填	说明
integration	api.AwsSnsIntegration	按业务校验	Integration object to create.

api.CreateAzureServiceBusIntegrationRequest

名称	类型	必填	说明
integration	api.AzureServiceBusIntegration	按业务校验	Integration object to create.

api.CreateBlynkIntegrationRequest

名称	类型	必填	说明
integration	api.BlynkIntegration	按业务校验	Integration object to create.

api.CreateGcpPubSubIntegrationRequest

名称	类型	必填	说明
integration	api.GcpPubSubIntegration	按业务校验	Integration object to create.

api.CreateHttpIntegrationRequest

名称	类型	必填	说明
integration	api.HttpIntegration	按业务校验	Integration object to create.

api.CreateIftttIntegrationRequest

名称	类型	必填	说明
integration	api.IftttIntegration	按业务校验	Integration object.

api.CreateInfluxDbIntegrationRequest

名称	类型	必填	说明
integration	api.InfluxDbIntegration	按业务校验	Integration object to create.

api.CreateMyDevicesIntegrationRequest

名称	类型	必填	说明
integration	api.MyDevicesIntegration	按业务校验	Integration object to create.

api.CreatePilotThingsIntegrationRequest

名称	类型	必填	说明
integration	api.PilotThingsIntegration	按业务校验	Integration object to create.

api.CreateThingsBoardIntegrationRequest

名称	类型	必填	说明
integration	api.ThingsBoardIntegration	按业务校验	Integration object to create.

api.DeleteApplicationRequest

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

api.DeleteAwsSnsIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.DeleteAzureServiceBusIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.DeleteBlynkIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.DeleteGcpPubSubIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.DeleteHttpIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.DeleteIftttIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.DeleteInfluxDbIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.DeleteMyDevicesIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.DeletePilotThingsIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.DeleteThingsBoardIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.GcpPubSubIntegration

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).
encoding	api.Encoding {JSON=0, PROTOBUF=1}	按业务校验	Encoding.
credentials_file	string	按业务校验	Credentials file. This IAM service-account credentials file (JSON) must have the following Pub/Sub roles: * Pub/Sub Publisher
project_id	string	按业务校验	Project ID.
topic_name	string	按业务校验	Topic name. This is the name of the Pub/Sub topic.

api.GenerateMqttIntegrationClientCertificateRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.GenerateMqttIntegrationClientCertificateResponse

名称	类型	必填	说明
tls_cert	string	按业务校验	TLS 证书。 TLS certificate.
tls_key	string	按业务校验	TLS 私钥。 TLS key.
ca_cert	string	按业务校验	CA 证书。 CA certificate.
expires_at	google.protobuf.Timestamp	按业务校验	过期时间。 Expires at defines the expiration date of the certificate.

api.GetApplicationRequest

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

api.GetApplicationResponse

名称	类型	必填	说明
application	api.Application	按业务校验	应用对象。 Application object.
created_at	google.protobuf.Timestamp	按业务校验	创建时间。 Created at timestamp.
updated_at	google.protobuf.Timestamp	按业务校验	最后更新时间。 Last update timestamp.
measurement_keys	repeated string	按业务校验	Measurement keys. This contains the measurement keys from all the device-profiles that are used by the devices under this application.

api.GetAwsSnsIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.GetAwsSnsIntegrationResponse

名称	类型	必填	说明
integration	api.AwsSnsIntegration	按业务校验	Integration object.

api.GetAzureServiceBusIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.GetAzureServiceBusIntegrationResponse

名称	类型	必填	说明
integration	api.AzureServiceBusIntegration	按业务校验	Integration object.

api.GetBlynkIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.GetBlynkIntegrationResponse

名称	类型	必填	说明
integration	api.BlynkIntegration	按业务校验	Integration object.

api.GetGcpPubSubIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.GetGcpPubSubIntegrationResponse

名称	类型	必填	说明
integration	api.GcpPubSubIntegration	按业务校验	Integration object.

api.GetHttpIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.GetHttpIntegrationResponse

名称	类型	必填	说明
integration	api.HttpIntegration	按业务校验	Integration object.

api.GetIftttIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.GetIftttIntegrationResponse

名称	类型	必填	说明
integration	api.IftttIntegration	按业务校验	Integration object.

api.GetInfluxDbIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.GetInfluxDbIntegrationResponse

名称	类型	必填	说明
integration	api.InfluxDbIntegration	按业务校验	Integration object.

api.GetMyDevicesIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.GetMyDevicesIntegrationResponse

名称	类型	必填	说明
integration	api.MyDevicesIntegration	按业务校验	Integration object.

api.GetPilotThingsIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.GetPilotThingsIntegrationResponse

名称	类型	必填	说明
integration	api.PilotThingsIntegration	按业务校验	Integration object.

api.GetThingsBoardIntegrationRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.GetThingsBoardIntegrationResponse

名称	类型	必填	说明
integration	api.ThingsBoardIntegration	按业务校验	Integration object.

api.HttpIntegration

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).
headers	map<string, string>	按业务校验	HTTP headers to set when making requests.
encoding	api.Encoding {JSON=0, PROTOBUF=1}	按业务校验	Payload encoding.
event_endpoint_url	string	按业务校验	Event endpoint URL. The HTTP integration will POST all events to this enpoint. The request will contain a query parameters "event" containing the type of the event.

api.HttpIntegration.HeadersEntry

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

api.IftttIntegration

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).
key	string	按业务校验	Key. This key can be obtained from the IFTTT Webhooks documentation page.
uplink_values	repeated string	按业务校验	Values. Up to 2 values can be forwarded to IFTTT. These values must map to the decoded payload keys. For example: { "batteryLevel": 75.3, "buttons": [{"pressed": false}, {"pressed": true}] } You would specify the following fields: uplink_values = ["batteryLevel", "buttons_0_pressed"] Notes: The first value is always used for the DevEUI. Ignored if arbitrary_json is set to true.
arbitrary_json	bool	按业务校验	Arbitrary JSON. If set to true, ChirpStack events will be sent as-is as arbitrary JSON payload. If set to false (default), the 3 JSON values format will be used.
event_prefix	string	按业务校验	Event prefix. If set, the event name will be PREFIX_EVENT. For example if event_prefix is set to weatherstation, and uplink event will be sent as weatherstation_up to the IFTTT webhook. Note: Only characters in the A-Z, a-z and 0-9 range are allowed.

api.InfluxDbIntegration

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).
endpoint	string	按业务校验	InfluxDb API write endpoint (e.g. http://localhost:8086/write).
db	string	按业务校验	InfluxDb database name. (InfluxDb v1)
username	string	按业务校验	InfluxDb username. (InfluxDb v1)
password	string	按业务校验	密码。 InfluxDb password. (InfluxDb v1)
retention_policy_name	string	按业务校验	InfluxDb retention policy name. (InfluxDb v1)
precision	api.InfluxDbPrecision {NS=0, U=1, MS=2, S=3, M=4, H=5}	按业务校验	InfluxDb timestamp precision (InfluxDb v1).
version	api.InfluxDbVersion {INFLUXDB_1=0, INFLUXDB_2=1, INFLUXDB_3=2}	按业务校验	InfluxDb version.
token	string	按业务校验	API 调用令牌。 Token. (InfluxDb v2)
organization	string	按业务校验	Organization. (InfluxDb v2)
bucket	string	按业务校验	Bucket. (InfluxDb v2)

api.IntegrationListItem

名称	类型	必填	说明
kind	api.IntegrationKind {HTTP=0, INFLUX_DB=1, THINGS_BOARD=2, MY_DEVICES=3, GCP_PUB_SUB=5, AWS_SNS=6, AZURE_SERVICE_BUS=7, PILOT_THINGS=8, MQTT_GLOBAL=9, IFTTT=10, BLYNK=11}	按业务校验	Integration kind.

api.ListApplicationDeviceProfilesRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.ListApplicationDeviceProfilesResponse

名称	类型	必填	说明
result	repeated api.ApplicationDeviceProfileListItem	按业务校验	结果列表或结果内容。 Device-profiles.

api.ListApplicationDeviceTagsRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.ListApplicationDeviceTagsResponse

名称	类型	必填	说明
result	repeated api.ApplicationDeviceTagListItem	按业务校验	结果列表或结果内容。 Device tags.

api.ListApplicationsRequest

名称	类型	必填	说明
limit	uint32	按业务校验	本次最多返回条数。 Max number of applications 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 (optional).
tenant_id	string	按业务校验	租户 UUID。 Tenant ID to list the applications for.

api.ListApplicationsResponse

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

api.ListIntegrationsRequest

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).

api.ListIntegrationsResponse

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

api.MyDevicesIntegration

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).
endpoint	string	按业务校验	myDevices API endpoint.

api.PilotThingsIntegration

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).
server	string	按业务校验	Server URL.
token	string	按业务校验	API 调用令牌。 Authentication token.

api.ThingsBoardIntegration

名称	类型	必填	说明
application_id	string	按业务校验	应用 UUID。 Application ID (UUID).
server	string	按业务校验	ThingsBoard server endpoint, e.g. https://example.com

api.UpdateApplicationRequest

名称	类型	必填	说明
application	api.Application	按业务校验	应用对象。 Application object.

api.UpdateAwsSnsIntegrationRequest

名称	类型	必填	说明
integration	api.AwsSnsIntegration	按业务校验	Integration object to update.

api.UpdateAzureServiceBusIntegrationRequest

名称	类型	必填	说明
integration	api.AzureServiceBusIntegration	按业务校验	Integration object to create.

api.UpdateBlynkIntegrationRequest

名称	类型	必填	说明
integration	api.BlynkIntegration	按业务校验	Integration object to update.

api.UpdateGcpPubSubIntegrationRequest

名称	类型	必填	说明
integration	api.GcpPubSubIntegration	按业务校验	Integration object to update.

api.UpdateHttpIntegrationRequest

名称	类型	必填	说明
integration	api.HttpIntegration	按业务校验	Integration object to update.

api.UpdateIftttIntegrationRequest

名称	类型	必填	说明
integration	api.IftttIntegration	按业务校验	Integration object to update.

api.UpdateInfluxDbIntegrationRequest

名称	类型	必填	说明
integration	api.InfluxDbIntegration	按业务校验	Integration object to update.

api.UpdateMyDevicesIntegrationRequest

名称	类型	必填	说明
integration	api.MyDevicesIntegration	按业务校验	Integration object to update.

api.UpdatePilotThingsIntegrationRequest

名称	类型	必填	说明
integration	api.PilotThingsIntegration	按业务校验	Integration object to update.

api.UpdateThingsBoardIntegrationRequest

名称	类型	必填	说明
integration	api.ThingsBoardIntegration	按业务校验	Integration object to update.