华为云用户手册

响应示例 返回状态码为200：删除成功，响应体参考TrafficSteeringPolicyResponse。 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" : [ { "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 } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "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 } } ] } 返回状态码为204：执行成功，无响应体。 HTTP/1.1 204 No Content 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

响应参数 返回状态码为200：查询TNP成功，响应体参考QueryTnpResponse。 表2 QueryTnpResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 200 pageSize int32 - - 分页数。 20 pageIndex int32 - - 当前页数 1 multipleSubIfEnabled boolean true false - 支持多子接口 false enhancedMode boolean true false - 增强模式 false urlLinkEnabled boolean true false - 站点是否URL开局 false data ARRAY_REFERENCE 0-512个列表项，详细请参见表18。 TNP信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询TNP成功，响应体参考QueryTnpResponse。 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" : 200, "pageSize" : 20, "pageIndex" : 1, "multipleSubIfEnabled" : false, "enhancedMode" : false, "urlLinkEnabled" : false, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "Link1", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "portId" : "00000000-0000-0000-0000-000000000000", "portType" : 1, "portNum" : "0/0/1", "enable5G" : "", "inSubInterface" : false, "vlanId" : 1, "subInterfaceNumber" : 1, "tnplinkInfo" : { "cellular" : { "apn" : "abc", "userName" : "user1", "userKey" : "******", "authType" : 0, "priority" : 100, "trackEnable" : false, "nqaInfo" : { "destAddress" : "192.168.1.1" } }, "standbyCellularEnable" : false, "standbyCellular" : { "apn" : "abc", "userName" : "user1", "userKey" : "******", "authType" : 0, "priority" : 100, "trackEnable" : false, "nqaInfo" : { "destAddress" : "192.168.1.1" } }, "simSwitchBackEnable" : false, "simSwitchBackTime" : 60, "atm" : { "pvcVpi" : 123, "pvcVci" : 123 } }, "ipConnection" : { "ipv4" : { "publicIP" : "192.168.1.1", "accessType" : "PPPoE", "ipMode" : "Static", "customerAddress" : "192.168.1.1", "prefixLength" : 24, "providerAddress" : "192.168.1.1", "peerIp" : "192.168.1.1", "userName" : "admin", "userKey" : "******", "authType" : 0, "dlci" : 55, "interfaceMode" : 0 }, "ipv6" : { "accessType" : "IPoE", "ipMode" : "Static", "customerIPv6Address" : "fc00:3::1", "ipv6PrefixLength" : 64, "providerIpv6Address" : "fc00:3::1", "linkIpv6Pd" : "sdwanprefix", "linkIpv6PdAddr" : "fc00:3::1/64", "linkDhcpv6Option16Type" : "ascii", "linkDhcpv6Option16" : "101068,0001", "linkDhcpv6Pd" : "sdwanprefix", "enableIPv6AcSouthAccess" : true, "ipv6AcSouthAccessId" : "00000000-0000-0000-0000-000000000003", "ipv6MailUsedSouthAccess" : false, "ipv6AccessPreference" : "low" } }, "transportNetworkInfo" : { "transportNetworkId" : "00000000-0000-0000-0000-000000000000", "workMode" : "active", "sendAlarmEnabled" : false }, "ntp" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ntpType" : "IPv6", "preferEn" : false, "serverIP" : "fc00:3::1", "authentication" : false, "mode" : "HMAC-SHA256", "authKey" : "******", "authId" : 10 } ], "attributes" : { "inputBandwidth" : 1000, "outputBandwidth" : 1000, "mtu" : 1500, "TCPmss" : 1200, "ipv6Mtu" : 1500 }, "description" : "site tnp", "natEnable" : false, "ztpMode" : 0, "ipv6ZtpMode" : 0, "underlayVrf" : "underlay_1", "routingDistinguisher" : "1111:1111", "clearDeviceConfig" : true, "enableOverlay" : true, "enableIpv6Overlay" : false, "acSouthAccessId" : "00000000-0000-0000-0000-000000000001", "mailUsedSouthAccess" : false, "linkInformation" : "link1", "accessPreference" : "low", "enableSecondSouthAccess" : false, "secondSouthAccess" : { "acSouthAccessId" : "00000000-0000-0000-0000-000000000002", "accessPreference" : "low" }, "syncModifyDeviceUrlConfig" : false, "enableLoopbackSrcInterface" : false, "enableRu" : false, "disableDefaultRuRoute" : false } ] } 返回状态码为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/sdwan/net/transport-network-ports?tnpId=00000000-0000-0000-0000-000000000000&siteId=00000000-0000-0000-0000-000000000000&deviceId=00000000-0000-0000-0000-000000000000&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-AC CES S-TOKEN: x-yyyyyy

