华为云用户手册

  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/routing-protocol/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 { "communityFilters" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "mode" : "basic", "name" : "communityTest", "nodes" : [ { "index" : 1, "matchMode" : "permit", "communityMembers" : ["10"], "regular" : "^65537$" } ] } ] }
  • 响应示例 返回状态码为200:接口调用成功,响应体参考CommunityFilterResponse。 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" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "mode" : "basic", "name" : "communityTest", "nodes" : [ { "index" : 1, "matchMode" : "permit", "communityMembers" : ["10"], "regular" : "^65537$" } ] } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "mode" : "basic", "name" : "communityTest", "nodes" : [ { "index" : 1, "matchMode" : "permit", "communityMembers" : ["10"], "regular" : "^65537$" } ] } } ] } 返回状态码为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/lanwan/interconnection/route/ospf 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 { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "neighborInfo" : { "areaId" : 10, "areaType" : "normal", "helloTimer" : 1, "timerPoll" : 1, "timerDead" : 1, "timerRetransmit" : 1, "authenticationInfo" : { "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc" }, "coreInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" }, "gatewayInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" } }, "coreProcessId" : 10, "gatewayProcessId" : 10, "gatewayRouterId" : "192.168.1.1", "coreOspfIntfs" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 } } ], "gatewayOspfIntfs" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 } } ] }
  • 响应示例 返回状态码为200:更新OSPF邻居参数返回信息。 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" : { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "neighborInfo" : { "areaId" : 10, "areaType" : "normal", "helloTimer" : 1, "timerPoll" : 1, "timerDead" : 1, "timerRetransmit" : 1, "authenticationInfo" : { "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc" }, "coreInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" }, "gatewayInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" } }, "coreProcessId" : 10, "gatewayProcessId" : 10, "gatewayRouterId" : "192.168.1.1", "coreOspfIntfs" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 } } ], "gatewayOspfIntfs" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 } } ] }, "fail" : { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "coreFailOspfIntfInfo" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 }, "errcode" : "0", "errmsg" : "" } ], "gatewayFailOspfIntfInfo" : [ { "processId" : 10, "routerId" : "192.168.1.1", "configSource" : "LANWAN", "OspfIntfInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 }, "errcode" : "0", "errmsg" : "" } ], "errcode" : "0", "errmsg" : "", "neighborInfo" : { "areaId" : 10, "areaType" : "normal", "helloTimer" : 1, "timerPoll" : 1, "timerDead" : 1, "timerRetransmit" : 1, "authenticationInfo" : { "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc" }, "coreInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" }, "gatewayInterfaceInfo" : { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast" } }, "coreFailInfo" : { "errcode" : "0", "errmsg" : "", "processId" : 10 }, "gatewayFailInfo" : { "errcode" : "0", "errmsg" : "", "processId" : 10 } } } 返回状态码为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/baseservice/api/v1/filemgr/files/combine-fileinfo 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 { "fileName" : "test", "description" : "插件文件", "addCombineFileInfos" : [ { "fileName" : "plugin.ova", "fileType" : 19, "localFilePath" : "C:\\fakepath\\test1.ova", "fileSize" : 11 } ] }
  • 响应参数 返回状态码为200:保存文件信息成功返回。返回体参考AddFileInfoResponse 表4 AddCombineFileInfoResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string - - 错误码。 0 : 无错误 1 : 参数校验或数据访问错误 详细信息见errMsg "0" errMsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-10个列表项,详细请参见表3。 组合文件信息返回 - 返回状态码为400:参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:服务内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:保存文件信息成功返回。返回体参考AddFileInfoResponse 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" : [ { "errCode" : "0", "errMsg" : "test.xml Add success!", "fileId" : "549d0eec-9d6a-40c2-ab36-c7239e5fe409", "fileName" : "test.xml" } ] } 返回状态码为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参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 AddCombineFile 是 REFERENCE 详细请参见表2。 上传插件文件基本信息。 插件文件:文件类型固定参数22(入参无需设置) 插件文件由以下三个文件组合而成:(addCombineFileInfos的入参) (三个文件每个必有且仅有一个作为入参) 插件文件(.ova):文件类型入参19 插件密钥(.pem):文件类型入参23 插件签名(.asc):文件类型入参24 - 表2 AddCombineFile对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 fileName 是 string 0~64个字符。 - 文件名称 "test" description 否 string 0~255个字符。 - 文件描述 该字段对应UI页面上是:UI【描述】 "插件文件" addCombineFileInfos 是 ARRAY_REFERENCE 0-3个列表项,详细请参见表3。 文件信息列表。 上传插件时由三个文件组成,详见上传插件文件信息接口入参描述 - 表3 AddCombineFileInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 fileName 是 string 0~64个字符。 - 文件名称 "plugin.ova" fileType 是 int32 [0-100] - 文件类型 取值详见上传组合文件信息接口的入参描述 19 localFilePath 是 string 0~1000个字符。 - 文件上传时的本地路径 "C:\\fakepath\\test1.ova" fileSize 是 int64 [0-2147483647] - 文件大小(B) 文件类型对应大小限制 插件文件 20971520 插件密钥 4096 插件签名 2048 11
  • 响应示例 返回状态码为200:创建成功,响应体参考RadiusCreateOrUpdateResponse。 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" : "c6c76e11-6f75-41fb-8d90-594323c9f811", "templateInfo" : { "name" : "RadiusServer1", "desc" : "RADIUS服务器", "isContainDomainName" : true, "sharedKey" : "Example@123", "primaryAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 }, "secondAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 }, "primaryAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 }, "secondAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 } } } } 返回状态码为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:创建成功,响应体参考RadiusCreateOrUpdateResponse。 表4 RadiusCreateOrUpdateResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表5。 - - 表5 RadiusServerTemplateInfoWithId对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 0~36个字符。 - RADIUS服务器模板ID "c6c76e11-6f75-41fb-8d90-594323c9f811" templateInfo REFERENCE 详细请参见表6。 - - 表6 RadiusServerTemplateInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 1~32个字符。 - RADIUS服务器名称。 字符串形式,区分大小写,长度范围是1~32。字符包括大写字母、小写字母、数字、点号“.”、下划线“_”和中划线“-”。不能配置为“-”或“--”。 "RadiusServer1" desc string 0~128个字符。 - RADIUS服务器描述。 "RADIUS服务器" isContainDomainName boolean true false false 是否包含 域名 ,默认false。 true sharedKey password 1~128个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 共享密钥。 "Example@123" primaryAuthenServerInfo REFERENCE 详细请参见表7。 - - secondAuthenServerInfo REFERENCE 详细请参见表7。 - - primaryAccountServerInfo REFERENCE 详细请参见表7。 - - secondAccountServerInfo REFERENCE 详细请参见表7。 - - 表7 ServerInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 serverIP string 0~64个字符。 - 服务器IP地址,支持IPV4。 "10.134.6.5" serverPort int32 [1-65535] - 服务器端口号, 范围1~65535。 10 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/rest/sdwan/v2/radius/template 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" : "RadiusServer1", "desc" : "RADIUS服务器", "isContainDomainName" : true, "sharedKey" : "Example@123", "primaryAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 }, "secondAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 }, "primaryAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 }, "secondAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10 } }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 RequestBody 是 REFERENCE 详细请参见表2。 RADIUS服务器模板信息。 - 表2 RadiusServerTemplateInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 是 string 1~32个字符。 - RADIUS服务器名称。 字符串形式,区分大小写,长度范围是1~32。字符包括大写字母、小写字母、数字、点号“.”、下划线“_”和中划线“-”。不能配置为“-”或“--”。 "RadiusServer1" desc 否 string 0~128个字符。 - RADIUS服务器描述。 "RADIUS服务器" isContainDomainName 否 boolean true false false 是否包含域名,默认false。 true sharedKey 是 password 1~128个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 共享密钥。 "Example@123" primaryAuthenServerInfo 是 REFERENCE 详细请参见表3。 - - secondAuthenServerInfo 否 REFERENCE 详细请参见表3。 - - primaryAccountServerInfo 否 REFERENCE 详细请参见表3。 - - secondAccountServerInfo 否 REFERENCE 详细请参见表3。 - - 表3 ServerInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 serverIP 是 string 0~64个字符。 - 服务器IP地址,支持IPV4。 "10.134.6.5" serverPort 是 int32 [1-65535] - 服务器端口号, 范围1~65535。 10
  • 响应示例 返回状态码为200:配置租户BootROM密码。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "" }
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/bootrom HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "passwd" : "Iam@example1", "oldPasswd" : "Iam@example1" }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 配置租户BootROM密码。 - 表2 BootRomDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 passwd 否 password 8~255个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 V200版本的LSW设备新密码必须包含如下规则: 1.密码长度必须在8-80位。 2.密码必须满足复杂度,即至少包含英文大写字母(A~Z)、英文小写字母(a~z)、数字(0~9)、特殊字符(如!、@、#、$、%)等中的三种,不允许包含'、?和空格。 3.密码中不能包含两个以上连续的相同字符。 V600版本的LSW设备新密码必须包含如下规则: 1、长度限制 8~255 2、新旧密码不能相同 3、密码不包含空格 4、密码复杂度校验 小写字母 大写字母 数字 特殊字符至少包含两种 "Iam@example1" oldPasswd 否 password 8~255个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 V200版本的LSW设备不需要此字段,V600版本的LSW设备旧密码必须包含如下规则: 1、长度限制 8~255 2、新旧密码不能相同 3、密码不包含空格 4、密码复杂度校验 小写字母 大写字母 数字 特殊字符至少包含两种 "Iam@example1"
  • 请求示例 HTTP的示例 DELETE /controller/campus/v1/lanwan/vn/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:正常响应返回体。返回的VN信息中仅包含对应的ID。 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" : "vn1", "vpnInstanceName" : "vpn1", "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ], "ipsecEncryption" : true, "overlayHeadLength" : 36, "enableIPv6" : true, "description" : "vn", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6" } } 返回状态码为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 { "errcode" : "0", "errmsg" : "", "data" : { "mask" : "22", "description" : "", "nextAddress" : "10.20.0.0", "destinationIp" : "10.20.0.0", "priority" : 5, "nextInterface" : "GigabitEthernet0/0/4", "nqaId" : "d26320b9e15a4b069576f1ebff9c9cc1", "nqaAdminName" : "adminName", "nqaTestName" : "test", "dhcp" : false, "nextLogicInterface" : "Dialer1", "id" : "de5813f8ff1e41f5ba9c324da70b49ed" } } 返回状态码为400:校验失败信息。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/arstaticroute/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/staticroute 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 { "mask" : "22", "description" : "", "nextAddress" : "10.20.0.0", "destinationIp" : "10.20.0.0", "priority" : 5, "nextInterface" : "GigabitEthernet0/0/4", "nqaId" : "d26320b9e15a4b069576f1ebff9c9cc1", "nqaAdminName" : "adminName", "nqaTestName" : "test", "dhcp" : false, "nextLogicInterface" : "Dialer1", "id" : "de5813f8ff1e41f5ba9c324da70b49ed" }
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceArStaticrouteInfoDto 是 REFERENCE 详细请参见表3。 修改的路由器设备静态路由配置。 - 表3 DeviceArStaticrouteInfoDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mask 是 string 0~32个字符。 - 掩码,0-32。创建后不允许修改。 "22" description 否 string 0~256个字符。 - 描述。 "" nextAddress 否 string 0~64个字符。 - 下一跳地址,必须是合法的IPv4地址,以127或者224~255开头的IP地址为非法IP地址。当nextInterface为空时,nextAddress必填。 "10.20.0.0" destinationIp 是 string 0~64个字符。 - 目的IP地址,创建后不允许修改。必须是合法的IPv4地址,以127或者224~255开头的IP地址为非法IP地址。 "10.20.0.0" priority 否 integer [1-255] - 优先级,取值越小优先级越高,为空时默认为60。 5 nextInterface 否 string 0~25个字符。 - 路由出接口。当nextAddress为空时,nextInterface必填。 "GigabitEthernet0/0/4" nqaId 否 string 0~32个字符。 - NQA的ID。 "d26320b9e15a4b069576f1ebff9c9cc1" nqaAdminName 否 string 0~32个字符。 - NQA的admin名称,待拓展字段,入参时无需填写。 "adminName" nqaTestName 否 string 0~32个字符。 - NQA的测试名称,待拓展字段,入参时无需填写。 "test" dhcp 否 boolean true false false DHCP开关使能。当nextAddress非空时,dhcp必须为false,不填时默认为false。 false nextLogicInterface 否 string 0~32个字符。 - 逻辑出接口,待拓展字段,入参时无需填写。 "Dialer1" id 是 string 0~32个字符。 - 路由器静态路由ID。 "de5813f8ff1e41f5ba9c324da70b49ed"
  • URI /controller/campus/v1/networkservice/networkconfig/net/arstaticroute/devices/{deviceId}/staticroute 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备标识,UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 响应示例 返回状态码为201:创建成功,响应体参考UrlFilterPolicyResponse。 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" : "", "success" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "UrlFilterPolicy", "status" : 1, "isActive" : true, "defaultAction" : "permit", "excludedUrls" : [ "www.example.com" ], "blackUrls" : [ "www.example.com" ], "whiteUrls" : [ "www.example.com" ], "level" : "high", "customFilters" : [ { "cid" : 1, "classification" : "P2P", "action" : "permit" } ], "policyType" : false, "securityZone" : { "securityInterZones" : [ [ "test_1" ] ] } } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "UrlFilterPolicy", "status" : 1, "isActive" : true, "defaultAction" : "permit", "excludedUrls" : [ "www.example.com" ], "blackUrls" : [ "www.example.com" ], "whiteUrls" : [ "www.example.com" ], "level" : "high", "customFilters" : [ { "cid" : 1, "classification" : "P2P", "action" : "permit" } ], "policyType" : false, "securityZone" : { "securityInterZones" : [ [ "test_1" ] ] } } } ] } 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/security/url-filter-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, "urlFilterPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "UrlFilterPolicy", "status" : 1, "isActive" : true, "defaultAction" : "permit", "excludedUrls" : [ "www.example.com" ], "blackUrls" : [ "www.example.com" ], "whiteUrls" : [ "www.example.com" ], "level" : "high", "customFilters" : [ { "cid" : 1, "classification" : "P2P", "action" : "permit" } ], "policyType" : false, "securityZone" : { "securityInterZones" : [ [ "test_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" : { "vlanId" : 10, "ip" : "10.0.0.10", "mask" : "24", "gateway" : "10.0.0.254", "masterDns" : "10.10.10.10", "slaveDns" : "10.0.0.254" } }
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/apstaticip/devices/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 { "vlanId" : 10, "ip" : "10.0.0.10", "mask" : "24", "gateway" : "10.0.0.254", "masterDns" : "10.10.10.10", "slaveDns" : "10.0.0.254" }
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 静态IP配置参数体。 - 表3 APStaticIpDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vlanId 否 integer [1-4094] - 管理VLAN。 10 ip 否 string - - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 静态IP地址,支持配置单播IP地址。 "10.0.0.10" mask 否 string - - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 掩码,取值范围是1~32范围内的整数。 "24" gateway 否 string - - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 网关地址,支持配置单播IP地址。 "10.0.0.254" masterDns 否 string - - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 主 DNS地址 ,支持配置单播IP地址。 "10.10.10.10" slaveDns 否 string - - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 备DNS地址,支持配置单播IP地址。 "10.0.0.254"
  • 接口约束 该接口支持msp视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用,且仅支持AR6700V和AR6700V子设备; 或者支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用,且仅支持AR6700V-L款型。 该API可能会直接或间接影响现网业务运行,导致业务中断、关键数据丢失等,请谨慎操作!
  • 响应示例 返回状态码为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-traffic-behavior:traffic-behavior/{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~31个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - 名称,单一主键字段。 "Traffic Behavior"
  • 请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-traffic-behavior:traffic-behavior/Traffic+Behavior 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"
共100000条
提示

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