过滤
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreateCustomizedFilter | 给指定版本添加自定义过滤条件,可以通过自定义的方式扩展版本的查询筛选能力 | 查看文档去调试 |
DescribeCustomizedFilter | 获取自定义过滤条件详情 | 查看文档去调试 |
UpdateCustomizedFilter | 更新自定义过滤条件 | 查看文档去调试 |
DeleteAllCustomizedFilters | 删除版本下所有自定义过滤条件 | 查看文档去调试 |
DeleteCustomizedFilter | 删除一个指定的自定义过滤条件 | 查看文档去调试 |
FindCustomizedFilters | 按分页查询自定义过滤条件,可根据过滤条件名进行查询 | 查看文档去调试 |
消息
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreateUpstreamAppKeyRelation![]() | 根据客户端AppKey和服务端AppKey创建上行消息客户端与服务端的映射关系 | 查看文档去调试 |
CreateUpstreamAppServer | 创建处理上行消息的服务端应用 | 查看文档去调试 |
ListMessageAcks | 根据消息id、设备id查询消息ack记录列表 | 查看文档去调试 |
ListOfflineMessages | 根据deviceId或kp查询设备离线消息列表 | 查看文档去调试 |
DescribeMessage | 根据消息ID查询消息详情。详情包括消息体内容、消息到达情况 | 查看文档去调试 |
UpdateUpstreamAppServer | 更新上行消息服务端应用名称、标签等信息 | 查看文档去调试 |
DeleteUpstreamAppKeyRelation | 根据关系ID删除上行消息应用端与服务端的关系映射记录 | 查看文档去调试 |
DeleteUpstreamAppServer | 根据记录ID删除处理上行消息的服务端应用信息 | 查看文档去调试 |
PushVersionMessage | 给某一版本下的所有机型推送升级消息 | 查看文档去调试 |
FindVersionMessages | 查询某一版本、测试或群发记录下的消息发送情况 | 查看文档去调试 |
FindVersionMessageSendRecords | 查询版本下的群发消息记录,只针对按照机型群发的消息记录的查询 | 查看文档去调试 |
应用版本
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreateAppVersion | 创建应用升级版本 | 查看文档去调试 |
GetDeviceAppUpdateFunnelEvents | 获取设备应用升级的进度信息 | 查看文档去调试 |
UpdateAppBlackWhiteVersions | 更新应用版本的版本的黑白名单 | 查看文档去调试 |
UpdateAppVersionReleaseNote | 更新应用版本的发布说明 | 查看文档去调试 |
UpdateAppVersionStatus | 测试通过、已发布、已下架、已废弃 | 查看文档去调试 |
UpdateAppVersion | 更新应用升级版本中的各项信息配置 | 查看文档去调试 |
UpdateAppVersionRemark | 在版本创建完成后,更新备注信息 | 查看文档去调试 |
PublishAppVersion | 发布应用版本,可控制是否推送升级消息 | 查看文档去调试 |
FindAppVersions | 分页获取应用版本列表 | 查看文档去调试 |
系统版本
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
AddVersionBlackDevices | 为系统版本或者应用版本添加黑名单 | 查看文档去调试 |
CreateOsVersion | 创建系统升级版本 | 查看文档去调试 |
DescribeAppVersion | 获取系统版本的详细信息 | 查看文档去调试 |
DescribeOsVersion | 获取单个系统版本的详细信息 | 查看文档去调试 |
GetDeviceSystemUpdateFunnelEvents | 获取设备系统升级的进度信息 | 查看文档去调试 |
UpdateOsBlackWhiteVersions | 更新系统版本的版本的黑白名单 | 查看文档去调试 |
UpdateOsVersion | 更新系统版本的基本信息 | 查看文档去调试 |
UpdateOsVersionReleaseNote | 更新系统版本发布说明 | 查看文档去调试 |
UpdateOsVersionRemark | 在版本创建完成后,更新系统版本的备注信息 | 查看文档去调试 |
UpdateOsVersionStatus | 切换系统版本状态 | 查看文档去调试 |
DeleteVersionBlackDevices | 删除系统版本或应用版本的设备黑名单 | 查看文档去调试 |
DeleteVersionBlackDevicesById | 根据ID删除系统版本或应用版本的设备黑名单名单 | 查看文档去调试 |
DeleteVersionWhiteDevices | 删除系统版本或应用版本的设备白名单 | 查看文档去调试 |
DeleteVersionWhiteDevicesById | 根据ID删除系统版本或应用版本的设备白名单 | 查看文档去调试 |
DelayPublishOsVersion | 定时发布系统版本 | 查看文档去调试 |
FindOsVersions | 分页获取系统版本列表 | 查看文档去调试 |
FindVersionWhiteDevices | 分页获取系统版本或应用版本的设备白名单 | 查看文档去调试 |
PublishOsVersion | 发布系统版本,可控制是否推送升级消息 | 查看文档去调试 |
Schema
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreateShadowSchema | 新建某机型的schema信息 | 查看文档去调试 |
ListShadowSchemaDeviceModels | 在新增设备范式时,根据当前的projectId获取这个项目下的所有机型列表 | 查看文档去调试 |
ListShadowSchemas | 根据项目ID、分页信息等,获取schema的分页数据 | 查看文档去调试 |
DescribeDefaultSchema | 根据机型获取默认的schema信息 | 查看文档去调试 |
DescribeDeviceValiditySchema | 根据机型获取验证schema | 查看文档去调试 |
DescribeShadowSchema | 根据机型获取schema信息 | 查看文档去调试 |
UpdateShadowSchema | 修改某机型的schema信息. | 查看文档去调试 |
DeleteShadowSchema | 删除某机型的schema信息 | 查看文档去调试 |
函数
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
AddUploadedFunctionFileInfo | 添加已经上传(先请求GenerateFunctionFileUploadMeta)的函数文件 | 查看文档去调试 |
ListDeployedFunctions | 查询已部署的函数 | 查看文档去调试 |
ListFunctionExecuteLog | 按分页列出函数执行的日志 | 查看文档去调试 |
ListFunctionFiles | 列出指定项目、指定类型的函数文件,支持分页 | 查看文档去调试 |
ListFunctionFilesByProjectId | 列出指定项目所创建的函数单文件及包文件,支持分页 | 查看文档去调试 |
DeleteFunctionFile | 删除函数文件 | 查看文档去调试 |
GenerateFunctionFileUploadMeta | 生成函数文件上传元信息 | 查看文档去调试 |
InvokeFunction | 使用InvokeFunction调用函数 | 查看文档去调试 |
DeployFunctionFile | 部署函数 | 查看文档去调试 |
设备
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
AddVersionGroupDevices | 通过云设备ID批量添加一个或多个设备到测试设备分组中 | 查看文档去调试 |
AddVersionWhiteDevices | 添加系统版本或应用版本的设备白名单 | 查看文档去调试 |
AddVersionWhiteDevicesByDeviceGroups | 通过设备分组将分组中的设备添加为版本黑白名单设备 | 查看文档去调试 |
CreateDeviceBrand | 创建设备品牌 | 查看文档去调试 |
CreateDeviceModel | 创建一个新的设备型号 | 查看文档去调试 |
CreateVersionDeviceGroup | 创建一个用于测试的设备分组 | 查看文档去调试 |
DescribeDeviceModel | 根据型号名或型号ID,获取设备型号信息 | 查看文档去调试 |
DescribeDeviceOnlineInfo | 根据设备或者账号ID(token)查询设备在线详情 | 查看文档去调试 |
DescribeDeviceShadow | 获取设备影子信息 | 查看文档去调试 |
DescribeVersionDeviceGroup | 获取一个测试设备分组的详情 | 查看文档去调试 |
QueryPrepublishPassedDeviceCount | 查询指定预发布的已查询设备数,已查询设备会根据其云设备ID进行去重 | 查看文档去调试 |
ListVersionDeviceGroups | 列出项目下的所有测试设备分组信息 | 查看文档去调试 |
ListAssistDevices | 获取连接远程诊断的设备列表 | 查看文档去调试 |
ListConnectLogs | 根据设备ID、时间范围查询设备连接日志 | 查看文档去调试 |
ListDeviceModels | 查询设备型号列表 | 查看文档去调试 |
ListDevices | 查询设备列表 | 查看文档去调试 |
ListDeviceTypes | 获取系统支持的所有设备类型列表 | 查看文档去调试 |
ListMessageReceivers | 根据消息ID查询消息设备接收对象列表 | 查看文档去调试 |
DescribeDeviceBrand | 根据品牌ID或品牌名称,查询获取设备品牌信息 | 查看文档去调试 |
DescribeDeviceIdByOuterInfo | 根据第三方设备唯一标识查询设备ID | 查看文档去调试 |
DescribeDeviceInfo | 获取设备信息 | 查看文档去调试 |
UpdateDeviceModel | 修改设备型号信息 | 查看文档去调试 |
UpdateVersionDeviceGroup | 更新测试设备分组 | 查看文档去调试 |
UpdateApiGatewayAppStatus | 修改项目关联的网关app状态 | 查看文档去调试 |
UpdateProject | 修改项目基本信息 | 查看文档去调试 |
DeleteAllVersionGroupDevices | 删除测试设备分组中的所有设备 | 查看文档去调试 |
DeleteDevice | 删除设备信息 | 查看文档去调试 |
DeleteVersionAllBlackDevices | 删除系统版本或应用版本下的所有黑名单设备 | 查看文档去调试 |
DeleteVersionAllWhiteDevices | 删除系统版本或应用版本下的所有设备白名单 | 查看文档去调试 |
DeleteVersionDeviceGroup | 删除一个测试设备分组 | 查看文档去调试 |
DeleteVersionGroupDevice | 从测试设备分组中删除一个特定设备 | 查看文档去调试 |
DeleteVersionGroupDeviceById | 根据ID删除测试分组设备 | 查看文档去调试 |
ConnectAssistDevice | 通知设备建立诊断web socket连接 | 查看文档去调试 |
CountActivatedOrNewRegistrationDevice | 支持按日、按月统计 | 查看文档去调试 |
CountDeviceBrands | 查询符合条件的设备品牌数量 | 查看文档去调试 |
CountDeviceModels | 查询设备型号数量 | 查看文档去调试 |
CountDevices | 指定机型的设备总数 | 查看文档去调试 |
CountYunIdInfo | 统计租户下的品牌数和机型数以及设备数 | 查看文档去调试 |
DiagnosisVersion | 诊断某特定设备查询不到某特定版本的原因 | 查看文档去调试 |
FindPrepublishPassedDevices | 按分页查询某一个预发布下的已查询设备的云设备ID列表 | 查看文档去调试 |
FindVersionBlackDevices | 分页获取系统版本或者应用版本的设备黑名单 | 查看文档去调试 |
PushMessage![]() | 推送消息到设备端,支持透传、通知两种消息类型 | 查看文档去调试 |
FindVersionDeviceGroups | 分页查询测试设备分组,可根据分组名、分组包含的云设备ID查询 | 查看文档去调试 |
FindVersionGroupDevices | 根据云设备ID,分页查询指定分组中的设备列表 | 查看文档去调试 |
其它
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreateRpcService![]() | 注册cmns rpc服务接口 | 查看文档去调试 |
DeleteProjectApp | 删除项目下用户创建的自定义应用 | 查看文档去调试 |
DeleteRpcService | 删除Rpc服务接口注册记录 | 查看文档去调试 |
DescribeAssistWSServerAddress | 获取WebSocket服务地址 | 查看文档去调试 |
FindPrepublishesByParentId | 查询父预发布下的子预发布 | 查看文档去调试 |
GenerateOssUploadMeta![]() | 获取文件上传OSS凭证 | 查看文档去调试 |
GenerateSysAppDownloadInfo![]() | 获取IoVCC系统应用下载信息 | 查看文档去调试 |
GetOssUploadMeta![]() | 获取上传升级包到OSS所需信息 | 查看文档去调试 |
ListApiGatewayApps | 查询项目关联的网关 APP 的信息 | 查看文档去调试 |
ListApps | 获取项目工程下应用列表 | 查看文档去调试 |
ListClientPlugins | 查询客户端插件列表 | 查看文档去调试 |
ListDeviceBrands | 查询获取品牌列表 | 查看文档去调试 |
ListPreChecks | 查询预检查结果 | 查看文档去调试 |
ListRpcServices | 查询Rpc服务接口注册记录列表 | 查看文档去调试 |
ListSupportFeatures | 查询已开通的服务列表 | 查看文档去调试 |
ListUpstreamAppKeyRelations | 查询上行消息客户端与服务端映射列表 | 查看文档去调试 |
ListUpstreamAppServers | 获取上行消息服务端应用列表 | 查看文档去调试 |
UpdateVersionPrepublishActiveStatus | 更新指定预发布禁用启用状态 | 查看文档去调试 |