V2.1 Download File¶
下载单个资产的文件。
如果你在使用 API 批量更新相关文件后调用当前 API,建议两次调用间隔 2 秒左右,以免获取到未更新数据。
该 API 支持在 EnOS 2.1.0 及以上环境中使用。
操作权限¶
使用此 API 前,确保服务账号已被授予包含下列服务和操作权限的策略。有关授权服务账号的更多信息,参见 管理服务账号。
需授权的服务 |
所需操作权限 |
---|---|
资产 |
Read |
请求格式¶
GET https://{integration-address}/connect-service/v2.1/files?action=download
备注
{integration-address}:消息集成服务网关地址。该信息可登录 EnOS 管理控制台,在 帮助 > 环境信息 > HTTP 消息集成通道 中获取。
请求参数(URI)¶
备注
必须在请求参数中使用以下任意一个参数或参数组合以指定资产:
assetId
以指定一个设备或一个逻辑资产productKey
+deviceKey
以指定一个设备
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
资产所属的组织 ID。如何获取 orgId 信息>> |
fileUri |
Query |
必需 |
String |
文件下载uri,格式:enos-connect://xxxx。 |
category |
Query |
必需 |
String |
需要下载的文件类别。模型功能相关的文件,如属性、测点、事件,值为 |
assetId |
Query |
可选(见上述注解) |
String |
资产 ID。如何获取 assetId 信息>> |
productKey |
Query |
可选(见上述注解) |
String |
设备的 product key,需与 |
deviceKey |
Query |
可选(见上述注解) |
String |
设备的 device key,需与 |
请求参数(Header)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
apim-accesstoken |
必需 |
String |
通过 token 认证获取的 access token。获取方法,参见 获取 Access Token。 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
文件的二进制数据流 |
output stream |
返回文件输出流。 |
示例¶
请求示例¶
url: https://{integration-address}/connect-service/v2.1/files?action=download&orgId=yourOrgId&fileUri=yourFileUri&assetId=yourAssetId&category=feature
method: GET
requestHeader: {"apim-accesstoken":"yourAccessToken"}
SDK 示例¶
你可以在 Github 上获取接入服务的 SDK 示例: