华为云用户手册

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/overlay-network/topology/progress HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AC CES S-TOKEN: x-yyyyyy

响应示例 返回状态码为200：修改成功，响应体参考SessionWhitelistResponse。 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" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policy1", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "ruleCount" : 1, "sessionWhitelistType" : "spr,firewall", "aclRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocolNum" : 1, "sourceIP" : "192.168.0.0/16", "destinationIP" : "192.168.0.0/16", "sourcePortStart" : 1, "sourcePortEnd" : 1, "destinationPortStart" : 1, "destinationPortEnd" : 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/sdwan/policy/traffic/session-whitelist/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 { "policyId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policy1", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "ruleCount" : 1, "sessionWhitelistType" : "spr,firewall", "aclRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocolNum" : 1, "sourceIP" : "192.168.0.0/16", "destinationIP" : "192.168.0.0/16", "sourcePortStart" : 1, "sourcePortEnd" : 1, "destinationPortStart" : 1, "destinationPortEnd" : 1 } ] }

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/security/security-policies 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 { "effectImmediate" : true, "securityPolicyInfo" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "test_1", "status" : 1, "isActive" : true, "internetToUserRules" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "endSourcePort" : 6, "targetPort" : 6, "endTargetPort" : 6, "ipsProfile" : "strict", "avProfile" : "default", "urlProfile" : "default", "sourceIpAddressSets" : [ "sourceIpAddressSet" ], "targetIpAddressSets" : [ "targetIpAddressSet" ], "sourceGeoLocationSets" : [ { "key" : "", "name" : "" } ], "targetGeoLocationSets" : [ { "key" : "", "name" : "" } ], "sourceDomainSets" : [ "sourceDomainSet" ], "targetDomainSets" : [ "targetDomainSet" ], "sourceFeeds" : "ipFeed01", "ipFeed02" , "targetFeeds" : "ipFeed01", "ipFeed02" , "appGroups" : [ "appGroup" ], "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "fileProfile" : "fileProfile01" } ], "userToInternetRules" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "endSourcePort" : 6, "targetPort" : 6, "endTargetPort" : 6, "ipsProfile" : "strict", "avProfile" : "default", "urlProfile" : "default", "sourceIpAddressSets" : [ "sourceIpAddressSet" ], "targetIpAddressSets" : [ "targetIpAddressSet" ], "sourceGeoLocationSets" : [ { "key" : "", "name" : "" } ], "targetGeoLocationSets" : [ { "key" : "", "name" : "" } ], "sourceDomainSets" : [ "sourceDomainSet" ], "targetDomainSets" : [ "targetDomainSet" ], "sourceFeeds" : "ipFeed01", "ipFeed02" , "targetFeeds" : "ipFeed01", "ipFeed02" , "appGroups" : [ "appGroup" ], "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "fileProfile" : "fileProfile01" } ], "policyType" : false, "securityZone" : { "securityInterZones" : [ [ "test_1" ] ] }, "enableSecurityZones" : true, "securityZones" : { "sourceZones" : [ "test_1" ], "destZones" : [ "test_2" ] } } ] }