URI /controller/campus/v1/sdwan/net/transport-network-ports 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 tnpId 否 uuid - - 传输网络端口ID，uuid格式。查询具有指定tnpId的TNP信息。 "00000000-0000-0000-0000-000000000000" siteId 是 uuid - - 站点ID，uuid格式。查询指定siteId下的全部TNP信息。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备ID，uuid格式。查询对应设备下的全部TNP信息。 "00000000-0000-0000-0000-000000000000" pageIndex 否 int32 - 1 当前页数，默认是1。 1 pageSize 否 int32 - 20 每页显示的总条数，默认是20。 20

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-bgp:vpn-bgp/_public_ 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" { "huawei-nce-e-bgp:vpn-bgp" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "vpn-instance" : "_public_", "router-id" : "10.1.0.0", "ipv4-unicast" : { "enable" : true, "default-route-import" : true, "route-select-delay" : 10, "reflector-cluster-id" : 10, "reflect-change-path" : true, "auto-frr" : true, "mode" : "be", "down-switch" : true, "route-relay-tunnel-v6-selector" : "policy1", "preference" : { "external" : 10, "internal" : 10, "local" : 10 }, "aggregate-route" : [ { "address" : "192.168.1.1", "mask" : 24 } ], "network-route" : [ { "address" : "192.168.1.2", "mask" : 24, "route-policy" : "policy1" } ], "import-routing" : [ { "protocol" : "static", "thead-id" : 10, "cost" : 10, "route-policy" : "policy1" } ], "evpn" : { "srv6" : { "mode" : "be", "down-switch" : true }, "locator" : [ { "name" : "name" } ] }, "advertise-l2-evpn" : { "advertise-route-to-evpn" : [ { "protocol" : "all", "advertise-route-mode" : "all" } ] }, "locator" : [ { "name" : "name" } ] }, "ipv6-unicast" : { "enable" : true, "default-route-import" : true, "route-select-delay" : 10, "reflector-cluster-id" : 10, "reflect-change-path" : true, "auto-frr" : true, "mode" : "be", "down-switch" : true, "route-relay-tunnel-v6-selector" : "policy1", "preference" : { "external" : 10, "internal" : 10, "local" : 10 }, "aggregate-route" : [ { "address" : "fc00::7", "mask" : 96 } ], "network-route" : [ { "address" : "fc00::7", "mask" : 96 } ], "import-routing" : [ { "protocol" : "static", "thead-id" : 10, "cost" : 10, "route-policy" : "policy1" } ], "evpn" : { "srv6" : { "mode" : "be", "down-switch" : true }, "locator" : [ { "name" : "name" } ] }, "advertise-l2-evpn" : { "advertise-route-to-evpn" : [ { "protocol" : "all", "advertise-route-mode" : "all" } ] }, "locator" : [ { "name" : "name" } ], "locator-routes" : [ { "locator-name" : "name" } ] }, "ipv4-vpn" : { "enable" : true, "policy-vpntarget" : true }, "l2vpn-evpn" : { "enable" : true, "policy-vpn-target" : true, "reflect-change-path" : true }, "link-state-unicast" : { "enable" : "True", "domain-identifier" : "192.168.1.1", "reflector-cluster-id" : 10 }, "ipv6-srpolicy" : { "enable" : "True", "nexthop-select-depend-type" : "default", "router-id-filter" : true }, "bgp-peer" : [ { "peer-ip" : "192.168.1.1", "peer-as" : "1", "local-as-number" : "1", "local-if-name" : "GE0/0/0", "local-if-address" : "192.168.1.1", "ebgp-max-hop" : 10, "auth-type" : "password", "password-type" : "cipher", "password-text" : "Example@123", "key-chain-name" : "aa", "timer" : { "keep-alive-time" : 10, "host-time" : 10, "connect-retry-time" : 10 }, "ipv4-unicast" : { "enable" : true, "allow-as-loop" : 1, "advertise-community" : true, "advertise-ext-community" : true, "nexthop-config" : "local", "prefix-sid" : "default", "reflect-client" : true, "export-route-policy" : "policy1", "import-route-policy" : "policy1", "route-update-interval" : 10 }, "ipv6-unicast" : { "enable" : true, "allow-as-loop" : 1, "advertise-community" : true, "advertise-ext-community" : true, "nexthop-config" : "local", "prefix-sid" : "default", "reflect-client" : true, "export-route-policy" : "policy1", "import-route-policy" : "policy1" }, "ipv4-vpn" : { "enable" : true, "export-route-policy" : "policy1", "import-route-policy" : "policy1" }, "l2vpn-evpn" : { "enable" : true, "reflect-client" : true, "export-route-policy" : "policy1", "import-route-policy" : "policy1" }, "link-state-unicast" : { "enable" : "True", "reflect-client" : true, "export-route-policy" : "policy1" }, "ipv6-srpolicy" : { "enable" : "True", "reflect-client" : true, "advertise-ext-community" : true, "graceful-restart-static-timer" : 3600 }, "bfd" : { "enable" : true, "multiplier" : 3, "min-rx-interval" : 10, "min-tx-interval" : 10 } } ] } ] }

