华为乾坤-创建Topology:响应参数

时间:2025-05-12 15:31:51

响应参数

返回状态码为201:创建拓扑成功,响应体参考TopologyResponse。

表9 TopologyResponse对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

errcode

string

-

-

错误码。

"0"

errmsg

string

-

-

错误信息。

""

topology

REFERENCE

详细请参见表10

拓扑信息。

-

processInstanceId

string

0~36个字符。

-

编排流程实例ID,UUID格式。当接口返回码为202时非空。

-

表10 TopologyInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

areas

ARRAY_REFERENCE

1个列表项,详细请参见表11

按区域指定站点拓扑。当前仅支持一次操作一个Area。

-

表11 AreaInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

id

uuid

-

-

区域ID,UUID格式,创建区域时不填,更新时必填。仅在bgp-evpn模式下使用。

"00000000-0000-0000-0000-000000000000"

name

string

1~32个字符。

-

域名 称,创建时必填。“default”、“backbone”为预留名称,不允许使用。

"area_1"

areaType

string

1~32个字符。

backbone

区域类型。取值范围:leaf、backbone。leaf:叶子区域,backbone:骨干区域。用户调用API创建的区域只能是leaf类型,backbone区域是由开启互联的区域的border站点自动形成的。创建时必填。

"leaf"

topologyType

string

-

full-mesh

区域拓扑类型。取值范围:full-mesh、hub-spoke。full-mesh:全网类型,hub-spoke:枢纽类型。创建时必填。

"hub-spoke"

enableDynamicTunnel

boolean

  • true

  • false

false

full-mesh模式下是否使能spoke站点间动态隧道功能。

-

gatewayIPv6Enable

boolean

  • true

  • false

false

gateway角色是否使能IPv6协议,只对加入站点中的gateway角色生效。只有区域所在VPN使能IPv6后才能开启。区域中如果存在gateway角色的站点,不能去使能gatewayIPv6Enable开关。

false

hubWorkMode

string

1~32个字符。

with-interconnection

工作模式。取值范围:with-interconnection、without-interconnection。with-interconnection:互联,without-interconnection:无互联。

"with-interconnection"

isFullReplaceSite

boolean

  • true

  • false

false

是否全量替换站点,仅在更新接口有效。true表示将以siteAttachments为准,全量更新区域内站点。为空或者false兼容之前规则,表示仅更新siteAttachments指定站点,区域内其他站点不变。

-

siteAttachments

ARRAY_REFERENCE

1-3000个列表项,详细请参见表12

区域下的站点列表。

-

表12 SiteAttachmentInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

siteId

uuid

-

-

站点ID,UUID格式。

"00000000-0000-0000-0000-000000000000"

siteName

string

-

-

站点名称。

"Site Name"

siteRoles

ARRAY_REFERENCE

1-4个列表项,详细请参见表13

站点承担的角色。一个站点可以同时承担多个角色,每个角色可以单独设置主备。

在EVPN场景下,站点角色可能存在如下组合:

1、当topologyType为full-mesh时,站点必须承担spoke角色,除了spoke角色,站点还可以同时是逃生站点intermediate,也可以同时是边缘站点border;

2、当topologyType为hub-spoke时,如果一个站点是hub站点,那么这个站点还可以同时是边缘站点border;如果一个站点是spoke角色,那么这个站点不可以同时承担其他角色。

[{"role":"hub","sitePriority":"active"},{"role":"border","sitePriority":"active"}]

accessServiceHubs

ARRAY_REFERENCE

0-16个列表项,详细请参见表14

分支站点接入的业务HUB列表,分支互访时必须接入hub角色站点;原hub-spoke场景不可配置,多HUB场景必配。

-

borderRelationShip

REFERENCE

详细请参见表15

设置分支站点的主备边缘站点,在full-mesh模式下开启区域互连时有效

-

enableHubLanConnect

boolean

  • true

  • false

false

是否开启HUB站点的LAN侧互通。

-

表13 siteRole对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

role

string

1~32个字符。

-

一个区域中的站点角色。取值范围为:hub、spoke、intermediate、border、gateway、serviceHub。

hub:主节点,spoke:子节点,intermediate:逃生节点,border:边缘节点,gateway:互访网关节点,serviceHub:业务HUB。

hub-spoke模式的拓扑中,当主备hub角色的两个站点同时存在时,必须同时配置或不配置serviceHub的角色。

同时配置serviceHub角色时,主hub的优先级要小于备hub。优先级为active或standby的hub站点只能各配置一个。

gateway角色的站点只能为单网关站点。V600系列设备不支持配置gateway角色。

"hub"

sitePriority

string

1~32个字符。

active

站点优先级。原hub-spoke场景,无serviceHub角色,hub优先级取值active/standby。

多HUB场景,serviceHub角色站点优先级取值范围1-16,hub角色站点优先级active/standby。

spoke角色的站点的优先级为active。

"active"

表14 AccessHubInfo对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

siteName

string

-

-

站点名称

-

siteId

uuid

-

-

站点ID,UUID格式。

"00000000-0000-0000-0000-000000000000"

accessPriority

uint8

[1-16]

1

优先级

2

表15 BorderRelationShip对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

activeBorderSiteId

uuid

-

-

主边缘站点ID,UUID格式。

"00000000-0000-0000-0000-000000000000"

activeBorderSiteName

string

-

-

主边缘站点名称。

"Site Name"

standbyBorderSiteId

uuid

-

-

备边缘站点ID,UUID格式。

"00000000-0000-0000-0000-000000000000"

standbyBorderSiteName

string

-

-

备边缘站点名称。

"Site Name"

返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考TopologyResponse。

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

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

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

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

support.huaweicloud.com/qiankuncmn-qiankuncs/toctopics/zh-cn_topic_0000001988433770.html
提示

您即将访问非华为云网站,请注意账号财产安全