华为云用户手册

  • 请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-route-policy:community-filter 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000" { "huawei-nce-e-route-policy:community-filter" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "name" : "filter1", "filter-type" : "basic", "basic-node" : [ { "sequence" : 1, "match-mode" : "permit", "community-member" : [ { "value" : "1:1" } ] } ] } ] }
  • 响应示例 返回状态码为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 返回状态码为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-route-policy:community-filter 表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"
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-route-policy:community-filter 是 REFERENCE 详细请参见表4。 团体属性过滤器配置参数。 - 表4 nes-ne-community-filter-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-route-policy:community-filter 否 ARRAY_REFERENCE 详细请参见表5。 团体属性过滤器配置参数。 - 表5 nes-ne-community-filter对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 config-status 否 string reserved initial configuring-database configured-database-success configured-database-failed configuring-device configured-device-success configured-device-failed reserved 配置状态,对应保留未用状态、初始状态、数据库存储中状态、预配置状态、数据库存储失败状态、部署中状态、成功状态、失败状态;不支持编辑,仅查询返回。 "configured-database-success" last-committed-time 否 string 0~255个字符。 - 最后提交时间,该特性最后提交时间;不支持编辑,仅查询返回。 "2022-01-01 00:00:00" related-pkg-version 否 string 0~255个字符。 - 包版本,插件包版本;不支持编辑,仅查询返回。 "1.0.1" edit-state 否 string RUNNING CANDIDATE UNDEPLOYING UNDEPLOYED - 编辑状态,对应运行状态、候选状态、取消部署状态、未部署状态;不支持编辑,仅查询返回。 "RUNNING" name 否 string - - 名称,整数形式时范围1-99,字符串形式时1-51个字符且不能都是数字,单一主键字段。 "filter1" filter-type 是 string basic advanced - 过滤类型。 "basic" basic-node 否 ARRAY_REFERENCE 1-65535个列表项,详细请参见表6。 节点。 - 表6 nes-ne-community-filter-basic-node对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 sequence 否 int64 [1-4294967295] - 序号,单一主键字段。 1 match-mode 否 string permit deny - 匹配类型。 "permit" community-member 否 ARRAY_REFERENCE 0-20个列表项,详细请参见表7。 团体属性。 - 表7 nes-ne-community-filter-basic-node-community-member对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 value 否 string - - 团体值,取值范围为0-65535:0-65535 或 1-4294967040 或 4294967044-4294967295,单一主键字段。 "1:1"
  • 响应示例 返回状态码为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" : { "name" : "subnet1", "vlanId" : 100, "ipv4poolOrNot" : 0, "ipAddress" : "192.168.12.12", "maskAddress" : 24, "subIpList" : [ { "subIpAddress" : "192.168.13.13", "subMaskAddress" : 24 } ], "arpEnable" : false, "mtu" : 1500, "dhcpEnable" : true, "icmpRedirectSendEnable" : true, "dhcpConfig" : { "dhcpMode" : "server", "relayServerIps" : [ "10.122.12.1" ], "dhcpServerConfig" : { "dnsConfig" : { "dnsServerMode" : "custom", "priorDnsServer" : "10.15.15.15", "standbyDnsServer" : "10.15.15.16" }, "domainSuffix" : "com", "manegeNetworkEnable" : true, "exceptFitAp" : "CloudAP", "option148" : false, "acAddressType" : "IP", "option43" : false, "wacAddress" : [ "10.122.12.1" ], "dhcpServerLogging" : false, "dhcpServerOptions" : [ { "code" : 26, "subCode" : 5, "optionType" : "hex", "optionValue" : "2e" } ], "leasesConfig" : { "unlimit" : false, "day" : 1, "hour" : 0, "minute" : 0 }, "excludedAddresses" : [ { "startIpAddress" : "192.168.12.13", "endIpAddress" : "192.168.12.13" } ], "fixIpEnable" : false, "fixedIpRange" : [ { "startIpAddress" : "192.168.12.13", "endIpAddress" : "192.168.12.13" } ], "staticBindings" : [ { "staticIpAddress" : "192.168.12.14", "staticMacAddress" : "XX:XX:XX:XX:XX:XX" } ] } }, "id" : "30a51c112787470f81045d60ccf3995f" } } 返回状态码为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/lswsubnet/devices/{deviceId}/subnet 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string - - 设备ID,UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/net/lswsubnet/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/subnet 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" : "subnet1", "vlanId" : 100, "ipv4poolOrNot" : 0, "ipAddress" : "192.168.12.12", "maskAddress" : 24, "subIpList" : [ { "subIpAddress" : "192.168.13.13", "subMaskAddress" : 24 } ], "arpEnable" : false, "mtu" : 1500, "dhcpEnable" : true, "icmpRedirectSendEnable" : true, "dhcpConfig" : { "dhcpMode" : "server", "relayServerIps" : [ "10.122.12.1" ], "dhcpServerConfig" : { "dnsConfig" : { "dnsServerMode" : "custom", "priorDnsServer" : "10.15.15.15", "standbyDnsServer" : "10.15.15.16" }, "domainSuffix" : "com", "manegeNetworkEnable" : true, "exceptFitAp" : "CloudAP", "option148" : false, "acAddressType" : "IP", "option43" : false, "wacAddress" : [ "10.122.12.1" ], "dhcpServerLogging" : false, "dhcpServerOptions" : [ { "code" : 26, "subCode" : 5, "optionType" : "hex", "optionValue" : "2e" } ], "leasesConfig" : { "unlimit" : false, "day" : 1, "hour" : 0, "minute" : 0 }, "excludedAddresses" : [ { "startIpAddress" : "192.168.12.13", "endIpAddress" : "192.168.12.13" } ], "fixIpEnable" : false, "fixedIpRange" : [ { "startIpAddress" : "192.168.12.13", "endIpAddress" : "192.168.12.13" } ], "staticBindings" : [ { "staticIpAddress" : "192.168.12.14", "staticMacAddress" : "XX:XX:XX:XX:XX:XX" } ] } } }
  • 响应示例 返回状态码为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" : "", "siteId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "deviceId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "interfaceId" : "50601b1c-c751-4072-9bca-2cf79b63bf70" } 返回状态码为204:接口调用成功,无数据。 HTTP/1.1 204 No Content 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 返回状态码为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的示例 DELETE /controller/campus/rest/sdwan/v1/device/nac/config?siteId=fbb684c8-0d37-496f-bafa-4b06d5151e2e&deviceId=fbb684c8-0d37-496f-bafa-4b06d5151e2e&interfaceId=fbb684c8-0d37-496f-bafa-4b06d5151e2e 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 DeleteNacConfigResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" siteId string 0~36个字符。 - 站点ID。 "fbb684c8-ddaa-3451-bafa-4b06d5158956" deviceId string 0~36个字符。 - 设备ID。 "fbb684c8-ddaa-3451-bafa-4b06d5158956" interfaceId string 0~36个字符。 - 接口ID。 "50601b1c-c751-4072-9bca-2cf79b63bf70" 返回状态码为204:接口调用成功,无数据。 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • URI /controller/campus/rest/sdwan/v1/device/nac/config 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 string 0~36个字符。 - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceId 否 string 0~36个字符。 - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" interfaceId 否 string 0~36个字符。 - 接口ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/profile/radius 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" : "radius1", "description" : "radius1", "multipleBackupServerConfig" : true, "radiusServerType" : "thirdPartyServer", "iaeDtoList" : [ { "iaeId" : "ce67b74c-01ac-4e2a-81af-0908d98ea242", "iaeName" : "iae12", "iaeIp" : "192.168.1.1", "iaeAd" : "example.com", "iaeIpv6" : "FC00::0", "weight" : 80, "slaveIaeId" : "ce67b74c-01ac-4e2a-81af-0908d98ea242", "slaveIaeName" : "iae12", "slaveIaeIp" : "192.168.1.1", "slaveIaeAd" : "example.com", "slaveIaeIpv6" : "FC00::0" } ], "authServerList" : [ { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10, "weight" : 80 } ], "accountServerList" : [ { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10, "weight" : 80 } ], "masterAuthServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10 }, "slaveAuthServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.2", "port" : 10 }, "masterAccountServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10 }, "slaveAccountServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.2", "port" : 10 }, "realtimeAccounting" : { "realtimeEnable" : true, "realtimeInterval" : 10 }, "serverSelectionPolicy" : "master-backup", "serverSelectionAlgorithm" : "packets", "dpskConfig" : { "supportDpsk" : true, "dpskEncryptionMode" : "aes256gcm" }, "prohibitAttribute" : { "enable" : true, "attributes" : [ { "attributeName" : "HW-Input-Peak-Information-Rate", "prohibitReceive" : true, "prohibitSend" : true } ] }, "radiusAttributeConfig" : { "enable" : true, "attributes" : [ { "attributeName" : "Service-Type", "attributeValue" : "241", "optionValue" : "auth-type-mac", "macValue" : "10", "dot1xValue" : "2", "portalValue" : "4" } ] }, "calledStationId" : { "enable" : true, "attributeValue" : "ap-mac", "includeSsid" : true, "delimiter" : "+" }, "macFormatSetting" : { "macFormat" : true, "letter" : "uppercase", "connector" : "hyphen-split", "mode" : "XX" }, "enableAutomaticServerStatusDetection" : true, "automaticServerStatusDetection" : { "name" : "test", "password" : "null", "upServerInterval" : "" }, "enableAuthRequestRetransmitConfig" : true, "authRequestRetransmitConfig" : { "timeoutRetransmissionTimes" : 3, "timeoutInterval" : 5, "serverDownDuration" : 5 }, "sourceIpEnable" : true, "nassPortIdFormat" : "new", "translateExtendList" : [ { "accessAccept" : true, "accountResponse" : false, "srcVendorId" : 9, "srcSubId" : 2, "destAttributeName" : "HW-Input-Committed-Burst-Size" } ], "startAccountingFail" : true, "configName" : "abc", "shareKey" : "null" }
  • 响应示例 返回状态码为201:成功创建的RADIUS模板信息。 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" : "radius1", "description" : "radius1", "multipleBackupServerConfig" : true, "radiusServerType" : "thirdPartyServer", "iaeDtoList" : [ { "iaeId" : "ce67b74c-01ac-4e2a-81af-0908d98ea242", "iaeName" : "iae12", "iaeIp" : "192.168.1.1", "iaeAd" : "example.com", "iaeIpv6" : "FC00::0", "weight" : 80, "slaveIaeId" : "ce67b74c-01ac-4e2a-81af-0908d98ea242", "slaveIaeName" : "iae12", "slaveIaeIp" : "192.168.1.1", "slaveIaeAd" : "example.com", "slaveIaeIpv6" : "FC00::0" } ], "authServerList" : [ { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10, "weight" : 80 } ], "accountServerList" : [ { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10, "weight" : 80 } ], "masterAuthServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10 }, "slaveAuthServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.2", "port" : 10 }, "masterAccountServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10 }, "slaveAccountServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.2", "port" : 10 }, "realtimeAccounting" : { "realtimeEnable" : true, "realtimeInterval" : 10 }, "serverSelectionPolicy" : "master-backup", "serverSelectionAlgorithm" : "packets", "dpskConfig" : { "supportDpsk" : true, "dpskEncryptionMode" : "aes256gcm" }, "prohibitAttribute" : { "enable" : true, "attributes" : [ { "attributeName" : "HW-Input-Peak-Information-Rate", "prohibitReceive" : true, "prohibitSend" : true } ] }, "radiusAttributeConfig" : { "enable" : true, "attributes" : [ { "attributeName" : "Service-Type", "attributeValue" : "241", "optionValue" : "auth-type-mac", "macValue" : "10", "dot1xValue" : "2", "portalValue" : "4" } ] }, "calledStationId" : { "enable" : true, "attributeValue" : "ap-mac", "includeSsid" : true, "delimiter" : "+" }, "macFormatSetting" : { "macFormat" : true, "letter" : "uppercase", "connector" : "hyphen-split", "mode" : "XX" }, "enableAutomaticServerStatusDetection" : true, "automaticServerStatusDetection" : { "name" : "test", "password" : "null", "upServerInterval" : "" }, "enableAuthRequestRetransmitConfig" : true, "authRequestRetransmitConfig" : { "timeoutRetransmissionTimes" : 3, "timeoutInterval" : 5, "serverDownDuration" : 5 }, "sourceIpEnable" : true, "nassPortIdFormat" : "new", "translateExtendList" : [ { "accessAccept" : true, "accountResponse" : false, "srcVendorId" : 9, "srcSubId" : 2, "destAttributeName" : "HW-Input-Committed-Burst-Size" } ], "startAccountingFail" : true, "configName" : "abc", "id" : "fbb684c8-0d37-496f-bafa-4b06db151e2e" } } 返回状态码为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-nat-address-group:snat-address-group/{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" name 是 string 1~34个字符。 - 源NAT地址池名称,单一主键字段。 "name"
  • 请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nat-address-group:snat-address-group/name 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 { "huawei-nce-e-nat-address-group:snat-address-group" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "name" : "name", "mode" : "full-cone", "mode-pattern" : { "reverse-enable" : true, "address-zone" : "global" }, "sections" : { "section" : [ { "section-id" : 5, "start-ip" : "192.168.1.2", "end-ip" : "192.168.1.5" } ] }, "vrid" : 6, "port-block" : { "size" : 10, "extended-times" : 1, "start-port" : 1000, "end-port" : 1100 } } ] } 返回状态码为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 /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-ssl-policy:ssl-policies/test1 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"
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-ssl-policy:ssl-policies/{policy-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" policy-name 是 string 1~23个字符。满足正则表达[a-z0-9_]*。 - ssl-policies名称配置,范围为1-23位小写字符,数字,下划线 "test1"
  • 响应示例 返回状态码为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-ssl-policy:ssl-policies" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "policy-name" : "test1", "pki-realm" : "default", "cert-file" : "Device-cert.pem", "key-file" : "Device-key.pem", "auth-code-cert" : "Huawei@123", "ca-file-one" : "SRV6_CA.cer", "auth-code-ca-one" : "ddddd", "ca-file-two" : "ddddd", "auth-code-ca-two" : "ddddd" } ] } 返回状态码为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:接口调用成功,响应体参考BgpRouteResponse。返回的BGP路由信息中仅包含对应的vpnId,siteId,deviceId。 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" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "publicInfo" : { "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" ] } ] }, "vpnInstanceInfos" : [ { "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" : "ipv4-unicast", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e" } ] } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "publicInfo" : { "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" ] } ] }, "vpnInstanceInfos" : [ { "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" : "ipv4-unicast", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e" } ] } } ] } 返回状态码为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/routing-protocol/bgp/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 { "routes" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "publicInfo" : { "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" ] } ] }, "vpnInstanceInfos" : [ { "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" : "ipv4-unicast", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e" } ] } ] }
  • 响应参数 返回状态码为200:查询成功,返回结构体参见PnpEnableResponseDto。 表2 PnpEnableResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表3。 - - 表3 PnpEnableDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pnpEnable boolean true false false PNP功能使能。默认值为false。 false pnpLinkAggregationDisable boolean true false false PNP自协商功能使能。默认值为false。 false
  • URI /controller/campus/v1/networkservice/networkconfig/net/lswmgmtvlan/sites/{siteId}/pnpenable 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 32~36个字符。 - 站点ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 响应示例 返回状态码为200:查询成功,返回结构体参见PnpEnableResponseDto。 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" : { "pnpEnable" : false, "pnpLinkAggregationDisable" : false } }
  • 请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/lswmgmtvlan/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/pnpenable 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
  • URI /controller/campus/v1/sdwan/statistic/cdr 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 是 int32 - - MSP分页的序号,支持范围必须大于0。若当前为admin视图,则分页查询其msp,统计各msp下各device的型号数量以及vam下vcpus数量;若当前为msp视图,则分页查询其租户,统计各租户下各device的型号数量以及vam下vcpus数量。 1 pageSize 是 int32 - - MSP分页的大小,支持范围1-100。若当前为admin视图,则分页查询其msp,统计各msp下各device的型号数量以及vam下vcpus数量;若当前为msp视图,则分页查询其租户,统计各租户下各device的型号数量以及vam下vcpus数量。 20
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/statistic/cdr?pageIndex=1&pageSize=20 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:查询成功,响应体参考CdrStatisticResponseDto。 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" : "", "pageIndex" : 1, "pageSize" : 20, "totalMspRecords" : 1, "mspData" : [ { "name" : "AR1600", "type" : "Cumulative", "unit" : "Number", "volume" : 30.0, "projectId" : "MSP name" } ] } 返回状态码为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:查询成功,响应体参考CdrStatisticResponseDto。 表2 CdrStatisticResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码: 当没有错误时返回0。 "0" errmsg string 0~256个字符。 - 接口调用结果的描述信息。 "" pageIndex int32 - - MSP分页的序号。 1 pageSize int32 - - 分页的大小。 20 totalMspRecords int32 - - msp总数。 1 mspData ARRAY_REFERENCE 0-2147483647个列表项,详细请参见表3。 基于MSP维度下的数据项。 - 表3 CdrStatisticDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string - - 指标名称。 设备款型或者VCPU。 "AR1600" type string - - 指标类型。 范围只支持Cumulative。 "Cumulative" unit string - - 指标使用单位。 范围只支持Number。 "Number" volume float - - 指标当前使用量。 30.0 projectId string - - 指标所属租户。 "MSP name" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/accountservice/terminalmgr/endpoint/batch-update 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 { "macList" : ["11-11-11-11-11-11","22-22-22-22-22-22"], "terminalGroupId" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "isBlocked" : true, "isApproved" : 1, "expirationDate" : 60, "bindingDeviceMac" : "11-11-11-11-11-11", "bindingDevicePort" : "GigabitEthernet0/0/1", "description" : "update terminal", "deviceType" : "打印机", "deviceVendor" : "HP", "deviceModel" : "HP-5720", "osVendor" : "Microsoft", "osType" : "Windows", "osVersion" : "18362.1082", "customFields" : [ { "name" : "资产编号", "value" : "HW-00001" } ] }
共100000条
提示

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