errcode

string

0~64个字符。

-

错误码。

"0"

errmsg

string

0~256个字符。

-

错误信息。

"参数非法"

data

REFERENCE

详细请参见表3。

返回数据

-

id

uuid

36个字符。

-

网络规划主键ID。

"bc1846c5-2eff-6d4d-2a2d-23dff3d12344"

siteId

uuid

36个字符。

-

站点ID。

"acc846c5-2fff-694d-2b2d-12dff3d1231a"

tenantId

string

32个字符。

-

租户ID。

"fbb684c80d37496fbafa4b06d5151e2e"

progress

integer

[0-100]

-

网络规划创建进度。取值范围0-100，100表示资源创建完成。

0

deviceCreationResult

REFERENCE

详细请参见表4。

-

-

boardCreationResult

REFERENCE

详细请参见表9。

-

-

linkCreationResult

REFERENCE

详细请参见表12。

-

-

stackCreationResult

REFERENCE

详细请参见表15。

-

-

mlagGroupCreationResult

REFERENCE

详细请参见表18。

-

-

successList

ARRAY_REFERENCE

0-500个列表项，详细请参见表5。

创建设备成功列表

-

failedList

ARRAY_REFERENCE

0-500个列表项，详细请参见表6。

创建设备失败列表

-

order

int32

[0-500]

-

设备序号

0

id

uuid

36个字符。

-

设备id，UUID格式。

"813a76d4-6eec-4264-ae45-a6f261482b60"

name

string

1~64个字符。

-

设备名称。最多允许输入64个字符。设备名称不能重复。

"device1"

esn

string

0~40个字符。

-

设备ESN。10~40个字符，由英文字母和数字组成。如果“ESN”为空，则“设备名称”和“设备型号”为必填字段。如果“ESN”不为空，也推荐填写“设备型号”，否则可能添加失败。

"AA980106121234567893"

type

string

0~32个字符。

-

设备型号。

"S12704"

deviceRole

string

0~32个字符。满足正则表达^(CORE|Gateway|Gateway\+CORE|Gateway\+vRR|Firewall|ACC|AGG|WAC|AP|)$。

ACC

设备角色，取值：CORE|Gateway|Gateway+CORE|Gateway+vRR|Firewall|ACC|AGG|WAC|AP

"ACC"

description

string

0~255个字符。

-

描述

"ACC1"

stackName

string

0~64个字符。

-

堆叠名称。（堆叠设备必填，非堆叠设备无需填写），不能包含“？”'、"?"或制表符TAB

"ACC1"

stackSlotId

int32

[0-9]

-

（堆叠设备必填，非堆叠设备无需填写）盒式设备范围为0~9，框式设备范围为1~2，并且同一堆叠内的堆叠编号不重复。

1

stackPriority

int32

[1-255]

100

堆叠优先级。（非必填）请输入数字，范围为1~255。如果堆叠设备此字段不填写，默认为100

2

wacEsn

string

0~40个字符。

-

WAC设备ESN。（非必填）由英文字母和数字组成。将Fit Ap设备与所填写的WAC ESN关联。

"AA980106121234567893"

wacName

string

0~64个字符。

-

WAC设备名称。

"device1"

mlagName

string

0~64个字符。

-

M-LAG组名称。(非必填) 1、相同MLAG组名称的设备,自动组成M-LAG设备组 2、DFS Group ID默认为1, 随机生成认证密码, 优先级随机取一台为150 3、成员口为双活模式。最多允许输入64个字符。

"mlag1"

mlagMode

string

0~20个字符。满足正则表达^(active-active|active-standby|)$。

-

M-LAG模式,active-active / active-standby。

"active-active"

mlagPriority

int32

[1-255]

-

M-LAG优先级。

2

errcode

REFERENCE

详细请参见表7。

错误码

-

errmsg

REFERENCE

详细请参见表8。

错误描述

-

topoPlanDeviceDto

REFERENCE

详细请参见表5。

设备创建失败信息

-

Errcode

string

0~36个字符。

-

错误码

-

Errmsg

string

0~256个字符。

-

错误描述

-

successList

ARRAY_REFERENCE

0-500个列表项，详细请参见表10。

创建单板成功列表

-

failedList

ARRAY_REFERENCE

0-500个列表项，详细请参见表11。

创建单板失败列表

-

devId

string

36个字符。

-

设备id，UUID格式。

"813a76d4-6eec-4264-ae45-a6f261482b60"

deviceName

string

1~64个字符。

-

设备名称。（必填）堆叠设备支持填写设备名称或堆叠名称。

"21500829352SH1904172"

slotId

string

0~8个字符。

-

堆叠编号，v5盒式设备为0-8，pnf盒式设备为1-9,框式设备为1-2。

"slot1/4"

slotType

string

1~12个字符。

-

单板型号。

"LSG7SRUEX500"

errcode

REFERENCE

详细请参见表7。

