接口功能介绍
拓扑更新坐标
接口约束
输入参数名称类长度不超过64位,描述类长度不超过128位
URI
POST /v4/sdwan/gplot/update
路径参数
无
Query参数
无
请求参数
请求header参数
无
请求body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
sdwanID | 是 | String | sdwan的id | be012e8f-ea32-4a2c-89da-7db35eedb334 | |
edges | 是 | Array Of Objects | edge坐标信息 | edges |
表edges
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
edgeID | 是 | String | 节点ID | 01fdb0ca-16bd-11ec-8dbe-005056898fe0 | |
x | 是 | String | 节点x坐标 | 180.00 | |
y | 是 | String | 节点y坐标 | 170.00 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为失败) ,默认值:800 | 800 | |
errorCode | 否 | String | 业务细分码,为product.module.code三段式码 | ||
message | 否 | String | 失败时的错误描述,一般为英文描述 | ||
description | 否 | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | 否 | Object | 返回参数 |
请求示例
请求头header
无
请求体body
{
"sdwanID": "be012e8f-ea32-4a2c-89da-7db35eedb334",
"edges": [{
"edgeID": "01fdb0ca-16bd-11ec-8dbe-005056898fe0",
"x": "180.00",
"y": "170.00"
}]
}
响应示例
{
"statusCode": 800,
"errorCode": "",
"message": "",
"description": "",
"returnObj":{}
}
状态码
状态码 | 含义 |
---|---|
200 | 请求成功 |
错误码
errorCode | 含义 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |