华为云用户手册

  • 响应示例 返回状态码为200:响应对象,接口返回体参考GetIpListResponseVo。 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" : "", "pageVo" : { "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 1 }, "ipItems" : [ { "siteId" : "d235353a-1284-4aad-9f35-18af543fcf5b", "siteName" : "s74", "deviceName" : "AR8140-74", "deviceId" : "6a650c65-b5d7-482f-811a-18efbbde48b6", "linkName" : "GigabitEthernet0/0/3", "vrf" : "underlay_2", "vpnName" : "vpn1", "ipAddress" : "10.1.1.1", "ipv6Address" : "10::1", "usage" : "UNDERLAY" } ] } 返回状态码为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的示例 POST /controller/campus/v1/sdwan/performance/ipresources/query 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 { "siteIdList" : [ "d235353a-1284-4aad-9f35-18af543fcf5b" ], "vpnId" : "b09a0266-f34e-125d-ce23-ad1278b6c59a", "ipAddress" : "10.1.1.1", "scopeType" : "INTER_ACCESS", "pageDto" : { "pageIndex" : 1, "pageSize" : 20 } }
  • 响应示例 返回状态码为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 { "huawei-nce-e-static-routing-ipv4:static-routing-ipv4" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "destination-prefix" : "10.1.1.0/24", "vpn-instance" : "vpn1", "next-hop-type" : "Ip", "next-hop-addresses" : [ { "address" : "10.1.1.1", "preference" : 10, "track-setting" : "nqa", "nqa" : "test", "bfd-enable" : true } ], "next-hop-interfaces" : [ { "interface" : "GE0/0/1", "preference" : 10, "dhcp-enable" : true, "track-setting" : "nqa", "nqa" : "test" } ], "next-hop-interface-addresses" : [ { "address" : "10.1.1.1", "interface" : "GE0/0/1", "preference" : 10, "track-setting" : "nqa", "nqa" : "test", "bfd-enable" : true } ] } ] } 返回状态码为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
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-static-routing-ipv4:static-routing-ipv4 表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的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-static-routing-ipv4:static-routing-ipv4 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,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" : "", "groupName" : "HUAWEI", "parentId" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "description" : "product" } } 返回状态码为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的示例 PUT /controller/campus/v1/accountservice/terminalmgr/endpointgroup/22fbb5f2-d07e-4710-94ac-7705517ab842 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 { "groupName" : "HUAWEI", "description" : "product" }
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 modifyParam 是 REFERENCE 详细请参见表3。 待修改的终端组详细信息。响应体参考TerminalGroupUpdateDto。 - 表3 TerminalGroupUpdateDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 groupName 是 string 0~64个字符。 - 终端组名称,1~64个字符,不支持特殊字符。 "HUAWEI" description 否 string 0~64个字符。 - 终端组描述,不支持特殊字符。 "product"
  • 响应示例 返回状态码为200:配置的设备BootROM密码。 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" : "" }
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/bootrom/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/bootrom 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 { "passwd" : "Iam@example1", "oldPasswd" : "Iam@example1" }
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 bootRomDto 是 REFERENCE 详细请参见表3。 配置的设备BootROM密码。 - 表3 BootRomDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 passwd 否 password 8~255个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 V200版本的LSW设备新密码必须包含如下规则: 1.密码长度必须在8-80位。 2.密码必须满足复杂度,即至少包含英文大写字母(A~Z)、英文小写字母(a~z)、数字(0~9)、特殊字符(如!、@、#、$、%)等中的三种,不允许包含'、?和空格。 3.密码中不能包含两个以上连续的相同字符。 V600版本的LSW设备新密码必须包含如下规则: 1、长度限制 8~255 2、新旧密码不能相同 3、密码不包含空格 4、密码复杂度校验 小写字母 大写字母 数字 特殊字符至少包含两种 "Iam@example1" oldPasswd 否 password 8~255个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 V200版本的LSW设备不需要此字段,V600版本的LSW设备旧密码必须包含如下规则: 1、长度限制 8~255 2、新旧密码不能相同 3、密码不包含空格 4、密码复杂度校验 小写字母 大写字母 数字 特殊字符至少包含两种 "Iam@example1"
  • URI /controller/campus/v1/networkservice/networkconfig/net/bootrom/sites/{siteId}/bootrom 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点标识,UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/snmp/sites/fbde1c5d-5b94-49e3-a912-48641015e45c/snmp HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "snmpEnable" : true, "protocolVersion" : "V3", "userInfos" : [ { "snmpUserName" : "Huawei-Guest", "snmpPrivateProtocol":"3des", "snmpPasswd" : "d03$Q6C#", "snmpAuthProtocol": "MD5", "snmpAuth": "d03$Q6C#" } ], "aclIps" : [ "192.168.1.1" ], "trapEnable" : true, "targetHosts" : [ { "hostIp" : "192.168.2.2", "hostName" : "Huawei-Guest" } ], "updownTrapEnable" : true }
  • 响应示例 返回状态码为200:站点SNMP配置结果,返回结构体参见SiteSnmpResponseDto。 HTTP/1.1 200 OK Date: Thu,13 Sep 2018 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode" : "0", "errmsg" : "", "data" : { "snmpEnable" : true, "protocolVersion" : "V3", "userInfos" : [ { "snmpUserName" : "Huawei-Guest", "snmpPrivateProtocol":"3des", "snmpPasswd" : "********", "snmpAuthProtocol": "MD5", "snmpAuth": "********" } ], "aclIps" : [ "192.168.1.1" ], "trapEnable" : true, "targetHosts" : [ { "hostIp" : "192.168.2.2", "hostName" : "Huawei-Guest" } ], "updownTrapEnable" : true } } 返回状态码为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的示例 GET /v1/networkconfig/wlan/ap/vlanpools?siteId=fbb684c8-0d37-496f-bafa-4b06d6151e2e&pageIndex=1&pageSize=1&vlanPoolName=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
  • 响应示例 返回状态码为200:查询AP VLAN POOL成功,响应体参考GetApVlanPoolResponse。 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" : "", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "data" : [ { "id" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "name" : "VLANPOOLTemplate1", "range" : "3001", "type" : "even" } ], "pageIndex" : 1, "pageSize" : 1, "totalRecords" : 1 } 返回状态码为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
  • URI /v1/networkconfig/wlan/ap/vlanpools 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d6151e2e" pageIndex 否 int32 [1-1500] 1 第几页的数据。 1 pageSize 否 int32 [1-100] 20 一页多少条数据。 1 vlanPoolName 否 string 0~32个字符。 - VLAN POOL名称。 "pool1"
  • 响应示例 返回状态码为201:接口调用成功,响应体参考StaticArpResponse。 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" : "", "vpnId" : "00000000-0000-0000-0000-00000000", "siteId" : "00000000-0000-0000-0000-00000000", "success" : [ { "deviceId" : "00000000-0000-0000-0000-00000000", "id" : "00000000-0000-0000-0000-00000000", "vlanId" : "100", "ipAddress" : "192.168.1.1", "macAddress" : "0000-0000-0000", "outInterfaceName" : "GigabitEthernet0/0/0", "arpType" : "system" } ], "fail" : [ { "errparams" : [ "siteId" ], "errcode" : "0", "errmsg" : "", "data" : { "deviceId" : "00000000-0000-0000-0000-00000000", "id" : "00000000-0000-0000-0000-00000000", "vlanId" : "100", "ipAddress" : "192.168.1.1", "macAddress" : "0000-0000-0000", "outInterfaceName" : "GigabitEthernet0/0/0", "arpType" : "system" } } ] } 返回状态码为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的示例 POST /controller/campus/ui/v1/sdwan/lan/static-arps 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 { "vpnId" : "00000000-0000-0000-0000-00000000", "siteId" : "00000000-0000-0000-0000-00000000", "staticArp" : [ { "deviceId" : "00000000-0000-0000-0000-00000000", "id" : "00000000-0000-0000-0000-00000000", "vlanId" : "100", "ipAddress" : "192.168.1.1", "macAddress" : "0000-0000-0000", "outInterfaceName" : "GigabitEthernet0/0/0", "arpType" : "system" } ] }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 创建SD-WAN Static ARP子网参数体。 - 表2 StaticArps对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 否 uuid - - vpn id标识,uuid格式。创建和修改Static ARP时必填,删除Static ARP非必填。 "00000000-0000-0000-0000-00000000" siteId 否 uuid - - 站点 id标识,uuid格式。创建和修改Static ARP时必填,删除Static ARP非必填。 "00000000-0000-0000-0000-00000000" staticArp 否 ARRAY_REFERENCE 1-100个列表项,详细请参见表3。 Static ARP集合 - 表3 StaticArp对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 uuid 0~36个字符。 - 设备ID,VRRP使能是对两个设备生效,不需要指定设备ID,uuid格式。 "00000000-0000-0000-0000-00000000" id 否 uuid - - 子网ID,用来识别更新还是增加的关键元素。 "00000000-0000-0000-0000-00000000" vlanId 否 string 0~32个字符。 - VLAN ID。L2LAN接口VLAN ID或者L3LAN接口子接口的VLAN ID。 "100" ipAddress 否 string 0~32个字符。 - IP地址。当arpType取值为interface时,使用引用的LAN接口同网段地址。 "192.168.1.1" macAddress 否 string 0~64个字符。 - MAC地址。 "0000-0000-0000" outInterfaceName 否 string 0~32个字符。 - 出接口接口名称。LAN接口引用的物理接口或者Eth-Trunk。 "GigabitEthernet0/0/0" arpType 否 string 1~18个字符。 system arp类型,取值范围:system、interface。创建时必填。配置后不支持修改。 "system"
  • 响应参数 返回状态码为200:修改成功,响应体参考DeviceManagerUserResponse。 DeviceManagerUserResponse对象的参数列表,详细请参见表3。 返回状态码为400:请求参数错误,响应体参考CommonDeviceManagerResponse。 表4 CommonDeviceManagerResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/aaa/devicemanager/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-ACCESS-TOKEN: x-yyyyyy { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "domainId" : "00000000-0000-0000-0000-000000000000", "userName" : "name", "state" : "active", "serviceType" : "['http','ssh','terminal']", "privilegeLevel" : 0, "expireTime" : "2025-04-12T23:20:50.520Z", "timerange" : "10:00-12:00", "idleTimeout" : 5, "deviceUserId" : "00000000-0000-0000-0000-000000000000", "password" : "Example@123" }
  • 响应示例 返回状态码为200:修改成功,响应体参考DeviceManagerUserResponse。 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" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "domainId" : "00000000-0000-0000-0000-000000000000", "userName" : "name", "state" : "active", "serviceType" : "['http','ssh','terminal']", "privilegeLevel" : 0, "expireTime" : "2025-04-12T23:20:50.520Z", "timerange" : "10:00-12:00", "idleTimeout" : 5, "deviceUserId" : "00000000-0000-0000-0000-000000000000", "createTime" : "1985-04-12 23:20:50" } } 返回状态码为400:请求参数错误,响应体参考CommonDeviceManagerResponse。 HTTP/1.1 400 Bad Request Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0x587679", "errmsg" : "" } 返回状态码为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
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 设备管理员。 - 表3 DeviceManagerUserRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID,UUID格式。 "00000000-0000-0000-0000-000000000000" deviceId 是 uuid - - 设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" domainId 是 uuid - - 域ID,UUID格式,需要先创建域。 "00000000-0000-0000-0000-000000000000" userName 是 string 1~64个字符。 - 设备管理员名称。 创建后不允许修改。 其中V600版本设备的设备管理员名称有如下说明: a) 针对V600R021C00版本及之后版本的设备,名称为admin时补齐为administrator下发; b) 长度不能小于6; c) 不允许创建名称为administrator的设备管理员。 "name" state 否 string active block active 帐号状态,该字段可以设置为以下几种: a) active:激活状态 b) block:阻塞状态 激活状态的帐号可以进行登录认证,阻塞状态的帐号设备拒绝登录认证。 默认值active。 "active" serviceType 否 string - ['http'] 服务类型,该字段可以设置为以下几种: a) http b) ssh c) terminal http为不安全协议,建议使用更安全的服务类型。 默认值['http']。 "['http','ssh','terminal']" privilegeLevel 否 integer [0-15] 0 用户级别,取值范围:0~15。 其中FW设备的用户级别取值范围为0~3。默认值0。 0 expireTime 否 string 0~128个字符。满足正则表达((((20)(([2468][048])|([13579][26])))-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|(11))-(0[1-9]|[12][0-9]|(30)))|(((02)-(0[1-9]|[12][0-9])))))|(((20)(([2468][1235679])|([13579][01345789])))-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|(11))-(0[1-9]|[12][0-9]|(30)))|(((02)-(0[1-9]|[12][0-8]))))))T(([01][0-9])|(2[0-3])):([0-5][0-9]):([0-5][0-9])(\.\d{3})(Z|[\+\-]([0-5][0-9]):([0-5][0-9]))。 2099-12-31T00:00:00.000Z 帐号有效期截止时间,格式为YYYY-MM-DDTHH:MM:SS.SSSZ。 其中V600版本设备的帐号有效期截止时间最大可设置为2037-12-31T23:59:59.000Z。 默认2099-12-31T00:00:00.000Z,其中V600版本设备默认2037-12-31T23:59:59.000Z。 设备管理员创建后此属性不可修改。 "2025-04-12T23:20:50.520Z" timerange 否 string 1~128个字符。满足正则表达^(([01]?[0-9])|(2[0-3])):[0-5]?[0-9]-(([01]?[0-9])|(2[0-3])):[0-5]?[0-9]$。 - 指定userName接入时间段范围,格式:HH:MM-HH:MM。 设备管理员创建后不可修改。 "10:00-12:00" idleTimeout 否 int32 [0-1200] 10 用户的闲置超时时间,单位:秒。 默认为10。 5 deviceUserId 是 uuid - - 设备管理员ID,UUID格式。 "00000000-0000-0000-0000-000000000000" password 否 password 8~128个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 1.密码长度必须在8~128位。 2.密码必须满足复杂度,即至少包含英文大写字母(A~Z)、英文小写字母(a~z)、数字(0~9)、特殊字符(如!、@、#、$、%)等中的三种,V600版本的设备至少包含其中的四种,不允许包含'、?和空格。 3.密码中不能包含超过两个连续的相同字符。 4.密码不能为用户名或用户名的倒写。 "Example@123"
  • 响应参数 返回状态码为201:创建成功,返回体参考ConfigPortResponse。 表4 ConfigPortResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-10个列表项,详细请参见表5。 端口信息。 - 表5 PortInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 portId string 36个字符。 - 端口标识。uuid格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" portName string 0~128个字符。 - 观察口/镜像口名称。 "GE0/0/1" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为201:创建成功,返回体参考ConfigPortResponse。 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" : [ { "portId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "portName" : "GE0/0/1" } ] } 返回状态码为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的示例 POST /controller/campus/v1/lanwan/mirror/observeport 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 { "observePorts" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "portName" : "GE0/0/1" } ] }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 observePortInfos 是 REFERENCE 详细请参见表2。 创建端口镜像观察口。 - 表2 CreateObservePortRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 observePorts 是 ARRAY_REFERENCE 1-10个列表项,详细请参见表3。 观察端口。 - 表3 CreateObservePortInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点标识。uuid格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceId 是 string 36个字符。 - 设备标识。uuid格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" portName 是 string 0~128个字符。 - 观察口名称。GRE隧道模式下,需要先创建物理接口。 "GE0/0/1"
  • 响应示例 返回状态码为200:删除成功,响应体参考AddressSetResponse。 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" : "", "processInstanceId" : "", "success" : [ { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "addressSetType" : 0, "ipAddresses" : [ "192.168.0.0/24" ] } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "addressSetType" : 0, "ipAddresses" : [ "192.168.0.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
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/security/address-set/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 { "addressSetInfo" : [ { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "addressSetType" : 0, "ipAddresses" : [ "192.168.0.0/24" ] } ] }
共100000条
提示

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