EdgeCall - 调用边缘服务--边缘智能-火山引擎

文档中心

立即注册

导航

EdgeCall - 调用边缘服务

最近更新时间：2025.04.22 15:34:59首次发布时间：2025.04.22 11:47:46

调用本接口向设备上的边缘服务发起请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	EdgeCall	要执行的操作，取值：EdgeCall。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
device_id	String	是	dv-2100053947-wqkrx@0000	设备ID。
module_identifier	String	是	default	物模型模块标识符。
function_identifier	String	是	Snapshot	物模型自定义功能（服务）标识符。
mode	Integer	是	3	请求类型。该参数有以下取值： 1：读取属性值 2：写入属性值 3：服务调用
input	String	否	{}	输入参数。如果是服务调用模式，需要将输入内容进行 json 转义。例如，{"x": 12,"y": 30} 转义后为 {"x": 12,"y": 30}。
show_template	Boolean	否	fasle	仅在渲染模板时使用，实际调用时为 false。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
device_id	String	dv-2100053947-wqkrx@0000	设备ID。
module_identifier	String	default	物模型模块标识符。
function_identifier	String	Snapshot	物模型自定义功能标识符。
mode	Integer	3	请求类型。该参数有以下取值： 1：读取属性 2：写入属性 3：服务调用
origin	Long	1744947454	请求的秒级时间戳。
template	String		渲染结果。仅适用于请求参数 mode 为 3 且 show_template 为 true 的情形。
output	Object		本次调用的返回结果。

请求示例

POST /?Action=EdgeCall&Version=2022-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250418T034150Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250418/cn-beijing/vei_api/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "device_id": "dv-2100053947-wqkrx@0000",
  "module_identifier": "default",
  "function_identifier": "Snapshot",
  "mode": 3,
  "input": "{}",
  "show_template": true
}

返回示例

"Result": {
        "device_id": "dv-2100053947-rrvm5",
        "module_identifier": "default",
        "function_identifier": "Snapshot",
        "mode": 3,
        "origin": 1713420451,
        "output": {
            "api_version": "v2",
            "message": "",
            "status_code": 200,
            "reading": {
                "id": "c31d85ce-cf70-4b88-873a-9bcf8cc373ae",
                "origin": 1713420476765113964,
                "type": "Object",
                "value": "{\"result\":\"data:image/jpeg;base64,/9j//gARTGF2YzU3LjEwNy4xMsy5UhmZTWZdcsdDHQtlNFpHGvRFhEtyoER1WrklyrcdzLS1cdyk2RY48URsp3BuIb3EF71xLnuZPsq3N5m8Nk93WOSjq7CNPdwj2e96HLNyk+87mo6+LzX1Pwuyr1J/dXApW8Qgjrjy3rWDNMNOTRjGVGDGMBmGmAYMYwjBjGAxgjAYxjAYxjA0wZgDMNBA0YxgKdLK7OScsc78zqajwUjlqavKPqGn/9k=\"}"
            }
        }
    }

错误码

您可访问公共错误码，获取更多错误码信息。