响应示例 返回状态码为201：创建成功，响应体参考SecurityPolicyResponse。 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" : "", "success" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "test_1", "status" : 1, "isActive" : true, "internetToUserRules" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "endSourcePort" : 6, "targetPort" : 6, "endTargetPort" : 6, "ipsProfile" : "strict", "avProfile" : "default", "urlProfile" : "default", "sourceIpAddressSets" : [ "sourceIpAddressSet" ], "targetIpAddressSets" : [ "targetIpAddressSet" ], "sourceGeoLocationSets" : [ { "key" : "", "name" : "" } ], "targetGeoLocationSets" : [ { "key" : "", "name" : "" } ], "sourceDomainSets" : [ "sourceDomainSet" ], "targetDomainSets" : [ "targetDomainSet" ], "sourceFeeds" : "ipFeed01", "ipFeed02" , "targetFeeds" : "ipFeed01", "ipFeed02" , "appGroups" : [ "appGroup" ], "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "fileProfile" : "fileProfile01" } ], "userToInternetRules" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "endSourcePort" : 6, "targetPort" : 6, "endTargetPort" : 6, "ipsProfile" : "strict", "avProfile" : "default", "urlProfile" : "default", "sourceIpAddressSets" : [ "sourceIpAddressSet" ], "targetIpAddressSets" : [ "targetIpAddressSet" ], "sourceGeoLocationSets" : [ { "key" : "", "name" : "" } ], "targetGeoLocationSets" : [ { "key" : "", "name" : "" } ], "sourceDomainSets" : [ "sourceDomainSet" ], "targetDomainSets" : [ "targetDomainSet" ], "sourceFeeds" : "ipFeed01", "ipFeed02" , "targetFeeds" : "ipFeed01", "ipFeed02" , "appGroups" : [ "appGroup" ], "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "fileProfile" : "fileProfile01" } ], "policyType" : false, "securityZone" : { "securityInterZones" : [ [ "test_1" ] ] }, "enableSecurityZones" : true, "securityZones" : { "sourceZones" : [ "test_1" ], "destZones" : [ "test_2" ] } } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "test_1", "status" : 1, "isActive" : true, "internetToUserRules" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "endSourcePort" : 6, "targetPort" : 6, "endTargetPort" : 6, "ipsProfile" : "strict", "avProfile" : "default", "urlProfile" : "default", "sourceIpAddressSets" : [ "sourceIpAddressSet" ], "targetIpAddressSets" : [ "targetIpAddressSet" ], "sourceGeoLocationSets" : [ { "key" : "", "name" : "" } ], "targetGeoLocationSets" : [ { "key" : "", "name" : "" } ], "sourceDomainSets" : [ "sourceDomainSet" ], "targetDomainSets" : [ "targetDomainSet" ], "sourceFeeds" : "ipFeed01", "ipFeed02" , "targetFeeds" : "ipFeed01", "ipFeed02" , "appGroups" : [ "appGroup" ], "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "fileProfile" : "fileProfile01" } ], "userToInternetRules" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "endSourcePort" : 6, "targetPort" : 6, "endTargetPort" : 6, "ipsProfile" : "strict", "avProfile" : "default", "urlProfile" : "default", "sourceIpAddressSets" : [ "sourceIpAddressSet" ], "targetIpAddressSets" : [ "targetIpAddressSet" ], "sourceGeoLocationSets" : [ { "key" : "", "name" : "" } ], "targetGeoLocationSets" : [ { "key" : "", "name" : "" } ], "sourceDomainSets" : [ "sourceDomainSet" ], "targetDomainSets" : [ "targetDomainSet" ], "sourceFeeds" : "ipFeed01", "ipFeed02" , "targetFeeds" : "ipFeed01", "ipFeed02" , "appGroups" : [ "appGroup" ], "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "fileProfile" : "fileProfile01" } ], "policyType" : false, "securityZone" : { "securityInterZones" : [ [ "test_1" ] ] }, "enableSecurityZones" : true, "securityZones" : { "sourceZones" : [ "test_1" ], "destZones" : [ "test_2" ] } } } ] } 返回状态码为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

