华为云用户手册

  • 响应参数 返回状态码为200:查询成功。响应体参考QueryPortalOnlineUserInfoOutputDto。 表2 QueryPortalOnlineUserInfoOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总行数 1 data ARRAY_REFERENCE 详细请参见表3。 在线用户详情 - 表3 PortalOnlineUserInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 在线用户ID。UUID格式 "2eab8922-a37d-4355-9788-33caade63b5a" userId string - - 用户ID。UUID格式 "43218922-a37d-43b2-9788-33caade63b5a" userName string - - 用户名。 "user1" userGroupId string - - 用户组ID。UUID格式 "12345678-a37d-43b2-9788-33caade63b" userGroupName string - - 用户组名。 "ROOT\\Guest" siteId string - - 站点ID。UUID格式 "11111111-a37d-43b2-9788-33caade63b5a" loginTime int64 - - 登录时间。 1541389780672 deviceId string - - 设备id。UUID格式 "34567890-a37d-43b2-9788-33caade63b5a" accessPolicy string - - 认证策略名。 "policy_for_guest" onlineuserTerminalIp string - - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 认证终端IP。 "10.10.10.10" terminalMac string - - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 认证终端MAC。 "XX-XX-XX-XX-XX-XX" ssid string - - SSID。 "portal-guest" authMode int64 - - 认证方式。 "1" userType int64 - - 用户类型。 "0" imsi string - - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 imsi "150000000000000" imei string - - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 imei "150000000000000" mobileTerminalInfo string - - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 移动终端信息 "APN={APN},MSISDN={MSISDN},ULI={ULI},RAT={RAT}" name string 0~64个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 姓名 "" authPolicy string 0~128个字符。 - 认证规则名称 "authrule01" uclGroupName string 0~128个字符。 - 安全组名称 "uclGroup01" terminalDeviceType string 0~128个字符。 - 终端设备类型 "Mobile Phone/Huawei/Mate 30 5G" osName string 0~128个字符。 - 操作系统 "Google/Android/Android 4.4.X" remoteIAEName string 0~128个字符。 - 拉远组件名称 "IAE01" deviceIp string 0~32个字符。 - 设备Ip "10.10.10.10" devicePort string 0~32个字符。 - 设备端口 "GigabitEthernet0/0/8" deviceVlan string 0~8个字符。 - 设备Vlan "1" accessResultId string 32~36个字符。 - 授权结果Id "44567890-a37d-43b2-9788-33caade63b5b" accessResultName string 0~128个字符。 - 授权结果名称 "accessResult01" nasPortId string 0~256个字符。 - 认证设备端口vlan详细信息 "slot=0;sublot=0;port=8;vlanid=1;interfaceName=GigabitEthernet0/0/8" telephone string 0~32个字符。 - 电话号码 "8615000000000" accessDeviceIp string 0~32个字符。 - 接入设备Ip "10.10.10.10" accessDevicePort string 0~32个字符。 - 接入设备端口 "GigabitEthernet0/0/8" accessDeviceVlan string 0~8个字符。 - 接入设备Vlan "1" accessDeviceMac string 0~32个字符。 - 接入设备MAC "XX-XX-XX-XX-XX-XX" natTerminalIp string 0~32个字符。 - 公网Ip地址 "10.10.10.10" natStartPort string 0~8个字符。 - 公网地址起始端口 "10235" natEndPort string 0~8个字符。 - 公网地址结束端口 "10260" autoAccess boolean true false - 是否自动接入。默认值为false。 false hasMdmInfo boolean true false - 是否有mdm信息。默认值为false。 false role string 0~64个字符。 - 角色名称 - securityGroupId string 32~36个字符。 - 安全组id - stationId string 32~36个字符。 - Radius属性携带的Called-Station-Id字段,一般为认证设备标识信息 - sysName string 0~64个字符。 - 系统名称 - terminalGroup string 32~36个字符。 - 终端组id - vipType int32 [0-100] - vip类型 - bypassScene string 0~1个字符。 - 是否逃生场景 '0' 非逃生 '1' 逃生 - externalGroupName string 0~1024个字符。 - 外部组名称 "/group" 返回状态码为400:操作失败。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v1/accountservice/onlineusers?userType=0&authMode=1&pageIndex=1&pageSize=20&userName=user1&beginTimeLong=1541389780672&endTimeLong=1541390000000&accessPolicy=policy_for_guest&terminalIp=10.10.10.10&terminalMac=XX-XX-XX-XX-XX-XX&ssid=portal-guest&userGroupId=2eab8922-a37d-43b2-9788-33caade63b5a&siteId=2eab8922-a37d-43b2-9788-33caade63b5a&name=yonghuxingming&bypassScene=0 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
  • URI /controller/campus/v1/accountservice/onlineusers 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 userType 否 string 0 1 2 4 5 6 7 10 11 12 13 14 20 21 22 24 27 64 - 用户类型:0:普通用户 1:短信注册用户 2:自注册用户 4:社交媒体用户 5:微信用户 6:Passcode用户 7:第三方用户 10:AD用户 11:PPSK用户 12:RADIUS Token用户 13:LDAP用户 14:SAML认证用户 20:普通访客 21:MAC帐号 22:第三方HTTP用户 24:公共二维码 27:已废弃 64:匿名用户。如果不填,查询所有类型。 "0" authMode 否 string 1 2 3 4 8 9 10 11 13 14 15 16 17 18 - 认证方式:1:Portal HACA认证。2、Mac免认证。3、第三方认证。4、PPSK。8、802.1x。9、Mac。10、云平台中继Radius认证。11、Portal2.0/CMCC认证。13、第三方HTTP认证。14、设备管理认证。15、FW SSL VPN认证。16、Portal2.0 Mac免认证。17、Radius中继认证。18、运营商网络终端认证。如果不填,查询所有类型。 "1" pageIndex 否 int32 - 1 起始页。 1 pageSize 否 int32 [20-100] 20 分页大小。 20 userName 否 string - - 用户名。用户名使用模糊查询。 "user1" beginTimeLong 否 int64 - - 查询起始时间。 1541389780672 endTimeLong 否 int64 - - 查询结束时间。 1541390000000 accessPolicy 否 string - - 认证策略名。 "policy_for_guest" terminalIp 否 string - - 认证终端IP。 "10.10.10.10" terminalMac 否 string - - 认证终端MAC,大小写敏感,MAC地址只支持一种格式:XX-XX-XX-XX-XX-XX。 "XX-XX-XX-XX-XX-XX" ssid 否 string - - SSID。 "portal-guest" userGroupId 否 string - - 用户组ID。UUID格式 "2eab8922-a37d-43b2-9788-33caade63b5a" siteId 否 string - - 站点ID。UUID格式 "2eab8922-a37d-43b2-9788-33caade63b5a" name 否 string 0~128个字符。 - 姓名 "yonghuxingming" bypassScene 否 string 0~1个字符。 - 是否逃生场景 "0"
  • 响应示例 返回状态码为201:创建的防火墙设备NAT配置。 HTTP/1.1 201 Created Date: Sun,11 May 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" : { "name" : "nat1", "description" : "", "conversionMode" : 3, "destinationMode" : "address-to-address", "sourceZones" : [ "00000000-0000-0000-0000-000000000001" ], "destinationZones" : [ "00000000-0000-0000-0000-000000000003" ], "oldSourceIp" : "10.2.0.6/24", "oldDestinationIp" : "10.1.1.10", "sourceConvert" : 1, "newSourceIpGroup" : [ "10.1.1.10" ], "newDestinationIpGroup" : [ "10.1.1.10" ], "destinationPort" : "80,82-98", "serviceList" : [ { "serviceType" : "tcp", "sourcePort" : "80", "destPort" : "80-97" } ], "id" : "de5813f8ff1e41f5ba9c324da70b49ed", "priority" : 5 } } 返回状态码为400:校验失败信息。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • URI /controller/campus/v1/networkservice/networkconfig/net/fwnat/devices/{deviceId}/fwnat 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备标识,UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/net/fwnat/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/fwnat 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 { "name" : "nat1", "description" : "", "conversionMode" : 3, "destinationMode" : "address-to-address", "sourceZones" : [ "00000000-0000-0000-0000-000000000001" ], "destinationZones" : [ "00000000-0000-0000-0000-000000000003" ], "oldSourceIp" : "10.2.0.6/24", "oldDestinationIp" : "10.1.1.10", "sourceConvert" : 1, "newSourceIpGroup" : [ "10.1.1.10" ], "newDestinationIpGroup" : [ "10.1.1.10" ], "destinationPort" : "80,82-98", "serviceList" : [ { "serviceType" : "tcp", "sourcePort" : "80", "destPort" : "80-97" } ] }
  • 响应示例 返回状态码为200:AP站点立即调优结果,返回结构体参见GroupRadioDcaResponsesDto。 HTTP/1.1 200 OK Date: Sun,11 May 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,11 May 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/v3/networkconfig/site/fbde1c5d-5b94-49e3-a912-48641015e45c/apradio/groupradiodca 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
  • 响应参数 返回状态码为200:AP站点立即调优结果,返回结构体参见GroupRadioDcaResponsesDto。 表2 GroupRadioDcaResponsesDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 待更新的ACL模板信息。 - 表3 UpdateAclDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~32个字符。 - ACL模板名称,包括汉字、字母、数字、下划线、.、@、-不能与已有的名称重复。 "ACLTemplate1" description 否 string 0~127个字符。 - ACL模板描述。 "ACLTemplate1" ruleList 否 ARRAY_REFERENCE 1-1024个列表项,详细请参见表3。 规则列表。 - aclNumber 否 string - - ACL模板编号,必须为数字,aclType为Advanced时,aclNumber范围:3001-3999,aclType为User时,aclNumber范围:6000-6031。 "3001"
  • 请求示例 HTTP的示例 PUT /controller/campus/v3/profile/acl/fbde1c5d-5b94-49e3-a912-48641015e45c 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 { "name" : "ACLTemplate1", "description" : "ACLTemplate1", "ruleList" : [ { "ruleId" : "1", "ip" : "", "domain" : "", "policy" : "permit", "protocol" : "tcp", "tcpFlag" : "ack,fin", "srcIp" : "192.168.1.0/24", "srcPort" : "23", "dstIp" : "192.168.2.0/24", "dstPort" : "24", "dscp" : 2, "description" : "Rule1" } ], "aclNumber" : "3001" }
  • 响应示例 返回状态码为200:成功更新的ACL模板信息。 HTTP/1.1 200 OK Date: Sun,11 May 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" : { "id" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "name" : "ACLTemplate1", "aclNumber" : "3001", "description" : "ACLTemplate1", "aclType" : "Advanced", "ruleList" : [ { "ruleId" : "1", "ip" : "", "domain" : "", "policy" : "permit", "protocol" : "tcp", "tcpFlag" : "ack,fin", "srcIp" : "192.168.1.0/24", "srcPort" : "23", "dstIp" : "192.168.2.0/24", "dstPort" : "24", "dscp" : 2, "description" : "Rule1" } ], "ipType" : "ipv4" } } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应示例 返回状态码为200:查询成功。 HTTP/1.1 200 OK Date: Sun,11 May 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" : { "lldpEnable" : true, "taggedVlanId" : "10", "untaggedVlanId" : "11" } }
  • URI /controller/campus/v1/networkservice/networkconfig/net/lldp/sites/{siteId}/lldp 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/lldp/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/lldp 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
  • 响应参数 返回状态码为200:查询成功。 表2 LldpResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~256个字符。 - 错误码:当没有错误时返回0。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表3。 LLDP配置参数体 - 表3 LldpDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 lldpEnable boolean true false false LLDP配置开关状态。默认值为false。 true taggedVlanId string 0~256个字符。 - Tagged VLAN,填写1~4094范围内的数字或段(NULL或空字符串表示不设置值),如10,12-16。仅交换机设备支持该参数。 "10" untaggedVlanId string 0~256个字符。 - Untagged VLAN,填写1~4094内的整数(NULL或空字符串表示不设置值),Tagged VLAN和Untagged VLAN中不能有相同的VLAN。仅交换机设备支持该参数。 "11"
  • 响应示例 返回状态码为200:调用创建堆叠成功,响应体参考CreateStackOutDto。 HTTP/1.1 200 OK Date: Sun,11 May 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" : [ { "stackId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359ca", "stackName" : "stack1", "stackMember" : [ { "errcode" : "0", "errmsg" : "", "deviceId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359ca", "esn" : "AP5008293500000001", "stackMemberId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359xa", "slotId" : 0, "priority" : 100 } ] } ], "fail" : [ { "stackName" : "site1", "stackMember" : [ { "errcode" : "0", "errmsg" : "", "deviceId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359ca", "esn" : "AP5008293500000001", "stackMemberId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359xa", "slotId" : 0, "priority" : 100 } ] } ] }
  • 响应参数 返回状态码为200:调用创建堆叠成功,响应体参考CreateStackOutDto。 表5 CreateStackOutDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。当没有错误时返回0。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项,详细请参见表6。 成功的堆叠设备列表。 - fail ARRAY_REFERENCE 0-100个列表项,详细请参见表8。 失败的堆叠设备列表。 - 表6 createStackSuccess对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 stackId string 1~64个字符。 - 堆叠ID,UUID格式。 "as25fdbf-8dee-4823-bac2-5bfe8e3359ca" stackName string 1~64个字符。 - 堆叠名称。 该字段对应UI页面上是:UI【堆叠名称】 "stack1" stackMember ARRAY_REFERENCE 1-9个列表项,详细请参见表7。 堆叠成员。 - 表7 StackMemberOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" deviceId string - - 设备ID,UUID格式。 "as25fdbf-8dee-4823-bac2-5bfe8e3359ca" esn string - - 设备ESN。 该字段对应UI页面上是:UI【ESN】 "AP5008293500000001" stackMemberId string - - 堆叠成员ID,UUID格式。 "as25fdbf-8dee-4823-bac2-5bfe8e3359xa" slotId int32 - - 设备堆叠编号。 该字段对应UI页面上是:UI【槽位号】 0 priority int32 - - 设备堆叠优先级。 该字段对应UI页面上是:UI【优先级】 100 表8 createStackFail对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 stackName string 1~64个字符。 - 堆叠名称。 该字段对应UI页面上是:UI【堆叠名称】 "site1" stackMember ARRAY_REFERENCE 1-9个列表项,详细请参见表7。 堆叠成员 -
  • 请求示例 HTTP的示例 POST /controller/campus/v3/stack 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 { "stacks" : [ { "stackName" : "stack1", "stackMember" : [ { "esn" : "AP5008293500000001", "slotId" : 0, "priority" : 100 } ], "stackRoles" : "ACC" } ] }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 createStackDto 是 REFERENCE 详细请参见表2。 创建堆叠入参。 - 表2 CreateStackDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 stacks 是 ARRAY_REFERENCE 0-100个列表项,详细请参见表3。 堆叠信息。 - 表3 CreateStackDtoData对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 stackName 是 string 1~64个字符。 - 堆叠名称。如果堆叠名称已存在,则将设备加入堆叠;否则,创建堆叠并加入设备。堆叠名称不能包含"?"或者制表符TAB。 该字段对应UI页面上是:UI【堆叠名称】 "stack1" stackMember 是 ARRAY_REFERENCE 1-9个列表项,详细请参见表4。 堆叠成员。 - stackRoles 否 string Gateway CORE Gateway+CORE Gateway+RR Firewall WAC AGG ACC Wireless Access TG ACC 堆叠角色信息。非必填,默认为ACC。 该字段对应UI页面上是:UI【堆叠角色】 "ACC" 表4 StackMemberInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 esn 是 string 10~64个字符。 - 设备ESN。 该字段对应UI页面上是:UI【ESN】 "AP5008293500000001" slotId 否 int32 [0-9] - 堆叠成员编号。(添加盒式堆叠成员时非必填,添加框式堆叠成员时必填)。 该字段对应UI页面上是:UI【槽位号】 0 priority 否 int32 [1-255] 100 堆叠成员优先级。 该字段对应UI页面上是:UI【优先级】 100
  • URI /controller/campus/v1/sdwan/routing-protocol/bgp-public-info 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 否 uuid - - VPN ID。废弃字段。 "a99f794e-b510-438c-a75d-de59f02347eb" tnpId 否 uuid - - TNP ID。废弃字段。 "a99f794e-b510-438c-a75d-de59f02347eb" siteId 是 uuid - - 站点ID,UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId 否 uuid - - 设备ID,UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" familyType 否 string - - BGP业务类型,取值范围vpnv4,ipv4-unicast,不填默认为vpnv4。 "vpnv4"
  • 响应示例 返回状态码为200:接口调用成功,响应体参考QueryBgpPublicPeerResponse。 HTTP/1.1 200 OK Date: Sun,11 May 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" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "peers" : [ { "peerIp" : "10.0.0.1", "localIp" : "10.0.0.1", "peerAs" : "10", "localAs" : "10", "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "keepAliveTime" : 0, "holdTime" : 0, "md5Encrypt" : false, "md5Key" : "", "keyChainEnable" : false, "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInfo" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "vpnv4Enable" : true, "addressFamilys" : [ { "familyType" : "ipv4-unicast", "advertiseCommunity" : false, "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] }, "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] } } ], "vpnv6Enable" : true, "configSource" : "Wan", "nextHopInvariable" : true } ], "addressFamilyGlobals" : [ { "familyType" : "ipv4-unicast", "externalPreference" : 201, "maxLoadBalanceNum" : 1, "defaultRouteRedistribution" : false, "compareDifAsMed" : true, "routeRedistribution" : [ "direct" ], "aggregationRoute" : [ "192.168.10.0/24" ] } ] } ] } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应参数 返回状态码为200:接口调用成功,响应体参考QueryBgpPublicPeerResponse。 表2 QueryBgpPublicPeerResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码:0 表示接口执行成功,非0 表示接口执行失败。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-2个列表项,详细请参见表5。 BGP路由信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/routing-protocol/bgp-public-info?vpnId=a99f794e-b510-438c-a75d-de59f02347eb&tnpId=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb&deviceId=a99f794e-b510-438c-a75d-de59f02347eb&familyType=vpnv4 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
  • 请求示例 HTTP的示例 POST /controller/campus/baseservice/api/v1/filemgr/files/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 [ "addc4e07-b534-4139-888a-5d44c8c7fda3" ]
  • 响应参数 返回状态码为200:删除文件返回结果。响应体参考DeleteFileResponse 表3 DeleteFileResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string - - 错误码。 0 : 无错误 1 : 参数校验或数据访问错误 详细信息见errMsg "0" errMsg string - - 错误信息。 "" successList ARRAY_REFERENCE 详细请参见表4。 删除成功的文件列表。 - failList ARRAY_REFERENCE 详细请参见表5。 删除失败的文件列表。 - 表4 DeleteSuccessFile对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 fileName string - - 文件名 "test.xml" fileId string - - 文件Id - 表5 DeleteFailFile对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 fileName string - - 文件Id - errCode string - - 错误码。 0 : 无错误 1 : 参数校验或数据访问错误 详细信息见errMsg "0" errMsg string - - 错误信息。 "" 返回状态码为400:参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:服务内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:删除文件返回结果。响应体参考DeleteFileResponse HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errCode" : "0", "errMsg" : "", "successList" : [ { "fileName" : "test.xml", "fileId" : "" } ], "failList" : [ { "fileName" : "", "errCode" : "0", "errMsg" : "" } ] } 返回状态码为400:参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 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,11 May 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/net/wactunnel/acc846c5-2fff-694d-2b2d-12dff3d1231a/unbind-relation 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 { "esns" : [ "AA02354LHM1234567890" ], "siteId" : "acc846c5-2fff-694d-2b2d-12dff3d1231a" }
  • 响应示例 返回状态码为200:解绑成功。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "" }
  • URI /controller/campus/v1/networkservice/networkconfig/net/wactunnel/{wacId}/unbind-relation 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 wacId 是 string 36个字符。 - 设备ID。 "acc846c5-2fff-694d-2b2d-12dff3d1231a"
共100000条
提示

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