查询sdwan网络实例
接口功能介绍
查询sdwan网络实例
接口约束
无
URI
GET /v4/ec/sdwan-instance/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 是 | String | 云间高速ID | 44f33b3f-b802-4eed-912e-8aa76141ec54 | |
| sdwanID | 否 | String | sdwan ID | 212e45d0-d2ce-11ed-b8e1-005056892474 | |
| cgwID | 否 | String | 云网关ID | 44f33b3f-b802-4eed-912e-8aa76141ec54 | |
| instanceID | 否 | String | 网络实例ID | 6171e933-abfb-4acb-86cc-9ec80e768890 | |
| queryContent | 否 | String | 模糊查询，支持sdwanID，网络实例ID，云网关ID三个属性 | ||
| isAuth | 否 | Integer | 是否是跨账号实例 取值包括： 0:本账号 1:跨账号 |
0 |
请求参数
请求头header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码 取值范围: 800:成功 900:失败 |
800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| traceID | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentCount | 否 | Integer | 当前页记录数 | 3 | |
| totalPage | 否 | Integer | 总页数 | 1 | |
| totalCount | 否 | Integer | 查询的总记录数 | 3 | |
| results | 否 | Array of Objects | 返回查询结果，Json数组 | results |
表results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 否 | String | 云间高速ID | 66d1ad0b-a4c6-4fb8-80f5-0cb08943f49f | |
| cgwID | 否 | String | 云网关ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwName | 否 | String | 云网关名称 | cgw-nm8 | |
| dcID | 否 | String | 云网关资源池ID | 81f7728662dd11ec810800155d307d5b | |
| sdwanID | 否 | String | sdwan ID | cb57bc09-8659-12d3-601a-e251f564ea68 | |
| sdwanName | 否 | String | sdwan名称 | sdwan-network | |
| instanceID | 否 | String | 网络实例的ID | 3c17f278-e5a1-453a-a56b-c953413e4209 | |
| defaultRtbID | 否 | String | 默认路由表ID | 63695bd3-5421-4727-9d2b-60c64232085f | |
| defaultRtbName | 否 | String | 默认路由表名称 | default | |
| CIDR | 否 | List of Strings | v4 CIDR列表 | [ "50.0.0.1/24", "40.0.0.1/24"] | |
| v6CIDR | 否 | List of Strings | v6 CIDR列表 | [ "100.1::1/64", "100.2::1/64"] | |
| createDate | 否 | String | 创建时间 | 2022-09-19 02:05:28 | |
| status | 否 | String | 状态描述 取值包括： creating :加载中 running :已连接 removing :卸载中 flushing :路由待更新 error :失败 |
running | |
| weights | 否 | Integer | 权重，sdwan默认60 | 60 | |
| redundantType | 否 | Integer | 冗余类型 取值包括 1：主备 2：负载 0：无 |
1 | |
| redundantInstUUID | 否 | String | 冗余负载实例的UUID | 11200584-fe8f-49b0-9e09-ef915caeee10 | |
| redundantInstName | 否 | String | 冗余负载实例的名称 | red-instance | |
| redundantInstType | 否 | String | 冗余负载实例的类型 取值包括 2: 云专线 3: sdwan 4: vpn |
11200584-fe8f-49b0-9e09-ef915caeee10 | |
| redundantInstID | 否 | String | 冗余负载侧ID，即当前为cdaID, sdwanID，vpnID | red-instance | |
| isAuth | 否 | Integer | 是否是跨账号实例 取值包括： 0:本账号 1:跨账号 |
0 | |
| routeLearn | 否 | Integer | 路由学习开关，开启后云网关自动学习网络实例路由 取值范围: 1:学习 0:不学习 默认学习 |
1 | |
| routeSync | 否 | Integer | 路由同步开关，开启后云网关路由自动同步到网络实例 取值范围: 1:同步 0:不同步 默认同步 |
1 |
请求示例
请求url
/v4/ec/sdwan-instance/list?ecID=6949e4e6-8f92-4b05-8cae-b3977914f15b
请求头header
无
请求体body
无
响应示例
{
"description": "",
"errorCode": "",
"message": "",
"statusCode": 800,
"traceID": "2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj": {
"totalCount": 1,
"totalPage": 1,
"currentCount": 1,
"results": [{
"status": "running",
"cgwName": "caixinqi-sdwan-nm8",
"sdwanName": "test111",
"ecID": "44f33b3f-b802-4eed-912e-8aa76141ec54",
"instanceID": "42676917-f00a-447e-85b4-e35d332c0b42",
"sdwanID": "212e45d0-d2ce-11ed-b8e1-005056892474",
"createDate": "2022-09-19 02:05:28",
"dcID": "81f7728662dd11ec810800155d307d5b",
"defaultRtbID": "b4aa5a93-75cb-4bc6-a670-4b51eb0863a1",
"CIDR": ["50.0.0.1/24","40.0.0.1/24"],
"cgwID": "0a2cd1b2-0e0c-44fa-b9e8-4c340b5e0a8c",
"v6CIDR": [],
"defaultRtbName": "default",
"weights": 60,
"redundantType" : 0,
"redundantInstUUID":"",
"redundantInstName":"",
"redundantInstType":"",
"redundantInstID":"",
"isAuth":0,
"routeLearn":1,
"routeSync":1
}]
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.SdwanEc.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