错误码

-

errmsg

REFERENCE

详细请参见表8。

错误描述

-

topoPlanBoardDto

REFERENCE

详细请参见表10。

创建单板失败信息

-

successList

ARRAY_REFERENCE

0-2000个列表项，详细请参见表13。

创建链路成功列表

-

failedList

ARRAY_REFERENCE

0-2000个列表项，详细请参见表14。

创建链路失败列表

-

order

int32

[0-2000]

-

设备链路序号

0

srcPortName

string

1~30个字符。

-

上游设备物理端口号。设备真实存在的物理端口

"GigabitEthernet0/0/1"

srcDevName

string

1~64个字符。

-

上游设备名称。堆叠设备支持填写设备名称或堆叠名称。

"device1"

srcEthTrunk

string

0~14个字符。

-

上游设备端Eth-Trunk名称。（Eth-Trunk链路必填）Eth-Trunk1~1023之间的整数。当前接口是下行接口，除M-LAG Peer-Link与双主检测链路外，均默认开启Eth-Trunk自协商（单设备的Eth-Trunk不可重复使用）

"Eth-Trunk1"

srcEthPnpStartSwitchEnable

boolean

• true

• false

false

源EthTrunk PNP启动开关使能。

false

dstPortName

string

1~30个字符。

-

下游设备物理端口号。设备真实存在的物理端口

"GigabitEthernet1/0/1"

dstDevName

string

1~64个字符。

-

下游设备名称。（必填）最多允许输入64个字符。堆叠设备支持填写设备名称或堆叠名称。

"device2"

dstEthTrunk

string

0~14个字符。

-

下游设备端Eth-Trunk名称。（Eth-Trunk链路必填）Eth-Trunk1~1023之间的整数（单设备的Eth-Trunk不可重复使用）

"Eth-Trunk2"

dstEthPnpStartSwitchEnable

boolean

• true

• false

false

目的EthTrunk PNP启动开关使能。

false

mlagLinkType

string

0~24个字符。满足正则表达^(peer-link|member-link|dual-active-detect-link|)$。

-

M-LAG链路类型。peer-link|member-link|dual-active-detect-link

"peer-link"

mlagIpPoolName

string

0~32个字符。

-

双主检测链路IP资源池。(M-LAG链路类型为双主检测链路时必填)允许输入1~32位英文字母、数字或特殊符号(问号和空格除外)

"pool1"

mlagId

string

0~12个字符。

-

上、下游端口M-LAG ID。(非必填)双归接入端口跨设备定义为相同的ID，M-LAG ID取值范围1-2048。上、下游值需用","分隔，同时指定。上下游端口M-LAG ID输入示例 "1,2"， 指定上游端口M-LAG ID示例 "1"

"1,2"

errcode

REFERENCE

详细请参见表7。

错误码

-

errmsg

REFERENCE

详细请参见表8。

错误描述

-

topoPlanLinkDto

REFERENCE

详细请参见表13。

创建链路失败信息

-

successList

ARRAY_REFERENCE

0-500个列表项，详细请参见表16。

创建堆叠成功列表

-

failedList

ARRAY_REFERENCE

0-500个列表项，详细请参见表17。

创建堆叠失败列表

-

id

uuid

36个字符。

-

堆叠设备id，UUID格式。

"813a76d4-6eec-4264-ae45-a6f261482b60"

name

string

1~64个字符。

-

堆叠设备名称。

"stack1"

stackRole

string

0~32个字符。

-

堆叠角色。

"CORE"

stackMember

ARRAY_REFERENCE

1-9个列表项，详细请参见表5。

堆叠成员信息。

-

errcode

REFERENCE

详细请参见表7。

错误码

-

errmsg

REFERENCE

详细请参见表8。

错误描述

-

topoPlanStackDto

REFERENCE

详细请参见表16。

创建堆叠失败信息

-

successList

ARRAY_REFERENCE

0-500个列表项，详细请参见表19。

创建M-Lag组成功列表

-

failedList

ARRAY_REFERENCE

0-500个列表项，详细请参见表20。

创建M-Lag组失败列表

-

id

string

36个字符。

-

M-Lag组id。

"18f461fa-4f1b-3e2b-90e4-f3d29d0dcf9b"

name

string

0~64个字符。

-

M-Lag组名称。

"mlag1"

groupId

int32

[1-2048]

-

M-LAG ID

1

mode

string

0~20个字符。满足正则表达^(active-active|active-standby|)$。

-

M-LAG模式,active-active / active-standby。

"active-active"

mlagMember

ARRAY_REFERENCE

0-6个列表项，详细请参见表5。

M-LAG成员

-

errcode

REFERENCE

详细请参见表7。

错误码

-

errmsg

REFERENCE

详细请参见表8。

错误描述

-

topoPlanMlagGroupDto

REFERENCE

详细请参见表19。

创建M-LAG失败信息

-