#

文档信息

字段 内容
关联产品 [[DTS]]
服务名称 Microservice-DigitalTwin-Center
接口类型 对外开放接口
协议类型 HTTP
当前版本 v1.0.0
维护人 产品组
适用对象 后端开发 / 第三方集成商

服务接口简介

获取指定产品的指定实体（设备）详细信息，包括实体基本元数据（如名称、状态、密钥、唯一标识符）及其最新的动态上报属性（在 payload 字段中返回）。

接口信息

项 内容
方法 POST
路径 /bv-microservice-digitaltwin-center/api/entity/details
协议 HTTP
是否鉴权 是
幂等性 否
超时时间建议 5s

请求参数

请求体：

字段 类型 是否必填 说明 示例
deviceId true 是 设备id（产品下唯一） -
productId true 是 产品id -

请求体示例：

{

  "deviceId": "",
  "productId": ""
}

响应参数

无响应参数。

调用示例

curl 示例：

curl -X POST "http://<Host>/bv-microservice-digitaltwin-center/api/entity/details" \
  -H "bv-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

接口错误码

错误码 HTTP 状态 场景 处理建议
400 400 参数错误或缺失 检查参数字段和必填项
401 401 未授权 检查请求头 bv-api-key
403 403 无权限 检查接口授权
404 404 接口不存在 检查调用 URL

备注

  • 前置条件：API Key 已在“通用用户系统”中创建并关联了相应的 DTS 权限。
  • 副作用：无。
作者：北京-产品-yantings  创建时间：2025-11-26 10:23
最后编辑：北京-产品-yantings  更新时间：2026-09-22 14:40
上一篇：
下一篇：