华为云用户手册

  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/performance/spr-statistics/export-spr 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 { "siteId" : "00000000-0000-0000-0000-000000000000", "startTime" : 1616824800000, "endTime" : 1616828400000 }
  • 响应示例 返回状态码为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
  • 请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-syslog:syslog-config/global-parameter 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-syslog:global-parameter" : { "interface-name" : "1", "buffer-size" : 1, "log-timestamp" : "date-boot", "log-timezone" : true, "debug-timestamp" : "date-boot", "debug-timezone" : true, "trap-timestamp" : "date-boot", "trap-timezone" : true, "statistic-suppress" : true } }
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 global-parameter 是 REFERENCE 详细请参见表4。 全局配置 - 表4 global-parameter-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-syslog:global-parameter 否 REFERENCE 详细请参见表6。 全局配置 -
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-syslog:syslog-config/global-parameter 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000"
  • 请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nqa:nqa/TestName 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-nqa:nqa" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "test-name" : "TestName", "type" : "ipv4", "ipv4-dest-address" : "192.168.1.1", "ipv4-next-hop" : "192.168.1.2", "ipv6-dest-address" : "FC00::1101", "ipv6-next-hop" : "FC00::1102", "out-if-name" : "GE0/0/1", "vpn-instance" : "_public_", "probe-count" : 5, "interval" : 4, "timeout" : 3, "frequency" : 22, "data-size" : 0, "ttl" : 30, "tos" : 0, "send-trap-bits" : "resultchange", "execution-switch" : true } ] } 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 POST /controller/campus/v3/devices/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 { "deviceIds" : ["00000000-0000-0000-0000-000000000001"], "reset" : "true" }
  • 响应示例 返回状态码为200:删除设备全部成功,响应体参考BatchDeleteDeviceOut。 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" : "Failed to delete the device", "success" : ["00000000-0000-0000-0000-000000000001"], "fail" : [ { "errCode" : "0", "errMsg" : "Failed to operate the device because it is in stack", "id" : "00000000-0000-0000-0000-000000000001" } ] } 返回状态码为207:删除设备部分成功,响应体参考BatchDeleteDeviceOut。 HTTP/1.1 207 Multi-Status 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" : "Failed to delete the device", "success" : ["00000000-0000-0000-0000-000000000001"], "fail" : [ { "errCode" : "0", "errMsg" : "Failed to operate the device because it is in stack", "id" : "00000000-0000-0000-0000-000000000001" } ] } 返回状态码为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 { "errCode" : "0", "errMsg" : "Failed to delete the device", "success" : ["00000000-0000-0000-0000-000000000001"], "fail" : [ { "errCode" : "0", "errMsg" : "Failed to operate the device because it is in stack", "id" : "00000000-0000-0000-0000-000000000001" } ] } 返回状态码为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 /controller/campus/v3/networkconfig/site-templates/{siteTemplateId}/apssid/{id} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string 36个字符。 - 站点模板标识,UUID格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c" id 是 string - - SSID标识,创建或查询Response中的ID字段。 "de5813f8ff1e41f5ba9c324da70b49ed"
  • 请求示例 HTTP的示例 PUT /controller/campus/v3/networkconfig/site-templates/fbde1c5d-5b94-49e3-a912-48641015e45c/apssid/de5813f8ff1e41f5ba9c324da70b49ed 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" : "Huawei-Guest", "pki" : "default", "tags" : [ { "name" : "testApTag" } ], "enable" : true, "timeTemplateId" : "2c3918cb-f0bd-44e3-963b-119870bfc779", "connectionMode" : "nat", "vlans" : [ { "vlanId" : 10, "vlanDesc" : "work" } ], "customVlans" : [ { "priority" : 0, "vlanId" : 10, "vlanDesc" : "work", "tags" : [ { "name" : "testApTag" } ] } ], "vlanMode" : "vlanId", "vlanPoolId" : "1e930b21-a307-45a9-96a2-f1443ca84f39", "vlanPoolName" : "vlanPool", "hidedEnable" : false, "autoOffTrackLinkEnable" : false, "arpCheckEnable" : true, "ipCheckEnable" : true, "dhcpStrictEnable" : false, "dhcpv6SlaacStrictEnable" : 0, "mdnsSnoopingEnable" : false, "dnsSnoopingEnable" : false, "gameSpeedUpEnable" : false, "relativeRadios" : 3, "relativeOnlyTwoRadios" : 3, "dtimInterval" : 1, "advertiseApNameSwitch" : true, "frequencyNavigation" : true, "maxUserNumber" : 64, "blackAndWhite" : { "bindingType" : 2, "terminalMacList" : [ "XX:XX:XX:XX:XX:XX" ], "terminalOUIList" : [ "02:02:01" ] }, "userSeparation" : false, "separationOption" : "disable", "userL2LanIsolate" : false, "staNetworkDetect" : true, "muMiMo" : true, "associationTimeout" : 5, "erSuSwitch" : true, "userFlowSyslogEnable" : false, "multiLinkOper" : false, "lay3RoamSwitch" : true, "suExtendedRangeSwitch" : false, "muRtsSwitch" : false, "muRtsThreshold" : 2347, "forbiddenOldTerminal" : false, "reachMaxSta" : 1, "igmpSnooping" : false, "multicast2Unicast" : "disable", "bcmcDenyAll" : false, "bonjourTransparent" : false, "powerSave" : false, "beacon2gRate" : "1Mbps", "beacon5gRate" : "6Mbps", "beacon6gRate" : "6Mbps", "sipPort" : 5060, "timeTemplateName" : "全天", "seaSwitch" : false, "overDsPrivate" : "disable", "ssidAuth" : { "mode" : "ppsk", "oweTransitionMode" : true, "transitionOpenSsid" : "de5813f8ff1e41f5ba9c324da70b49ed", "pskEncryptType" : "wpa2", "wepType" : "WEP40", "wepDefaultKey" : 0, "enableMacAuth" : false, "securityKey" : "", "saeEncryptType" : "", "saeSecurityKey" : "", "pskSaeEncryptType" : "", "pskSaeSecurityKey" : "", "securityKeyType" : "AES", "dot1xEncryptType" : "", "dot1xQuietPeriod" : 60, "dot1xQuietTimes" : 10, "macAutoBinding" : true, "macAuthMethod" : "", "escapeStrategy" : "noAuth", "escapeProfileName" : "escapeStrategy1", "escapeProfileId" : "5871926c-2a5e-4340-a931-19ce019a231c", "portal" : { "mode" : "portalThirdIndirect", "pushProtocol" : "https", "freeAuthEnable" : true, "authExpireUnit" : "day", "authExpire" : 10, "escapeStrategy" : 2, "escapeProfileName" : "escapeStrategy1", "escapeProfileId" : "5871926c-2a5e-4340-a931-19ce019a231c", "freeAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "freeAclTmplName" : "free-acl-name", "controllerPortalType" : "haca", "masterPortalTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "masterPortalTmplName" : "", "bakPortalEnable" : false, "bakPortalTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "bakPortalTmplName" : "", "authRedirectUrlCarryEnable" : false, "radiusEnable" : false, "radiusTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "radiusTmplName" : "", "fastPushEnable" : true, "portalPageId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "wechatUrlAuthEnable" : false, "weComAuthEnable" : false, "dingTalkEnable" : false, "normalEnable" : false, "registerEnable" : false, "registerExpire" : 2, "registerExpireUnit" : "hour", "userRegisterMaxAccessNumber" : 0, "userGroupId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "smsAuthEnable" : false, "smsPasswordExpire" : 5, "smsPasswordExpireUnit" : "minute", "smsUserRegisterEnable" : false, "smsUserExpire" : 2, "smsUserExpireUnit" : "hour", "smsUserMaxAccessNumber" : 0, "smsUserGroupId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "emailAuthEnable" : false, "passCodeEnable" : false, "oneKeyAuthEnable" : false, "anonymousEnable" : false, "socialMediaEnable" : false, "twitterEnable" : false, "sinaEnable" : false, "qqEnable" : false, "qrCodeAuthEnable" : false, "qrCodeRegisterEnable" : false, "googleEnable" : false, "accountingEnable" : false, "accountingExpire" : 15, "interconnectionMode" : "API", "userNameKey" : "用户", "passwordKey" : "", "urlMatchMode" : 0, "successUrlKey" : "", "authFailedUrlKey" : "", "logoutSuccessUrlKey" : "", "logoutFailedUrlKey" : "", "logoutUrlKey" : "", "radiusModelId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc" }, "radius" : { "radiusTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "radiusTmplName" : "test", "staticEnable" : false, "iconnectAccessEnable" : "", "autoReauthenTime" : "", "hacaEnable" : false }, "haca" : { "authComponentId" : "00000000-0000-0000-0000-000000000000", "authComponentIp" : "10.20.0.0", "bakAuthComponentId" : "00000000-0000-0000-0000-000000000000", "bakAuthComponentIp" : "10.20.0.0" } }, "vapBackupConfig" : { "vapBackupEnable" : false, "radiusBackupTmplId" : "cf23f275-01e6-4301-890e-407e1d78c53e", "rejectNewAccess" : false }, "ssidPolicy" : { "securityPolicy" : { "highReliableSliceAclTplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "highReliableSliceAclTplName" : "test-slice-acl", "highReliableSliceAclTplIdIpv6" : "b90f8190-e12f-4323-95f3-4018309209c4", "highReliableSliceAclTplNameIpv6" : "test-slice-acl", "securityAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "securityAclTmplName" : "test-security-acl", "securityIPv6AclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "securityIPv6AclTmplName" : "test-security-acl", "ipsecAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c5", "ipsecAclTmplName" : "test-ipsec-acl", "tcpAdjustMss" : 1380, "appTrafficAcls" : { "appTrafficAclList" : [ { "direction" : "inbound", "index" : 0, "dscp" : 1, "appTrafficAclTplId" : "b90f8190-e12f-4323-95f3-4018309209c5", "appTrafficAclName" : "test-tunnel-acl" } ] }, "tunnelAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c5", "tunnelAclTmplName" : "test-tunnel-acl", "urlFilter" : { "enable" : true, "mode" : 1, "urls" : [ "" ], "hostNames" : [ "" ] }, "appsPolicys" : { "siteSaList" : [ { "appId" : 1, "type" : "app", "appType" : 1, "appName" : "test_name", "action" : "permit", "dscp" : 1, "car" : 1000 } ] } }, "ssidRateLimit" : { "upEnable" : true, "upLimit" : "50.0", "downEnable" : true, "downLimit" : "50.0" }, "terminalRateLimit" : { "upEnable" : true, "upLimit" : "50.0", "downEnable" : true, "downLimit" : "50.0", "timeRange" : [ { "timeTemplateId" : "b90f8190-e12f-4323-95f3-4018309209c4", "upEnable" : true, "upLimit" : "50.0", "downEnable" : true, "downLimit" : "50.0" } ] }, "terminalDynamicRateLimit" : { "dynamicEnable" : false, "dynamicLimit" : 16 }, "ipv6Enable" : false, "ndTrustPort" : false }, "dot11r" : false, "overDs" : false, "reassociateTimeout" : 1, "serviceGuarantee" : "performanceFirst", "activeDullClient" : false, "wmmScene" : "default", "edcaClientConfigList" : [ { "accessCategory" : "acvo", "aifsn" : 10, "ecwmax" : 10, "ecwmin" : 10, "txoplimit" : 10 } ], "insertOption82Enable" : false, "option82" : { "circuitId" : { "connectorPattern" : "colon", "contentType" : "ap-mac", "format" : "ascii", "userDefinedText" : "xxx" }, "remoteId" : { "connectorPattern" : "colon", "contentType" : "ap-mac", "format" : "ascii", "userDefinedText" : "xxx" } }, "forwardMode" : "direct", "softgreProfileId" : "fbde1c5d-5b94-49e3-a912-48641015e45f", "configName" : "ssid-tmp-config-name", "phyProtection" : "security-priority" }
  • 响应示例 返回状态码为200:修改的站点模板内SSID配置信息,返回结构体参见SiteTemplateConfigSsidResponse。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "id" : "de5813f8ff1e41f5ba9c324da70b49ed", "name" : "Huawei-Guest", "pki" : "default", "tags" : [ { "name" : "testApTag" } ], "enable" : true, "timeTemplateId" : "2c3918cb-f0bd-44e3-963b-119870bfc779", "connectionMode" : "nat", "vlans" : [ { "vlanId" : 10, "vlanDesc" : "work" } ], "customVlans" : [ { "priority" : 0, "vlanId" : 10, "vlanDesc" : "work", "tags" : [ { "name" : "testApTag" } ] } ], "vlanMode" : "vlanId", "vlanPoolId" : "1e930b21-a307-45a9-96a2-f1443ca84f39", "vlanPoolName" : "vlanPool", "hidedEnable" : false, "autoOffTrackLinkEnable" : false, "arpCheckEnable" : true, "ipCheckEnable" : true, "dhcpStrictEnable" : false, "dhcpv6SlaacStrictEnable" : 0, "mdnsSnoopingEnable" : false, "dnsSnoopingEnable" : false, "gameSpeedUpEnable" : false, "relativeRadios" : 3, "relativeOnlyTwoRadios" : 3, "dtimInterval" : 1, "advertiseApNameSwitch" : true, "frequencyNavigation" : true, "maxUserNumber" : 64, "blackAndWhite" : { "bindingType" : 2, "terminalMacList" : [ "XX:XX:XX:XX:XX:XX" ], "terminalOUIList" : [ "02:02:01" ] }, "userSeparation" : false, "separationOption" : "disable", "userL2LanIsolate" : false, "staNetworkDetect" : true, "muMiMo" : true, "associationTimeout" : 5, "erSuSwitch" : true, "userFlowSyslogEnable" : false, "multiLinkOper" : false, "lay3RoamSwitch" : true, "suExtendedRangeSwitch" : false, "muRtsSwitch" : false, "muRtsThreshold" : 2347, "forbiddenOldTerminal" : false, "reachMaxSta" : 1, "igmpSnooping" : false, "multicast2Unicast" : "disable", "bcmcDenyAll" : false, "bonjourTransparent" : false, "powerSave" : false, "beacon2gRate" : "1Mbps", "beacon5gRate" : "6Mbps", "beacon6gRate" : "6Mbps", "sipPort" : 5060, "timeTemplateName" : "全天", "seaSwitch" : false, "overDsPrivate" : "disable", "ssidAuth" : { "mode" : "ppsk", "oweTransitionMode" : true, "transitionOpenSsid" : "de5813f8ff1e41f5ba9c324da70b49ed", "pskEncryptType" : "wpa2", "wepType" : "WEP40", "wepDefaultKey" : 0, "enableMacAuth" : false, "securityKey" : "", "saeEncryptType" : "", "saeSecurityKey" : "", "pskSaeEncryptType" : "", "pskSaeSecurityKey" : "", "securityKeyType" : "AES", "dot1xEncryptType" : "", "dot1xQuietPeriod" : 60, "dot1xQuietTimes" : 10, "macAutoBinding" : true, "macAuthMethod" : "", "escapeStrategy" : "noAuth", "escapeProfileName" : "escapeStrategy1", "escapeProfileId" : "5871926c-2a5e-4340-a931-19ce019a231c", "portal" : { "mode" : "portalThirdIndirect", "pushProtocol" : "https", "freeAuthEnable" : true, "authExpireUnit" : "day", "authExpire" : 10, "escapeStrategy" : 2, "escapeProfileName" : "escapeStrategy1", "escapeProfileId" : "5871926c-2a5e-4340-a931-19ce019a231c", "freeAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "freeAclTmplName" : "free-acl-name", "controllerPortalType" : "haca", "masterPortalTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "masterPortalTmplName" : "", "bakPortalEnable" : false, "bakPortalTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "bakPortalTmplName" : "", "authRedirectUrlCarryEnable" : false, "radiusEnable" : false, "radiusTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "radiusTmplName" : "", "fastPushEnable" : true, "portalPageId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "wechatUrlAuthEnable" : false, "weComAuthEnable" : false, "dingTalkEnable" : false, "normalEnable" : false, "registerEnable" : false, "registerExpire" : 2, "registerExpireUnit" : "hour", "userRegisterMaxAccessNumber" : 0, "userGroupId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "smsAuthEnable" : false, "smsPasswordExpire" : 5, "smsPasswordExpireUnit" : "minute", "smsUserRegisterEnable" : false, "smsUserExpire" : 2, "smsUserExpireUnit" : "hour", "smsUserMaxAccessNumber" : 0, "smsUserGroupId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "emailAuthEnable" : false, "passCodeEnable" : false, "oneKeyAuthEnable" : false, "anonymousEnable" : false, "socialMediaEnable" : false, "twitterEnable" : false, "sinaEnable" : false, "qqEnable" : false, "qrCodeAuthEnable" : false, "qrCodeRegisterEnable" : false, "googleEnable" : false, "accountingEnable" : false, "accountingExpire" : 15, "interconnectionMode" : "API", "userNameKey" : "用户", "passwordKey" : "", "urlMatchMode" : 0, "successUrlKey" : "", "authFailedUrlKey" : "", "logoutSuccessUrlKey" : "", "logoutFailedUrlKey" : "", "logoutUrlKey" : "", "radiusModelId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc" }, "radius" : { "radiusTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "radiusTmplName" : "test", "staticEnable" : false, "iconnectAccessEnable" : "", "autoReauthenTime" : "", "hacaEnable" : false }, "haca" : { "authComponentId" : "00000000-0000-0000-0000-000000000000", "authComponentIp" : "10.20.0.0", "bakAuthComponentId" : "00000000-0000-0000-0000-000000000000", "bakAuthComponentIp" : "10.20.0.0" } }, "vapBackupConfig" : { "vapBackupEnable" : false, "radiusBackupTmplId" : "cf23f275-01e6-4301-890e-407e1d78c53e", "rejectNewAccess" : false }, "ssidPolicy" : { "securityPolicy" : { "highReliableSliceAclTplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "highReliableSliceAclTplName" : "test-slice-acl", "highReliableSliceAclTplIdIpv6" : "b90f8190-e12f-4323-95f3-4018309209c4", "highReliableSliceAclTplNameIpv6" : "test-slice-acl", "securityAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "securityAclTmplName" : "test-security-acl", "securityIPv6AclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "securityIPv6AclTmplName" : "test-security-acl", "ipsecAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c5", "ipsecAclTmplName" : "test-ipsec-acl", "tcpAdjustMss" : 1380, "appTrafficAcls" : { "appTrafficAclList" : [ { "direction" : "inbound", "index" : 0, "dscp" : 1, "appTrafficAclTplId" : "b90f8190-e12f-4323-95f3-4018309209c5", "appTrafficAclName" : "test-tunnel-acl" } ] }, "tunnelAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c5", "tunnelAclTmplName" : "test-tunnel-acl", "urlFilter" : { "enable" : true, "mode" : 1, "urls" : [ "" ], "hostNames" : [ "" ] }, "appsPolicys" : { "siteSaList" : [ { "appId" : 1, "type" : "app", "appType" : 1, "appName" : "test_name", "action" : "permit", "dscp" : 1, "car" : 1000 } ] } }, "ssidRateLimit" : { "upEnable" : true, "upLimit" : "50.0", "downEnable" : true, "downLimit" : "50.0" }, "terminalRateLimit" : { "upEnable" : true, "upLimit" : "50.0", "downEnable" : true, "downLimit" : "50.0", "timeRange" : [ { "timeTemplateId" : "b90f8190-e12f-4323-95f3-4018309209c4", "upEnable" : true, "upLimit" : "50.0", "downEnable" : true, "downLimit" : "50.0" } ] }, "terminalDynamicRateLimit" : { "dynamicEnable" : false, "dynamicLimit" : 16 }, "ipv6Enable" : false, "ndTrustPort" : false }, "dot11r" : false, "overDs" : false, "reassociateTimeout" : 1, "serviceGuarantee" : "performanceFirst", "activeDullClient" : false, "wmmScene" : "default", "edcaClientConfigList" : [ { "accessCategory" : "acvo", "aifsn" : 10, "ecwmax" : 10, "ecwmin" : 10, "txoplimit" : 10 } ], "insertOption82Enable" : false, "option82" : { "circuitId" : { "connectorPattern" : "colon", "contentType" : "ap-mac", "format" : "ascii", "userDefinedText" : "xxx" }, "remoteId" : { "connectorPattern" : "colon", "contentType" : "ap-mac", "format" : "ascii", "userDefinedText" : "xxx" } }, "forwardMode" : "direct", "softgreProfileId" : "fbde1c5d-5b94-49e3-a912-48641015e45f", "configName" : "ssid-tmp-config-name", "phyProtection" : "security-priority" } } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部服务错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 PUT /v1/networkservice/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/pwis 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 { "accessDeviceFloor" : "2", "accessDeviceLatitude" : "16.000000", "accessDeviceLongitude" : "16.000000", "businessClosingTime" : "22:35", "businessStartTime" : "08:00", "dataGenerationSourceId" : "123456", "dataTransmissionTargetId" : "123456", "enable" : true, "isGroupConfig" : true, "siteAccessIp" : "1.0.0.0", "siteAccessType" : "02", "siteAddress" : "xxx", "siteCertificationId" : "xxxxxx", "siteCertificationType" : "111", "siteContactInfo" : "12345", "siteId" : "1234562A123456", "siteLatitude" : "4.000001", "siteLongitude" : "4.000001", "siteMgrProperties" : "0", "siteName" : "xxx", "siteNetFacilitator" : "01", "siteServiceType" : "1", "siteUserName" : "xxxxxx", "thirdnetMonitorId" : "123456", "deviceIdList" : [ "fbb684c8-0d37-496f-bafa-4b06d5151e2e" ] }
  • 响应示例 返回状态码为200:接口配置成功。 { "data": { "enable": true, "siteId": "1234562A123456", "siteName": "1", "siteAddress": "1", "siteLongitude": "1.000000", "siteLatitude": "1.000000", "siteUserName": "121", "siteCertificationId": "131", "siteContactInfo": "141", "siteAccessIp": "1", "thirdnetMonitorId": "1", "accessDeviceLongitude": "1.000000", "accessDeviceLatitude": "1.000000", "accessDeviceFloor": "1", "dataGenerationSourceId": "123456", "dataTransmissionTargetId": "123456", "siteServiceType": "1", "siteMgrProperties": "0", "siteCertificationType": "111", "siteAccessType": "01", "siteNetFacilitator": "01", "businessStartTime": "08:00", "businessClosingTime": "22:35", "isGroupConfig": true }, "errcode": "0", "errmsg": "" } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:服务异常。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应示例 返回状态码为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 { "data" : [ { "serviceType" : "serviceType", "configItemKey" : "configItemKey", "configItemValue" : "configItemValue" } ], "errcode" : "0", "errmsg" : "" } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应参数 返回状态码为200:查询租户全局高级参数配置成功。 表2 ParameterConfigResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data ARRAY_REFERENCE 0-100个列表项,详细请参见表3。 高级参数配置 - errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息描述。 "" 表3 ParameterConfigItem对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 serviceType string 1~128个字符。 - 业务类型 "serviceType" configItemKey string 1~128个字符。 - 配置项key "configItemKey" configItemValue string 0~1024个字符。 - 配置项Value "configItemValue" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /v1/accountservice/parameterconfig?serviceType=serviceType&configItemKey=configItemKey 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/v3/networkconfig/site-templates/{siteTemplateId}/gapiot 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string 36个字符。 - 站点模板标识,UUID格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 isForceOverride 否 boolean true false - 是否强制覆盖 true
  • 请求示例 HTTP的示例 PUT /controller/campus/v3/networkconfig/site-templates/fbde1c5d-5b94-49e3-a912-48641015e45c/gapiot?isForceOverride=true 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 { "panelName" : "AirEngine5760-10", "iotCardDto" : { "cardName" : "card1", "cardConfigured" : "true", "portType" : "ethernet", "communicationPort" : 1026, "extCommunicationPort" : 1027, "communicationProtocol" : "tcp", "shareKey" : "", "trustedHostAddress" : "192.168.3.2/24", "iotServer2" : "192.168.3.2", "port2" : "2080", "administrativeStatus" : "false", "defaultVlan" : "200", "description" : "description", "iotServerOneConfig" : [ { "serverNum" : "2", "iotServer" : "192.168.3.2", "port" : "1080" } ], "powerSwitch" : "on" }, "cardNames" : ["card1"], "operation" : "Update" }
  • 响应示例 返回状态码为200:站点模板全局IOT配置结果。 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" : { "panelName" : "AirEngine5760-10", "iotCardConfig" : { "cardName" : "card1", "cardConfigured" : "true", "portType" : "ethernet", "communicationPort" : 1026, "extCommunicationPort" : 1027, "communicationProtocol" : "tcp", "shareKey" : "", "trustedHostAddress" : "192.168.3.2/24", "iotServer2" : "192.168.3.2", "port2" : "2080", "administrativeStatus" : "false", "defaultVlan" : "200", "description" : "description", "iotServerOneConfig" : [ { "serverNum" : "2", "iotServer" : "192.168.3.2", "port" : "1080" } ], "powerSwitch" : "on" }, "cardNames" : ["card1"], "deviceGroupId" : "fbb684c8-0d37-496f-bafa-4b06db151e2e", "operation" : "update" } } 返回状态码为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 /controller/campus/v1/networkservice/networkconfig/net/time/site-templates/{siteTemplateId}/times 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string - - 站点模板ID,格式为UUID格式。 "fbb684c8-0d37-496f-bafa-4b06db151e2e"
  • 请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/time/site-templates/fbb684c8-0d37-496f-bafa-4b06db151e2e/times 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:查询成功。 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" : { "timezoneId" : "d3dcf87e-8c14-4ba8-bb23-2ccc4451b845", "enableDaylight" : false, "ntpList" : ["10.0.0.2","10.0.0.5"], "enableTimeSync" : true } }
  • 响应示例 返回状态码为200:修改成功,响应体参考AddressSetResponse。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "success" : [ { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "priority" : 50, "attackDefenseEnable" : false, "isDefault" : false } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "priority" : 50, "attackDefenseEnable" : false, "isDefault" : false } } ] } 返回状态码为202:请求正在处理中,请求处理详情请通过查询业务编排结果,确认是否处理成功。响应体参考SecurityZoneTimeOutResponse。 HTTP/1.1 202 Accepted 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" : [ { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "priority" : 50, "attackDefenseEnable" : false, "isDefault" : false } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "priority" : 50, "attackDefenseEnable" : false, "isDefault" : false } } ], "processInstanceId" : "" } 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/security/zone 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 { "securityInfo" : [ { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "priority" : 50, "attackDefenseEnable" : false, "isDefault" : false } ] }
  • 响应参数 返回状态码为200:修改成功,响应体参考AddressSetResponse。 SecurityZoneResponse对象的参数列表,详细请参见表4。 返回状态码为202:请求正在处理中,请求处理详情请通过查询业务编排结果,确认是否处理成功。响应体参考SecurityZoneTimeOutResponse。 SecurityZoneTimeOutResponse对象的参数列表,详细请参见表7。 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/overlay-network/overlay-tunnel 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 { "overlayTunnelInfos" : [ { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "mss" : 2048 } ] }
  • 响应示例 返回状态码为200:接口调用成功,响应体参考OverlayTunnelResponse。 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" : "", "errmsg" : "", "success" : [ { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "mss" : 2048 } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "errparam" : "["policyName"]", "data" : { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "mss" : 2048 } } ], "processInstanceId" : "" } 返回状态码为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
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 overlayTunnels 是 REFERENCE 详细请参见表2。 Overlay Tunnel隧道信息。 - 表2 OverlayTunnels对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 overlayTunnelInfos 是 ARRAY_REFERENCE 1-1000个列表项,详细请参见表3。 Overlay Tunnel mss信息。 - 表3 OverlayTunnelInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 string 1~64个字符。 - VN ID,更新时必填。 "00000000-0000-0000-0000-000000000000" siteId 是 string 1~64个字符。 - 站点ID,更新时必填。 "00000000-0000-0000-0000-000000000000" mss 否 int32 [128-2048] - mss。取值范围128-2048。 2048
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nodes 是 REFERENCE 详细请参见表4。 节点。 -
共100000条
提示

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