华为云用户手册

  • 响应示例 返回状态码为200:操作成功。 HTTP/1.1 200 OK 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 { "huawei-nce-e-l3-sub-interface:l3-sub-interface" : [ { "config-status" : "", "last-committed-time" : "", "related-pkg-version" : "", "edit-state" : "", "if-name" : "Vbdif20.20", "dot1q-vlans" : { "vlan-list" : "20" }, "vlan-type-dot1q" : { "vlan-type-vid" : 20 } } ] } 返回状态码为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
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-l3-sub-interface:l3-sub-interface/{if-name} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000" if-name 是 string 1~63个字符。 - Interface name "Vbdif20.20"
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/traffic-steering-policies?vpnId=00000000-0000-0000-0000-000000000000&policyName=qos policy&siteId=00000000-0000-0000-0000-000000000000 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AC CES S-TOKEN: x-yyyyyy
  • 响应参数 返回状态码为200:查询成功,响应体参考QueryTrafficSteeringPolicyResponse。 表2 QueryTrafficSteeringPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表8。 智能选路策略信息。 - 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功,响应体参考QueryTrafficSteeringPolicyResponse。 HTTP/1.1 200 OK 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 { "errcode" : "0", "errmsg" : "", "totalRecords" : 1, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "TrafficSteeringPolicy", "policyPriority" : 50, "switchoverCondition" : "custom", "delay" : 50, "jitter" : 50, "packetLossRate" : 50, "preferredTransportNetworks" : [ { "transportNetworks" : [ "00000000-0000-0000-0000-000000000000" ], "priority" : 1 } ], "secondaryTransportNetworks" : [ "00000000-0000-0000-0000-000000000000" ], "enableFixed" : true, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "advancedSetting" : { "enableSwitchThresholdUp" : true, "switchThresholdUp" : 90, "enableSwitchThresholdLow" : true, "switchThresholdLow" : 20, "actionNotSatisfied" : 1, "enableAdvancePriority" : true, "advancePriority" : 1, "switchMode" : 1, "policyBtwTN" : 1, "bwConditionList" : [ { "transportNetwork" : "Internet", "bwUpType" : "0", "bwUpLimitValPer" : "50", "bwLowType" : "0", "bwLowLimitValPer" : "20", "bwAppUpType" : "1", "bwMaxApp" : "20", "bwAppLowType" : "1", "bwMinApp" : "10" } ], "isGwFirst" : false, "enablePacketReplication" : false, "loadBalanceMode" : "Flow" }, "status" : 1, "isActive" : true } ] } 返回状态码为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
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/interface HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "deviceId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GigabitEthernet0/0/0", "operation" : "shutdown" }
  • 响应示例 返回状态码为200:操作成功,响应体参考DeviceInterfaceResponse。 HTTP/1.1 200 OK 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 { "errcode" : "0", "errmsg" : "", "data" : { "deviceId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GigabitEthernet0/0/0", "status" : "shutdown" } } 返回状态码为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
  • 接口约束 1. 该接口仅支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用。 2. 请勿对设备管理通道和性能通道端口进行shutdown操作,会导致设备脱管和性能数据无法上报。 3. V600系列设备支持该功能的端口有:GE、10GE、25GE、40GE、MultiGE、Eth-Trunk、Tunnel、Vlanif、MEth。 4. V300系列设备支持该功能的端口有:GigabitEthernet、XGigabitEthernet、Ethernet、Cellular、Vlanif、LoopBack、Bridge-if、Virtual-Ethernet、Dialer、Eth-Trunk、Tunnel、Vbdif、Atm、Ima-group、Serial。 5. AR6700V-L款型设备支持该功能的端口有:GE。 6. shutdown/undo shutdown设备上不存在的逻辑口时,设备会创建该逻辑口,并生效shutdown配置;删除时,因无法识别该逻辑口的创建来源,不删除该逻辑口,只删除shutdown配置,设备上会残留该逻辑口。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 updateDeviceInterfaceRequestParam 是 REFERENCE 详细请参见表2。 执行打开或关闭操作的参数。 - 表2 updateDeviceInterfaceRequestParam对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 0~64个字符。 - 设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" interfaceName 是 string 0~128个字符。 - 设备接口名称。 "GigabitEthernet0/0/0" operation 是 string shutdown undo shutdown - 操作,该字段可以设置为以下几种: a) shutdown:关闭设备接口 b) undo shutdown:打开设备接口 "shutdown"
  • 请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-vpn:vpn/vpn1 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy restconf-transaction-id: "00000000-0000-0000-0000-000000000000"
  • 响应示例 返回状态码为200:操作成功。 HTTP/1.1 200 OK 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 返回状态码为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
  • 接口约束 该接口支持msp视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用,且仅支持AR6700V和AR6700V子设备; 或者支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用,且仅支持AR6700V-L款型和V600系列设备。 该API可能会直接或间接影响现网业务运行,导致业务中断、关键数据丢失等,请谨慎操作!
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-vpn:vpn/{instance-name} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000" instance-name 是 string 1~31个字符。 - VPN实例名,单一主键字段。 "vpn1"
  • 示例:修改指定pool1的DHCP地址池 URI: /restconf/v2/data/huawei-ac-nes-device:nes/ne/{ neId }/huawei-nce-e-dhcpv4:global-ip-pool/ pool1 Table1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字节。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000" ip-pool-name 是 string 1~128个字节。 - Key,名称。 "pool1" HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:global-ip-pool/pool1 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "huawei-nce-e-dhcpv4:global-ip-pool" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "gateway-list" : [ { "gateway-ip" : "192.168.1.1", "mask" : 24 } ], "section" : [ { "section-index" : 1, "start-ip" : "192.168.10.1", "end-ip" : "192.168.10.100" } ], "dns-list" : [ { "dns-ip" : "192.168.100.1" } ], "excluded-ip-address" : [ { "start-ip-address" : "192.168.10.10", "end-ip-address" : "192.168.10.120" } ], "static-bind" : [ { "static-bind-ip" : "192.168.100.1", "static-bind-mac" : "01-01-01-01-01-01" } ], "option" : [ { "option-code" : 7, "ip-addresses" : [ u'"192.168.1.1"' ] , "ascii-string" : "test", "hex-string" : "00", "cipher-string" : "Example@123", "sub-options" : { "sub-option" : [ { "sub-option-code" : 1, "ascii-string" : "test" } ] } } ], "ip-pool-name" : "pool1", "vpn-instance" : "overlay_vpn", "network-ipv4-address" : "192.168.10.1", "network-mask" : 24, "domain-name" : "test.com" } ] }
  • 示例:修改指定ip-pool-name为pool1和section-index为1的section URI: /restconf/v2/data/huawei-ac-nes-device:nes/ne/{ neId }/huawei-nce-e-dhcpv4:global-ip-pool/ pool1/1 Table1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字节。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000" ip-pool-name 是 string 1~128个字节。 - Key,名称。 "pool1" section-index 是 int64 [0-255] - Key,序号。 1 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:global-ip-pool/pool1/1 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "huawei-nce-e-dhcpv4:section" : [ { "section-index" : 1, "start-ip" : "192.168.10.1", "end-ip" : "192.168.10.100 } ] }
  • 示例:批量修改DHCP地址池 URI: /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-dhcpv4:global-ip-pool 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字节。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000" 请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:global-ip-pool HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "huawei-nce-e-dhcpv4:global-ip-pool" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "gateway-list" : [ { "gateway-ip" : "192.168.1.1", "mask" : 24 } ], "section" : [ { "section-index" : 1, "start-ip" : "192.168.10.1", "end-ip" : "192.168.10.100" } ], "dns-list" : [ { "dns-ip" : "192.168.10.1" } ], "excluded-ip-address" : [ { "start-ip-address" : "192.168.10.110", "end-ip-address" : "192.168.10.120" } ], "static-bind" : [ { "static-bind-ip" : "192.168.10.1", "static-bind-mac" : "01-01-01-01-01-01" } ], "option" : [ { "option-code" : 7, "ip-addresses" : [ u'"192.168.10.1"' ] , "ascii-string" : "test", "hex-string" : "00", "cipher-string" : "Example@123", "sub-options" : { "sub-option" : [ { "sub-option-code" : 1, "ascii-string" : "test" } ] } } ], "ip-pool-name" : "pool1", "vpn-instance" : "overlay_vpn", "network-ipv4-address" : "192.168.10.0", "network-mask" : 24, "domain-name" : "test.com" } ] }
  • 请求示例 HTTP的示例 POST /v1/networkconfig/policy/profiles/vlanpools/action/batch-delete HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "ids" : [ "4f350825-919c-47b7-b853-f51f15912396" ] }
  • 响应示例 返回状态码为200:删除VLAN POOL模板成功。 HTTP/1.1 200 OK 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 { "errcode" : "0", "errmsg" : "", "success" : [ "4f350825-919c-47b7-b853-f51f15912396" ], "fail" : [ { "errcode" : "0302000020", "errmsg" : "The site ID format is incorrect or the site does not exist", "data" : { "id" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "name" : "VLANPOOLTemplate1", "errmsg" : "The site ID format is incorrect or the site does not exist" } } ] } 返回状态码为207:删除VLAN POOL模板部分成功。 HTTP/1.1 207 Multi-Status 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 { "errcode" : "0", "errmsg" : "", "success" : [ "4f350825-919c-47b7-b853-f51f15912396" ], "fail" : [ { "errcode" : "0302000020", "errmsg" : "The site ID format is incorrect or the site does not exist", "data" : { "id" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "name" : "VLANPOOLTemplate1", "errmsg" : "The site ID format is incorrect or the site does not exist" } } ] } 返回状态码为400:删除VLAN POOL模板全部失败。 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
  • 响应示例 返回状态码为200:成功删除CLI配置信息。 HTTP/1.1 200 OK 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 { "errcode" : "0", "errmsg" : "" } 返回状态码为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
  • 响应参数 返回状态码为200:成功删除CLI配置信息。 表4 DeleteCLIResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部服务错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v3/networkconfig/site-templates/fbb684c8-0d37-496f-bafa-4b06d5151e2e/type/AP/cli/batch-delete HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "ids" : [ "fbb684c80d37496fbafa4b06db151e2a" ] }
  • URI /controller/campus/v3/networkconfig/site-templates/{siteTemplateId}/type/{deviceType}/cli/batch-delete 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string 36个字符。 - 站点模板ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceType 是 string AP LSW FW AR - 设备类型,取值范围:AP、LSW、FW、AR。 "AP"
  • 响应参数 返回状态码为200:查询成功,响应体参考QueryFloorDetailsResponse。 表2 QueryFloorDetailsResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "error" data REFERENCE 详细请参见表3。 楼层详细信息 - 表3 FloorDetails对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string - - 楼层名称。 "F3" number string - - 楼层号。 "7" image byte - - 楼层图纸。 "iVBORw0KGgoAAAANSUhEUgAAAEIAAAA8CAYAAADSfGxZAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAEXRFWHRTb2Z0d2FyZQBTbmlwYXN0ZV0Xzt0AAAEKSURBVGiB7dvRaoMwGEDhP3Hv/4I+hPei/rs5Slo2lw1KITsHSi0m0X54acpxHBkRUUqJiIjMvI6fuzv3fD4zo123Z87dmLOvxvZe625s/XHmP0kIEoKEICFICBKChCAhSAgSgoQgIUgIEoKEICFICBKChCAhSAgSgoQgIUgIEoKEICFICBKChCAhSAgSgoQgIUgIEoKEICFICBKChKChINqX13/bUBDtG/cnSi/OUBCZGeu6xrZtDwA9GMNBzPMcy7Jcv9vvu8pIG1cy81rv/Hw3duiNK7XWqPXxL+373jf3FTf07k6MzIxpmrrmfLzyht7R+cj37O9qG/KJ+EtCkBAkBAlBQpAQ9AkRmWqufm0+xwAAAABJRU5ErkJggg==" scale double - - 比例尺,表示图上距离与实际距离的比,例如:图上0.01米代表实际1米,则比例尺为0.01。 "0.022" 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部服务器错误,无响应体。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功,响应体参考QueryFloorDetailsResponse。 HTTP/1.1 200 OK 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 { "errcode" : "0", "errmsg" : "error", "data" : { "name" : "F3", "number" : "7", "image" : "iVBORw0KGgoAAAANSUhEUgAAAEIAAAA8CAYAAADSfGxZAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAEXRFWHRTb2Z0d2FyZQBTbmlwYXN0ZV0Xzt0AAAEKSURBVGiB7dvRaoMwGEDhP3Hv/4I+hPei/rs5Slo2lw1KITsHSi0m0X54acpxHBkRUUqJiIjMvI6fuzv3fD4zo123Z87dmLOvxvZe625s/XHmP0kIEoKEICFICBKChCAhSAgSgoQgIUgIEoKEICFICBKChCAhSAgSgoQgIUgIEoKEICFICBKChCAhSAgSgoQgIUgIEoKEICFICBKChKChINqX13/bUBDtG/cnSi/OUBCZGeu6xrZtDwA9GMNBzPMcy7Jcv9vvu8pIG1cy81rv/Hw3duiNK7XWqPXxL+373jf3FTf07k6MzIxpmrrmfLzyht7R+cj37O9qG/KJ+EtCkBAkBAlBQpAQ9AkRmWqufm0+xwAAAABJRU5ErkJggg==", "scale" : "0.022" } } 返回状态码为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
  • 请求示例 HTTP的示例 GET /controller/campus/v1/indoormapservice/floors/75ade72a-e7a9-4c81-8fca-894e7ca9c2c2 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 uninstallPluginReq 是 REFERENCE 详细请参见表2。 创建插件卸载任务请求参数。 - 表2 UninstallPluginReq对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pluginType 是 string 1~64个字符。 - 插件类型;22-无线非经/loT插卡;当前仅支持22类型插件。 "22" siteInfos 是 ARRAY_REFERENCE 1-100个列表项,详细请参见表3。 站点和款型信息。 -
  • 响应示例 返回状态码为201:创建成功,响应体参考CentralizedInterworkingResponse。 HTTP/1.1 201 Created 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 { "errcode" : "", "errmsg" : "", "data" : { "centralizedSiteInfos" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "igwEnable" : true, "enableUnderlayFirst" : false, "priority" : "active", "tnpConfigs" : [ { "transportNetworkPortId" : "00000000-0000-0000-0000-000000000000", "transportNetworkPortName" : "ApSite", "priority" : 1, "bandwidth" : 10, "mtu" : 1500 } ] } ] } } 返回状态码为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
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/interworking/00000000-0000-0000-0000-000000000000/centralized-access HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "centralizedSiteInfos" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "igwEnable" : true, "enableUnderlayFirst" : false, "priority" : "active", "tnpConfigs" : [ { "transportNetworkPortId" : "00000000-0000-0000-0000-000000000000", "transportNetworkPortName" : "ApSite", "priority" : 1, "bandwidth" : 10, "mtu" : 1500 } ] } ] }
  • 响应参数 返回状态码为201:创建成功,响应体参考CentralizedInterworkingResponse。 表6 CentralizedInterworkingResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 - errmsg string - - 错误信息。 - data REFERENCE 详细请参见表7。 成功创建或者更新返回的集中互访请求体。 - 表7 CentralizedInterworkingInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 centralizedSiteInfos ARRAY_REFERENCE 0-2个列表项,详细请参见表8。 集中互访的站点信息,最多2个hub站点或者一个其它站点。 - 表8 CentralizedSite对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 站点ID。 创建的时候必填,站点必须先加入拓扑。 "00000000-0000-0000-0000-000000000000" siteName string 0~64个字符。 - 站点名称。 "site1" igwEnable boolean true false - 是否互访网关,创建的时候必填。 true enableUnderlayFirst boolean true false false 是否使能underlay优先,默认关闭,V600系列设备不支持使能此功能。 false priority string - - 站点主备优先级,该字段可以设置为以下几种: a) active:主网关 b) standby:备网关 当指定两个上网网关且网络类型为evpn时,需要指定。 创建的时候必填。 "active" tnpConfigs ARRAY_REFERENCE 0-6个列表项,详细请参见表9。 集中互访的出口链路配置。 创建的时候必填。 更新的时候,同一站点下,如果不传值,则保持更新前的配置内容不变;如果传值,需要填写所有已配置的链路配置,未填写的链路配置会被删除。 - 表9 TnpConfig对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 transportNetworkPortId uuid - - TNP ID,创建、修改的时候必填。 "00000000-0000-0000-0000-000000000000" transportNetworkPortName string 0~64个字符。 - 传输网络端口名称。 "ApSite" priority int32 - - 链路优先级,只能为1、2、3,1表示最高,创建、修改的时候必填。 1 bandwidth int32 [0-99] - 集中互访占用部门带宽比,单位为百分比。 当配置为0表示关闭独立分配带宽功能。 10 mtu int32 [46-9216] - mtu,取值范围46-9216,默认值1500。 1500 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 centralizedInterworkingInfo 是 REFERENCE 详细请参见表3。 创建集中互访配置请求数据。 - 表3 CentralizedInterworkingInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 centralizedSiteInfos 是 ARRAY_REFERENCE 0-2个列表项,详细请参见表4。 集中互访的站点信息,最多2个hub站点或者一个其它站点。 - 表4 CentralizedSite对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 uuid - - 站点ID。 创建的时候必填,站点必须先加入拓扑。 "00000000-0000-0000-0000-000000000000" siteName 否 string 0~64个字符。 - 站点名称。 "site1" igwEnable 否 boolean true false - 是否互访网关,创建的时候必填。 true enableUnderlayFirst 否 boolean true false false 是否使能underlay优先,默认关闭,V600系列设备不支持使能此功能。 false priority 否 string - - 站点主备优先级,该字段可以设置为以下几种: a) active:主网关 b) standby:备网关 当指定两个上网网关且网络类型为evpn时,需要指定。 创建的时候必填。 "active" tnpConfigs 否 ARRAY_REFERENCE 0-6个列表项,详细请参见表5。 集中互访的出口链路配置。 创建的时候必填。 更新的时候,同一站点下,如果不传值,则保持更新前的配置内容不变;如果传值,需要填写所有已配置的链路配置,未填写的链路配置会被删除。 - 表5 TnpConfig对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 transportNetworkPortId 否 uuid - - TNP ID,创建、修改的时候必填。 "00000000-0000-0000-0000-000000000000" transportNetworkPortName 否 string 0~64个字符。 - 传输网络端口名称。 "ApSite" priority 否 int32 - - 链路优先级,只能为1、2、3,1表示最高,创建、修改的时候必填。 1 bandwidth 否 int32 [0-99] - 集中互访占用部门带宽比,单位为百分比。 当配置为0表示关闭独立分配带宽功能。 10 mtu 否 int32 [46-9216] - mtu,取值范围46-9216,默认值1500。 1500
共99354条