响应示例 返回状态码为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

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bgp:vpn-bgp 是 REFERENCE 详细请参见表4。 VPN BGP配置。 -

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-bgp:vpn-bgp/{vpn-instance} 表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" vpn-instance 是 string 1~31个字符。 - VPN，单一主键字段。 "_public_"

请求示例 HTTP的示例 PUT /controller/campus/v3/sites/batchupdate 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" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "name" : "site1", "description" : "site1", "latitude" : "50", "longtitude" : "111", "longitude" : "111", "contact" : "David", "tag" : ["abcd"], "isolated" : false, "type" : ["AP"], "email" : "xxx@xxx.xxx", "phone" : "152XXXXXXXX", "postcode" : "215000", "address" : "66 JiangYun Road", "siteTag" : "" } ]

响应示例 返回状态码为200：修改站点成功，响应体参考batchUpdateOut。 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" : "", "errmsg" : "", "success" : [ { "siteId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "name" : "site1", "description" : "site1", "latitude" : "50", "longtitude" : "111", "longitude" : "111", "contact" : "David", "tag" : ["abcd"], "isolated" : false, "type" : ["AP"], "email" : "xxx@xxx.xxx", "phone" : "152XXXXXXXX", "postcode" : "215000", "address" : "66 JiangYun Road", "siteTag" : "" } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "siteId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" } ] } 返回状态码为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：获取查询到的设备信息 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF8 { "resultList": [{ "neDn": "e1daadbb-71cd-11e9-82c8-000c291661a5", "neName": "huawei", "startupErrorCode": 0, "runningErrorCode": 0, "backupType": null, "startupFileName": null, "runningFileName": null, "errorCode": 0, "errorMsg": "" }], "error_code": 0, "error_msg": "Successful.", "sessionId": 1589, "briefErrorCode": 0, "briefErrorMsg": null, "status": 0 }

