构造请求
请求URI
请求URI由如下部分组成。
{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。
|
参数 |
说明 |
|---|---|
|
URI-scheme |
表示用于传输请求的协议，用户可选择使用http/https。 |
|
Endpoint |
指定承载REST服务端点的服务器域名或IP |
|
resource-path |
资源路径，也即API访问路径。 从具体API的URI模块获取，例如“OptVerse边缘应用”API的resource-path为“/v1/optverse/tasks”。 |
|
query-string |
查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 |
例如您要使用https协议创建任务API，则需使用所在服务器域名或IP（例：0.0.0.0:8443）并拼接resource-path（
/v1/optverse/tasks），示例如下：
https://0.0.0.0:8443/v1/optverse/tasks
用户可以通过点击应用操作列的“更多”->“监控”查看已创建应用的URL
基本信息中的URL为公网 IP 地址，代表边缘节点与云服务平台进行通信所使用的公网 IP。
若您通过其他网络路径（如局域网直连、负载均衡、域名解析等）能够访问该边缘节点，可将 URL 中的 IP 地址替换为实际可用的访问地址。
请求方法
HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。
|
方法 |
说明 |
|---|---|
|
GET |
请求服务器返回指定资源。 |
|
PUT |
请求服务器更新指定资源。 |
|
POST |
请求服务器新增资源或执行特殊操作。 |
|
DELETE |
请求服务器删除指定资源，如删除对象等。 |
|
HEAD |
请求服务器资源头部。 |
|
PATCH |
请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 |
例如，在创建任务的URI部分，您可以看到其请求方法为“POST”，则其请求为：
POST https://{{Endpoint}}/v1/optverse/tasks
请求消息头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。
如下公共消息头需要添加到请求中。
|
名称 |
说明 |
是否必选 |
示例 |
|---|---|---|---|
|
Host |
请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 |
否 使用AK/SK认证时该字段必选。 |
code.test.com or code.test.com:443 |
|
Content-Type |
发送的实体的MIME类型。 |
是 |
application/json; charset=utf-8 |
对于创建任务接口，需要在请求消息头中添加“X-Auth-Token”。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，添加消息头后的请求如下所示。
POST https://{{Endpoint}}/v1/optverse/tasks Content-Type: application/json
请求消息体
该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
{
"items": [
{
"item_id": 0,
"item_material": "18mm金丝白橡零度木刺刨花板E0",
"item_length": 60.0,
"item_width": 553.0,
"item_turn": false,
"item_num": 1,
"item_name": "F-补板/立档条",
"item_thick": 18,
"label_info": {}
}
],
"parameters": [
{
"calculate_time": 30,
"first_cut_direction": 1,
"item_backward_trim": 0.0,
"item_forward_trim": 0.0,
"kerf_horizontal": 4.4,
"kerf_vertical": 4.4,
"max_program_num": 2,
"max_stack_height": 80,
"plate_trim_horizontal": 10.0,
"plate_trim_vertical": 10.0
}
],
"plates": [
{
"plate_grain": true,
"plate_id": 0,
"plate_length": 2440.0,
"plate_material": "18mm金丝白橡零度木刺刨花板E0",
"plate_num": 9999,
"plate_thick": 18.0,
"plate_width": 1220.0
}
]
}
