接口功能介绍
查找智能网关可接入资源池信息
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
GET /v4/sdwan/edge-datacenters/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeID | 是 | String | edge id | 3a5644b2-e9c4-11eb-b46f-005056898fe0 | |
| managerType | 是 | String | 本参数表示资源池类型 取值范围: DPOP:PON类型的智能网关接入的资源池 DAGW:A8C类型的智能网关接入的资源池 |
DAGW | |
| searchName | 否 | String | edge名称模糊查找 | edge |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码('800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| result | 否 | Array of Objects | 查询edge 可接入资源池信息 | result | |
| totalCount | 否 | Integer | 总数量 | 1 | |
| currentCount | 否 | Integer | 当前页数量 | 1 |
表 result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| dcID | 否 | String | 资源池ID | 87a74704-3efd-11ed-910d-005056893e3e | |
| dcName | 否 | String | 资源池名称 | 贵州6AGWDatacenter | |
| edgeCount | 否 | Integer | 资源池接入智能网关计数 | 0 |
请求示例
请求url
/v4/sdwan/edge-datacenters/list?edgeID=3a5644b2-e9c4-11eb-b46f-005056898fe0&managerType=DAGW
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"result": [
{
"dcID": "87a74704-3efd-11ed-910d-005056893e3e",
"dcName": "贵州6AGWDatacenter",
"edgeCount": 0
}
],
"totalCount": 1,
"currentCount": 1
},
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| EdgeInfo.SdwanSdwan.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
