本文导读

典型场景
接口功能
接口约束
调用方法
URI
请求参数
请求示例
响应参数
响应示例

展开导读

文档首页/ 华为乾坤/ 云管理网络/ API参考/ 接口参考/ Lan网络/ 站点/ 公共/ 网络规划/ 网络规划

网络规划

更新时间：2025-02-17 GMT+08:00

查看PDF

典型场景

用户可以将规划的网络资源创建在指定站点，包括设备、单板、链路等。

接口功能

创建用户的设备、单板和链路。异步创建，通过查询progress获取资源创建进度。

接口约束

该接口支持租户视图或msp代维视图下用户角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用。

调用方法

POST

URI

/v1/networkservice/sites/{siteId}/topo-plans

表1 path参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
siteId	是	uuid	36个字符。	-	站点id	"f3a4f7d3-2f1e-4b2a-9f4c-1c2d2a4e5b6c"

请求参数

表2 body参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
input	是	REFERENCE	详细请参见表3。		网络规划创建接口入参	-

表3 CreateTopoPlanDto对象的参数列表
参数名称	必选	类型	参数值域	参数说明	参数示例
deviceList	否	ARRAY_REFERENCE	1-500个列表项，详细请参见表4。	网络规划设备信息	-
slotList	否	ARRAY_REFERENCE	0-500个列表项，详细请参见表5。	网络规划单板信息	-
linkList	否	ARRAY_REFERENCE	0-2000个列表项，详细请参见表6。	网络规划链路信息	-

表4 TopoPlanDeviceDto对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
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

表5 TopoPlanBoardDto对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
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"

表6 TopoPlanLinkDto对象的参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
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"

请求示例

HTTP的示例

{
  "deviceList": [
    {
      "esn": "2102355HUL2023021801",
      "name": "CORE1",
      "type": "S16700-4",
      "description": "",
      "stackName": "",
      "stackSlotId": "",
      "stackPriority": "",
      "wacEsn": "",
      "mlagName": "CORE",
      "deviceRole": "CORE"
    },
    {
      "esn": "2102355HUN0123451108",
      "name": "CORE2",
      "type": "S16700-4",
      "description": "",
      "stackName": "",
      "stackSlotId": "",
      "stackPriority": "",
      "wacEsn": "",
      "mlagName": "CORE",
      "deviceRole": "CORE"
    },
    {
      "esn": "102225213523",
      "name": "AGG1_1",
      "type": "S6730-H24X6C-V2",
      "description": "",
      "stackName": "",
      "stackSlotId": "",
      "stackPriority": "",
      "wacEsn": "",
      "mlagName": "AGG1",
      "deviceRole": "AGG"
    },
    {
      "esn": "102358054998",
      "name": "AGG1_2",
      "type": "S6730-H48X6CZ-V2",
      "description": "",
      "stackName": "",
      "stackSlotId": "",
      "stackPriority": "",
      "wacEsn": "",
      "mlagName": "AGG1",
      "deviceRole": "AGG"
    }
  ],
  "slotList": [
    {
      "deviceName": "CORE1",
      "slotId": "slot3",
      "slotType": "LSH7C36HX1E0"
    },
    {
      "deviceName": "CORE2",
      "slotId": "slot3",
      "slotType": "LSH7C36HX1E0"
    },
    {
      "deviceName": "CORE1",
      "slotId": "slot2",
      "slotType": "LSH7L36QX1E0"
    },
    {
      "deviceName": "CORE2",
      "slotId": "slot2",
      "slotType": "LSH7L36QX1E0"
    },
    {
      "deviceName": "CORE1",
      "slotId": "slot1",
      "slotType": "LSH7C18HX1E0"
    },
    {
      "deviceName": "CORE2",
      "slotId": "slot4",
      "slotType": "LSH7X48SX1E0"
    }
  ],
  "linkList": [
    {
      "srcPortName": "100GE3/0/34",
      "srcDevName": "CORE1",
      "srcEthTrunk": "Eth-Trunk1",
      "dstPortName": "100GE3/0/34",
      "dstDevName": "CORE2",
      "dstEthTrunk": "Eth-Trunk1",
      "mlagLinkType": "peer-link",
      "mlagId": "",
      "mlagIpPoolName": ""
    },
    {
      "srcPortName": "100GE3/0/35",
      "srcDevName": "CORE1",
      "srcEthTrunk": "Eth-Trunk1",
      "dstPortName": "100GE3/0/35",
      "dstDevName": "CORE2",
      "dstEthTrunk": "Eth-Trunk1",
      "mlagLinkType": "peer-link",
      "mlagId": "",
      "mlagIpPoolName": ""
    },
    {
      "srcPortName": "40GE2/0/34",
      "srcDevName": "CORE1",
      "srcEthTrunk": "",
      "dstPortName": "40GE2/0/34",
      "dstDevName": "CORE2",
      "dstEthTrunk": "",
      "mlagLinkType": "dual-active-detect-link",
      "mlagId": "",
      "mlagIpPoolName": "ipPoolName"
    },
    {
      "srcPortName": "10GE1/0/1",
      "srcDevName": "AGG1_1",
      "srcEthTrunk": "Eth-Trunk1",
      "dstPortName": "10GE1/0/1",
      "dstDevName": "AGG1_2",
      "dstEthTrunk": "Eth-Trunk1",
      "mlagLinkType": "peer-link",
      "mlagId": "",
      "mlagIpPoolName": ""
    },
    {
      "srcPortName": "10GE1/0/2",
      "srcDevName": "AGG1_1",
      "srcEthTrunk": "Eth-Trunk1",
      "dstPortName": "10GE1/0/2",
      "dstDevName": "AGG1_2",
      "dstEthTrunk": "Eth-Trunk1",
      "mlagLinkType": "peer-link",
      "mlagId": "",
      "mlagIpPoolName": ""
    },
    {
      "srcPortName": "10GE1/0/3",
      "srcDevName": "AGG1_1",
      "srcEthTrunk": "Eth-Trunk1",
      "dstPortName": "10GE1/0/3",
      "dstDevName": "AGG1_2",
      "dstEthTrunk": "Eth-Trunk1",
      "mlagLinkType": "peer-link",
      "mlagId": "",
      "mlagIpPoolName": ""
    },
    {
      "srcPortName": "10GE1/0/4",
      "srcDevName": "AGG1_1",
      "srcEthTrunk": "",
      "dstPortName": "10GE1/0/4",
      "dstDevName": "AGG1_2",
      "dstEthTrunk": "",
      "mlagLinkType": "dual-active-detect-link",
      "mlagId": "",
      "mlagIpPoolName": "ipPoolName"
    }
  ]
}