响应示例 返回状态码为201：创建成功，响应体参考RedirectPolicyResponse。 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" : "", "success" : { "vpnId" : "00000000-0000-0000-0000-000000000000", "fullReplace" : true, "redirectPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "设备1", "policyName" : "redirect1", "devicePolicyName" : "pbr_devciePolicyName_1", "portType" : "EvpnTunnel", "portId" : "00000000-0000-0000-0000-000000000000", "portName" : "redirect1", "direction" : "inbound", "description" : "描述", "redirectRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "流分类模板1", "behaviorId" : "00000000-0000-0000-0000-000000000000", "behaviorName" : "Behavior", "behaviorAction" : "permit" } ] } ] }, "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "vpnId" : "00000000-0000-0000-0000-000000000000", "fullReplace" : true, "redirectPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "设备1", "policyName" : "redirect1", "devicePolicyName" : "pbr_devciePolicyName_1", "portType" : "EvpnTunnel", "portId" : "00000000-0000-0000-0000-000000000000", "portName" : "redirect1", "direction" : "inbound", "description" : "描述", "redirectRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "流分类模板1", "behaviorId" : "00000000-0000-0000-0000-000000000000", "behaviorName" : "Behavior", "behaviorAction" : "permit" } ] } ] } } ] } 返回状态码为400：请求参数错误，无响应体。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误，无响应体。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/redirect-policy/sites/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 { "vpnId" : "00000000-0000-0000-0000-000000000000", "fullReplace" : true, "redirectPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "设备1", "policyName" : "redirect1", "devicePolicyName" : "pbr_devciePolicyName_1", "portType" : "EvpnTunnel", "portId" : "00000000-0000-0000-0000-000000000000", "portName" : "redirect1", "direction" : "inbound", "description" : "描述", "redirectRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "流分类模板1", "behaviorId" : "00000000-0000-0000-0000-000000000000", "behaviorName" : "Behavior", "behaviorAction" : "permit" } ] } ] }