请求示例 cURL的示例 curl -k -s -L -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-yyyyyy' 'https://192.168.1.125:18002/rest/openapi/conffilemgmtservice/v1/conffile/action/backup' -d '[ "e1daadbb-71cd-11e9-82c8-000c291661a5" ]' HTTP的示例 POST /rest/openapi/conffilemgmtservice/v1/conffile/action/backup 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 [ "e1daadbb-71cd-11e9-82c8-000c291661a5" ]

响应参数 返回状态码为200：获取查询到的设备信息 表2 OperateResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 error_code int32 - 0 错误码。 - error_msg string - Successful. 错误消息。 - resultList ARRAY_REFERENCE 详细请参见表3。 设备恢复结果 - sessionId int64 - - 会话id - briefErrorCode int32 - 0 下发操作的结果（0：全部成功，1：全部失败，2：部分成功） - briefErrorMsg string - - 整体操作结果描述 - status int32 - 0 下发操作的进展（0：初始化，1：运行中，2：结束） - 表3 DeviceOperateResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 neDn string 0~100个字符。 - 设备dn - neName string 0~255个字符。 - 设备名称 - errorCode int32 - 0 失败码 - startupErrorCode int32 - 0 启动配置错误码 - runningErrorCode int32 - 0 运行配置错误码 - backupType string 0~255个字符。 - 备份类型 - errorMsg string - - 失败原因 - startupFileName string 0~255个字符。 - 启动配置文件名 - runningFileName string 0~255个字符。 - 运行配置文件名 -