响应参数

返回状态码为201：操作成功。

表7 TopoPlanCreationResDto对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
errcode	string	0~64个字符。	-	错误码。	"0"
errmsg	string	0~256个字符。	-	错误信息。	"参数非法"
data	REFERENCE	详细请参见表8。		返回数据	-

表8 TopoPlanCreationModelDto对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
id	uuid	36个字符。	-	网络规划主键ID。	"bc1846c5-2eff-6d4d-2a2d-23dff3d12344"
siteId	uuid	36个字符。	-	站点ID。	"acc846c5-2fff-694d-2b2d-12dff3d1231a"
tenantId	string	32个字符。	-	租户ID。	"fbb684c80d37496fbafa4b06d5151e2e"

返回状态码为400：校验异常。

详细信息请参见实际响应消息体。

返回状态码为500：内部错误。

详细信息请参见实际响应消息体。

响应示例

返回状态码为201：操作成功。

{
  "errcode": "0",
  "errmsg": "",
  "data": {
    "id": "48f1f2c7-f01c-4fc6-87fd-47607897b50e",
    "siteId": "e42ee2d7-d083-4faa-bff0-1970b3c4eb08",
    "tenantId": "df8efdaebc9f4b019667b62775dd2c3b"
  }
}

返回状态码为400：校验异常。

HTTP/1.1 400 Bad Request
Date: Sun,16 Feb 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive

返回状态码为500：内部错误。

HTTP/1.1 500 Internal Server Error
Date: Sun,16 Feb 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive

父主题： 网络规划

上一篇：网络规划

下一篇：网络规划查询

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

网络规划

典型场景

接口功能

接口约束

调用方法

URI

请求参数

请求示例

响应参数

响应示例

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线

文档反馈