接口功能介绍
录入智能网关SN信息
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
POST /v4/sdwan/edge-sn/update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | c675dba8-d898-11ea-8c46-00505689ac50 | |
| edgeID | 是 | String | 智能网关ID | 87a74704-3efd-11ed-910d-005056893e3e | |
| serialNumberDict | 是 | Object | serialNumberDict |
表serialNumberDict
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| masterSN | 否 | String | 主edge的sn | CTCB001232034212 | |
| slaveSN | 否 | String | 备edge的sn | CTCB001232034213 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码('800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Array of Objects | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| operationID | 否 | String | 操作id | 33f488ca-a8f1-11ed-9611-005056893e3e |
请求示例
请求头header
无
请求体body
{
"regionID": "c675dba8-d898-11ea-8c46-00505689ac50",
"edgeID": "87a74704-3efd-11ed-910d-005056893e3e",
"serialNumberDict": {
"masterSN": "CTCB001232034212",
"slaveSN": "CTCB001232034213"
}
}
响应示例
{
"statusCode": 800,
"returnObj": [
{
"operationID": "33f488ca-a8f1-11ed-9611-005056893e3e"
}
]，
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| EdgeInfo.SdwanSdwan.UpdateError | 内部错误，请重试。如果多次尝试失败，请提交工单 |