响应参数 返回状态码为201：创建成功，响应体参考RedirectPolicyResponse。 表6 RedirectPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success REFERENCE 详细请参见表7。 成功的重定向策略信息列表 - fail ARRAY_REFERENCE 0-100个列表项，详细请参见表10。 失败的重定向策略信息列表。 - 表7 RedirectPolicyInfos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 vpnId uuid - - VPN ID，必填。 "00000000-0000-0000-0000-000000000000" fullReplace boolean true false false 仅更新操作有效，false增量更新redirectRules，true全量更新redirectRules，默认值false。 true redirectPolicies ARRAY_REFERENCE 1-100个列表项，详细请参见表8。 重定向策略列表 - 表8 RedirectPolicyInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - 策略ID，修改或删除的时候必填。 "00000000-0000-0000-0000-000000000000" deviceId uuid - - 设备ID，创建的时候必填。 "00000000-0000-0000-0000-000000000000" deviceName string 0~64个字符。 - 设备名称，无需填写，仅查询时使用。 "设备1" policyName string 0~64个字符。 - 策略名称，创建的时候必填。 "redirect1" devicePolicyName string 0~15个字符。 - 设备上的策略名称。 创建时如不填写，将自动生成以“redirect_”开头的名称； 如填写，区分大小写，不能包含空格、?、-、"及“redirect_”开头的名称； 不允许修改。 "pbr_devciePolicyName_1" portType string EvpnTunnel InterworkingTunnel LanInterface InterCPELink - 接口类型，创建时必填。 "EvpnTunnel" portId uuid - - LAN侧接口ID，仅当portType为LanInterface时有效，创建时必填。 "00000000-0000-0000-0000-000000000000" portName string 0~128个字符。 - LAN侧接口名称，无需填写，仅查询时使用。 "redirect1" direction string 7~8个字符。 - 策略方向，取值范围：inbound、outbound。非必填，创建时不填表示inbound，修改时不填表示保持修改前的值不变。 "inbound" description string 0~64个字符。 - 描述 "描述" redirectRules ARRAY_REFERENCE 0-100个列表项，详细请参见表9。 Redirect规则，创建的时候必填。 - 表9 RedirectRule对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ruleId uuid - - RedirectRule ID。修改时，若ruleId为空，表示向重定向策略添加一条Rule；若ruleId不为空，表示修改对应的Rule。 "00000000-0000-0000-0000-000000000000" priority int32 [1-5000] - 优先级，范围1到5000，1高，5000低，建议步长10，创建的时候必填。 1 classificationId uuid - - 流分类模板ID，创建的时候必填。 "00000000-0000-0000-0000-000000000000" classificationName string 0~64个字符。 - 流分类模板名称，无需填写，仅查询时使用。 "流分类模板1" behaviorId uuid - - 重定向策略行为模板ID。 与behaviorAction不能同时配置，且创建时必须配置其中一个。 "00000000-0000-0000-0000-000000000000" behaviorName string 0~64个字符。 - 重定向策略行为模板名称，无需填写，仅查询时使用。 "Behavior" behaviorAction string 4~6个字符。 - 重定向策略行为动作，取值范围：permit(允许)、deny(拒绝)，区分大小写。 与behaviorId不能同时配置，且创建时必须配置其中一个。 "permit" 表10 FailRedirectPolicyInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0x00c8000c" errmsg string - - 错误信息。 "The parameter is invalid." data REFERENCE 详细请参见表7。 重定向策略信息 - 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 redirectPolicyInfos 是 REFERENCE 详细请参见表3。 创建重定向策略请求数据。 - 表3 RedirectPolicyInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 uuid - - VPN ID，必填。 "00000000-0000-0000-0000-000000000000" fullReplace 否 boolean true false false 仅更新操作有效，false增量更新redirectRules，true全量更新redirectRules，默认值false。 true redirectPolicies 否 ARRAY_REFERENCE 1-100个列表项，详细请参见表4。 重定向策略列表 - 表4 RedirectPolicyInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - 策略ID，修改或删除的时候必填。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备ID，创建的时候必填。 "00000000-0000-0000-0000-000000000000" deviceName 否 string 0~64个字符。 - 设备名称，无需填写，仅查询时使用。 "设备1" policyName 否 string 0~64个字符。 - 策略名称，创建的时候必填。 "redirect1" devicePolicyName 否 string 0~15个字符。 - 设备上的策略名称。 创建时如不填写，将自动生成以“redirect_”开头的名称； 如填写，区分大小写，不能包含空格、?、-、"及“redirect_”开头的名称； 不允许修改。 "pbr_devciePolicyName_1" portType 否 string EvpnTunnel InterworkingTunnel LanInterface InterCPELink - 接口类型，创建时必填。 "EvpnTunnel" portId 否 uuid - - LAN侧接口ID，仅当portType为LanInterface时有效，创建时必填。 "00000000-0000-0000-0000-000000000000" portName 否 string 0~128个字符。 - LAN侧接口名称，无需填写，仅查询时使用。 "redirect1" direction 否 string 7~8个字符。 - 策略方向，取值范围：inbound、outbound。非必填，创建时不填表示inbound，修改时不填表示保持修改前的值不变。 "inbound" description 否 string 0~64个字符。 - 描述 "描述" redirectRules 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 Redirect规则，创建的时候必填。 - 表5 RedirectRule对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ruleId 否 uuid - - RedirectRule ID。修改时，若ruleId为空，表示向重定向策略添加一条Rule；若ruleId不为空，表示修改对应的Rule。 "00000000-0000-0000-0000-000000000000" priority 否 int32 [1-5000] - 优先级，范围1到5000，1高，5000低，建议步长10，创建的时候必填。 1 classificationId 否 uuid - - 流分类模板ID，创建的时候必填。 "00000000-0000-0000-0000-000000000000" classificationName 否 string 0~64个字符。 - 流分类模板名称，无需填写，仅查询时使用。 "流分类模板1" behaviorId 否 uuid - - 重定向策略行为模板ID。 与behaviorAction不能同时配置，且创建时必须配置其中一个。 "00000000-0000-0000-0000-000000000000" behaviorName 否 string 0~64个字符。 - 重定向策略行为模板名称，无需填写，仅查询时使用。 "Behavior" behaviorAction 否 string 4~6个字符。 - 重定向策略行为动作，取值范围：permit(允许)、deny(拒绝)，区分大小写。 与behaviorId不能同时配置，且创建时必须配置其中一个。 "permit"