响应参数 返回状态码为200：查询成功，响应体参考QueryPredefinedApplicationsResponse。 表2 QueryPredefinedApplicationsResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-10000个列表项，详细请参见表3。 预定义应用信息。 - 表3 PredefinedApplication对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 applicationId string - - 预定义应用ID（非UUID格式）。 "3495" applicationName string 1~64个字符。满足正则表达^[a-zA-Z0-9_-]+$。 - 预定义应用名称。 "officeApp" predefinedapplicationCategoryId string - - 所属预定义应用类别ID。 "14" predefinedapplicationCategoryName string 1~64个字符。满足正则表达^[a-zA-Z0-9_-]+$。 - 所属预定义应用类别名称。 "AppStore" description string 0~128个字符。 - 预定义应用描述。 "AppStore is published by Apple company." 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，响应体参考QueryPredefinedApplicationsResponse。 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" : [ { "applicationId" : "3495", "applicationName" : "officeApp", "predefinedapplicationCategoryId" : "14", "predefinedapplicationCategoryName" : "AppStore", "description" : "AppStore is published by Apple company." } ] } 返回状态码为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/sdwan/application/predefined-applications?categoryId=41&saType=SA_H30071002&applicationType=FPI 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：查询成功，响应体参考QueryDeviceLocationInfoResponse。 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" : { "id" : "c2b378d8-145f-4e46-8d71-c3709695dd06", "buildingId" : "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2", "buildingName" : "N1", "floorId" : "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2", "floorNumber" : "7", "floorName" : "F2", "positionX" : "32", "positionY" : "32", "planPositionX" : "32", "planPositionY" : "32" } } 返回状态码为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：查询成功，响应体参考QueryDeviceLocationInfoResponse。 表2 QueryDeviceLocationInfoResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "error" data REFERENCE 详细请参见表3。 设备位置信息模型 - 表3 DeviceLocationInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 设备ID，格式UUID。 "c2b378d8-145f-4e46-8d71-c3709695dd06" buildingId string - - 楼栋ID，格式UUID。 "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2" buildingName string - - 楼栋名称。 "N1" floorId string - - 楼层ID，格式UUID。 "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2" floorNumber string - - 楼层号。 "7" floorName string - - 楼层名称。 "F2" positionX int32 - - 设备布放坐标X，单位：像素。 "32" positionY int32 - - 设备布放坐标Y，单位：像素。 "32" planPositionX int32 - - 设备规划坐标X，单位：像素。 "32" planPositionY int32 - - 设备规划坐标Y，单位：像素。 "32" 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务器错误，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/indoormapservice/devices/75ade72a-e7a9-4c81-8fca-894e7ca9c2c2/location-info 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的示例 PUT /controller/campus/v1/sdwan/overlay-network/00000000-0000-0000-0000-000000000000/topology/policy 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 { "customPolicys" : [ { "id" : "00000000-0000-0000-0000-000000000000", "policyName" : "partialMeshPolicy", "priority" : 1, "rules" : [ { "id" : "00000000-0000-0000-0000-000000000000", "matchCondition" : { "ipAddressPrefix" : { "prefixFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ], "ipv6PrefixFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "siteIds" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"], "siteNames" : ["siteName1","siteName2"] }, "applyAction" : { "siteSource" : "tenant", "nextHops" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site Name", "preference" : 2 } ], "applyMode" : "additive", "mode" : "permit" } } ], "applyToSites" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"], "applyToSiteNames" : ["siteName1","siteName2"] } ] }

响应示例 返回状态码为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 { "errcode" : "0", "errmsg" : "", "customPolicys" : [ { "id" : "00000000-0000-0000-0000-000000000000", "policyName" : "partialMeshPolicy", "priority" : 1, "rules" : [ { "id" : "00000000-0000-0000-0000-000000000000", "matchCondition" : { "ipAddressPrefix" : { "prefixFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ], "ipv6PrefixFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "siteIds" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"], "siteNames" : ["siteName1","siteName2"] }, "applyAction" : { "siteSource" : "tenant", "nextHops" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site Name", "preference" : 2 } ], "applyMode" : "additive", "mode" : "permit" } } ], "applyToSites" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"], "applyToSiteNames" : ["siteName1","siteName2"] } ] } 返回状态码为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：查询成功，响应体参考QueryDomainResponse。 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" : [ { "domainId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "domainName" : "name", "domainSates" : { "state" : true }, "authenticationSchemaId" : "00000000-0000-0000-0000-000000000000", "enableAuthorizationSchema" : true, "authorizationSchemaId" : "00000000-0000-0000-0000-000000000000", "enableTacasServerTemplate" : true, "tacasServerTemplateId" : "00000000-0000-0000-0000-000000000000", "radiusServerTemplateName" : "radius1" } ], "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 100 } 返回状态码为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/sdwan/aaa/domain?pageIndex=1&pageSize=10&siteId=00000000-0000-0000-0000-000000000000&deviceId=00000000-0000-0000-0000-000000000000&domainName=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

URI /controller/campus/v1/sdwan/aaa/domain 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 - - 起始页，默认值1 1 pageSize 否 int32 [1-1000] - 页行记录数，默认值10 10 siteId 否 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" domainName 否 string - - 域名 模糊查询。 "name"

响应参数 返回状态码为200：查询成功，响应体参考QueryDomainResponse。 表2 QueryDomainResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data ARRAY_REFERENCE 0-1000个列表项，详细请参见表5。 域信息列表 - pageIndex int32 - - 当前页。 1 pageSize int32 [1-10000] - 页大小。 10 totalRecords int32 [1-100000] - 总记录数。 100 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

响应示例 返回状态码为204：删除成功。 HTTP/1.1 204 No Content 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 { "id" : "3814d9aa-8d46-42ee-9194-dc17d0c21888", "account" : "support_e@huawei.com" } 返回状态码为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的示例 DELETE /v1/runbook/external-systems/3814d9aa-8d46-42ee-9194-dc17d0c21888 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

响应示例 返回状态码为201：创建成功，返回体参考ConfigPortResponse。 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" : "0", "errmsg" : "", "data" : [ { "portId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "portName" : "GE0/0/1" } ] } 返回状态码为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/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", "portId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "portName" : "GE0/0/1" } ] }