更新时间:2025-12-16 GMT+08:00
分享

构造请求

请求URI

请求URI由如下部分组成。

{URI-scheme} :// {Endpoint} / {resource-path}

尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。

表1 URI中的参数说明

参数

说明

URI-scheme

表示用于传输请求的协议,用户可选择使用http/https。

Endpoint

根据实际情况可以为边缘节点的公网 IP、局域网直连、负载均衡、域名解析等

resource-path

资源路径,也即API访问路径。

从具体API的URI模块获取,例如“OptVerse边缘应用”API的resource-path为“/v1/optverse/tasks”

用户可以通过点击应用操作列的“更多”->“监控”查看已创建应用的URL

基本信息中的URL为边缘节点IP地址,代表边缘节点与云服务平台进行通信所使用的公网 IP。

若您通过其他网络路径(如局域网直连、负载均衡、域名解析等)能够访问该边缘节点,可将 URL 中的 IP 地址替换为实际可用的访问地址。

请求参数

边缘应用各算法服务的请求body参数如下:

边缘应用服务

请求参数

方形件-电子锯

二维切割-方形件-电子锯请求参数

数学规划求解器

数学优化求解器-数学规划求解器请求参数

运输计划

运输计划请求参数

注意事项:算法边缘应用的API相对于算法公有云上公开的API,不需要添加input_json父节点。

请求方法

HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。

表2 HTTP方法

方法

说明

GET

请求服务器返回指定资源。

POST

请求服务器新增资源或执行特殊操作。

例如,在创建任务的URI部分,您可以看到其请求方法为“POST”,则其请求为:

POST https://{{Endpoint}}/v1/optverse/tasks

请求消息头

附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。

如下公共消息头需要添加到请求中。

表3 公共请求消息头

名称

说明

是否必选

示例

Content-Type

发送的实体的MIME类型。

application/json; charset=utf-8

请求消息体

请求消息体通常以结构化格式(如JSONXML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。

每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。

到这里为止这个请求需要的内容就具备齐全了,您可以使用curlPostman或直接编写代码等方式发送请求调用API。

相关文档