响应示例 返回状态码为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" : "inner error", "totalRecords" : "9999", "pageIndex" : "1", "pageSize" : "30", "data" : [ { "zoneId" : "00000000-0000-0000-0000-00000000000f", "name" : "dmzzz", "priority" : "88", "description" : "finance dmz", "predefined" : true } ] } 返回状态码为400：校验失败。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部服务错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 GET /controller/campus/v1/networkconfig/profile/securityzones?name=zonea&pageIndex=1&pageSize=30 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 PageQueryZoneResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "inner error" totalRecords integer - - 满足条件的记录总数。 "9999" pageIndex integer - - 页码 "1" pageSize integer - - 每页数量 "30" data ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 安全域列表 - 返回状态码为400：校验失败。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务错误。 详细信息请参见实际响应消息体。

URI /controller/campus/v1/networkconfig/profile/securityzones 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 0~64个字符。 - 安全 域名 称，不支持模糊查询。 "zonea" pageIndex 是 integer - - 当前页码。 "1" pageSize 是 integer [1-100] - 每页数量。 "30"

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-nvo3:nvo3/{source-nve} 表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" source-nve 是 string 1~63个字符。 - 源端接口，仅支持NVE口，单一主键字段。 "Nve1"

请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nvo3:nvo3/Nve1 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy restconf-transaction-id: "00000000-0000-0000-0000-000000000000"

响应示例 返回状态码为200：操作成功。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应示例 返回状态码为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" : "", "success" : [ { "name" : "vpn_1", "description" : "Default", "vpnNameInDevice" : "vpn_1", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteRouteDistinguishers" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "routeDistinguisher" : "101:3" } ], "overlayHeadLength" : 36, "siteIds" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"], "ipsecEncryption" : true, "enableIPv6" : true, "defaultVpn" : true, "vpnIndex" : 0, "deleteStatus" : true } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "name" : "vpn_1", "description" : "Default", "vpnNameInDevice" : "vpn_1", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteRouteDistinguishers" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "routeDistinguisher" : "101:3" } ], "overlayHeadLength" : 36, "siteIds" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"], "ipsecEncryption" : true, "enableIPv6" : true, "defaultVpn" : true, "vpnIndex" : 0, "deleteStatus" : true } } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/overlay-network/vpn/site-detachment 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 { "vpns" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteIds" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"], "siteRouteDistinguishers" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "routeDistinguisher" : "101:3" } ] } ] }

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

响应示例 返回状态码为200：删除成功，响应体参考CommonResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errCode" : "0", "errMsg" : "" } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部异常。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 DELETE /controller/campus/v1/sdwan/netstream/00000000-0000-0000-0000-000000000000/interface HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy

响应示例 返回状态码为200：绑定成功，响应体参考ScanRuleBindInfoGetOutputDto。 HTTPS 200 OK Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode": "0", "errmsg": "", "pageIndex": 1, "pageSize": 10, "totalSize": 1, "deviceList": [ { "scanRuleId": "8f356904-45c8-6409-bc0f-fc6d98e7c74a", "deviceId": "6a7b14c1-6b6f-3726-b6c5-a14a77c51ca2", "deviceName": "dev01", "deviceEsn": "1019A0055991", "deviceRole": "ACC", "siteName": "site1", "siteId": "968d34cc-6cd2-719a-73dd-857bd328d141", "scanUpdateTime": "2023-01-16 14:35:55", "scanResult": 0, "scanFailureCause": "" } ] } 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 HTTPS 400 ERROR Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0x00c80014", "errmsg":"data not exist", "errdesc": "", "errreason": "", "errdetail": "", "erradvice": "" } 返回状态码为500：内部错误，响应体参考CommonErrorDto。 HTTPS 500 ERROR Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0x00c80018", "errmsg":"internal error", "errdesc": "", "errreason": "", "errdetail": "", "erradvice": "" }

请求示例 HTTP的示例 get /controller/campus/api/v1/terminal/scanrule/getBindInfo?scanRuleId=5843d82def3e44e4aab60cd4e180117e&filter=sortField::+name|keyword::rule&page=pageIndex::1|pageSize::10 HTTPS Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925

URI /controller/campus/api/campusaccesscfgservice/v1/terminal/scanrule/query-bound-devices 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 scanRuleId 是 string 0~32个字符。 - 扫描规则ID。 "5843d82def3e44e4aab60cd4e180117e" filter 否 string 0~200个字符。 - 查询条件。 "sortField::+name|keyword::rule" page 否 string 0~32个字符。 - 分页。 "pageIndex::1|pageSize::10"

响应参数 返回状态码为200：绑定成功，响应体参考ScanRuleBindInfoGetOutputDto。 表2 ScanRuleBindInfoGetOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" pageIndex int32 [1-100] - 当前页码。 1 pageSize int32 [5-100] - 分页大小。 10 totalSize int32 [0-100] - 当前扫描规则绑定设备总数目。 100 deviceList ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 绑定设备列表 - 表3 GetBindDeviceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 scanRuleId string 0~36个字符。 - 扫描规则ID "11111111-1111-1111-1111-111111111112" deviceId string 0~36个字符。 - 设备ID "11111111-1111-1111-1111-111111111113" deviceName string 0~64个字符。 - 设备名称 "device1" deviceEsn string 0~64个字符。 - 设备ESN "0002353AJS0000000000" deviceRole string 0~36个字符。 - 设备角色 "接入" siteName string 0~64个字符。 - 站点名称 "site1" siteId string 0~36个字符。 - 站点ID "11111111-1111-1111-1111-111111111110" scanUpdateTime string 0~32个字符。 - 终端扫描更新时间。 "2023-01-16 14:35:55" scanType int32 [0-1] 0 扫描类型，0表示普通扫描，1表示深度扫描 0 scanResult int32 [0-10] - 立即扫描结果，0表示成功，1表示失败。 0 scanFailureCause string 0~256个字符。 - 立即扫描失败原因。 "device offline" 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。 返回状态码为500：内部错误，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。

响应示例 返回状态码为200：通知成功，响应体参考NotifyMdmInfoOutputDto。 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" : [ "xx-xx-xx-xx-xx-xx" ], "failure" : [ { "errcode" : "101", "errmsg" : "Fail to find the mdm info that need updated", "data" : "xx-xx-xx-xx-xx-xx" } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /controller/campus/v1/accountservice/securityapi/notifycompliancestatues/00000000-0000-0000-0000-000000000001 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 { "deviceinfos" : [ { "mac" : "xx-xx-xx-xx-xx-xx", "ip" : "192.168.1.2", "tid" : "6c3540374a6837b20212efe25ac75123", "mdmAttributeValue" : "92", "complianceStatus" : "NOT_COMPLY", "timeStamp" : "1508923416" } ] }

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 NotifyMdmInfoInputDto 是 REFERENCE 详细请参见表3。 通知mdm信息入参 - 表3 NotifyMdmInfoInputDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceinfos 否 ARRAY_REFERENCE 1-1000个列表项，详细请参见表4。 待更新的mdm终端信息集合。 - 表4 UpdateMdmInfoDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mac 是 string 17个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 绑定设备的MAC，MAC的格式支持xx-xx-xx-xx-xx-xx。 "xx-xx-xx-xx-xx-xx" ip 否 string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 终端ip地址，ipv4。 "192.168.1.2" tid 否 string 0~36个字符。 - 第三方系统中终端设备的唯一标识, 可为空。 "6c3540374a6837b20212efe25ac75123" mdmAttributeValue 否 string 0~64个字符。 - mdm属性值 "92" complianceStatus 是 string NOT_COMPLY COMPLIANT NA - 合规状态, 判断终端是否违规，1）NOT_COMPLY：不合规，2）COMPLIANT：合规， 3）NA： 不涉及（设备不存在、还未注册等情况） "NOT_COMPLY" timeStamp 否 string 10~13个字符。 - 当前时间戳 "1508923416"

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

请求示例 HTTP的示例 DELETE /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"