华为云用户手册

  • 响应参数 返回状态码为200:查询成功,响应体参考TerminalPrivacyList。 表2 TerminalPrivacyList对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。当没有错误时返回0。 "0" errmsg string - - 错误信息。当没有错误时返回""。 "" pageIndex int32 - - 页码。 1 pageSize int32 - - 页长。 20 total int32 - - 策略总数。 100 terminalPrivacy ARRAY_REFERENCE 0-100个列表项,详细请参见表3。 终端隐私策略。 - 表3 TerminalPrivacy对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 策略ID。 "b9b34988-0dff-4def-9e55-7bc0b3dc21b4" policyName string - - 策略名称。该字段对应UI界面上是:UI【策略名称】 "TenantPolicy" storageTime int32 - - 终端接入记录存储时间,单位:天。 "30" dataMasking boolean true false - 终端信息匿名化。该字段对应UI界面上是:UI【终点信息匿名化】 "false" isEnable boolean true false - 策略是否启用。该字段对应UI界面上是:UI【策略是否启用】 "false" 返回状态码为400:查询失败,参数校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:查询失败,服务内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/api/v1/terminal-privacy?policyType=TENANT&pageIndex=1&pageSize=10 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
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/aptunnel/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/config 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 { "id" : "00000000000000000000000000000000", "name" : "tunnel1", "master-ip" : "192.168.0.1", "backup-ip" : "192.168.0.2", "auto-restore-enable" : true, "auto-restore-delay" : 100, "vlan" : "20,30-200,500", "dtls" : "disable", "dtlsKey" : "tunnelkey", "backupDtls" : "disable", "backupDtlsKey" : "tunnelkey" }
  • URI /controller/campus/v1/networkservice/networkconfig/net/aptunnel/sites/{siteId}/config 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 响应示例 返回状态码为200:修改成功,返回结构体参见APTunelServiceResponseDto。 HTTP/1.1 200 OK Date: Thu,13 Sep 2018 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode" : "0", "errmsg" : "", "data" : [ { "id" : "00000000000000000000000000000000", "name" : "tunnel1", "master-ip" : "192.168.0.1", "backup-ip" : "192.168.0.2", "auto-restore-enable" : true, "auto-restore-delay" : "100", "vlan" : "20,30-200,500", "dtls" : "disable", "backupDtls" : "disable" } ] }
  • 响应参数 返回状态码为200:查询成功,响应体参考QueryDeviceAuthenResponse。 表2 QueryDeviceAuthenResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data ARRAY_REFERENCE 0-100个列表项,详细请参见表5。 - - pageIndex int32 [1-10000] - 当前页,从1开始。 1 pageSize int32 [1-100] - 页大小。 10 totalRecords int32 [1-100000] - 总记录数。 100 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功,响应体参考QueryDeviceAuthenResponse。 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" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "authenticationSchema" : "name", "authenticationModel" : { "primaryModel" : "hwtacacs", "backupModel" : "local" }, "deviceAuthenId" : "00000000-0000-0000-0000-000000000000" } ], "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
  • URI /controller/campus/v1/sdwan/aaa/authentication 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-1000] - 起始页。 1 pageSize 否 int32 [0-100] - 页行记录数。 10 siteId 否 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" authenticationSchema 否 string - - 设备认证方案名称。 "name"
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/aaa/authentication?pageIndex=1&pageSize=10&siteId=00000000-0000-0000-0000-000000000000&deviceId=00000000-0000-0000-0000-000000000000&authenticationSchema=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
  • 响应示例 返回状态码为200:查询成功返回体。 { "data": [ { "id": "e9a51c61-f6cb-4884-9b3f-c54b8716feed", "deviceId": "9c24d989-49d7-4877-933a-67d285879319", "deviceName": "2102353GES10LA000052", "deviceStatus": 0, "esn": "2102353GES10LA000052", "siteName": "name", "pluginName": "test", "status": 2, "failreason": null } ], "totalNum": 1, "errcode": "0", "errmsg": null } 返回状态码为400:查询失败返回体。 { "data": [], "totalNum": 0, "errcode": "0x00c80035", "errmsg": "Invalid parameter pluginType." }
  • 响应参数 返回状态码为200:查询成功返回体。 表3 DevicePluginInfosRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表4。 插件列表。 - totalNum int64 [0-100000] - 总数。 "0" errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 " " 表4 DevicePluginInfoRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 1~64个字符。 - id。 "e9a51c61-f6cb-4884-9b3f-c54b8716feed" deviceId string 1~64个字符。 - 设备ID。 "9c24d989-49d7-4877-933a-67d285879319" deviceName string 1~64个字符。 - 设备名称。 "AirEngine5773-21_4A096F85" deviceStatus int32 [0-10] - 设备状态,0:在线,1:告警,3:离线,4:未注册。 0 esn string 1~64个字符。 - 设备ESN。 "21500831023000000000" siteName string 1~64个字符。 - 站点名称。 "site1" pluginName string 1~64个字符。 - 插件名称。 "plugin1" status int32 [0-10] - 部署状态(0:初始化,1:部署中,2:部署成功,3:部署失败,4:卸载中,5:卸载成功,6:卸载失败)。 0 failreason string 0~256个字符。 - 失败原因。 "This configuration is not supported by the current model or version of the device." 返回状态码为400:查询失败返回体。 DevicePluginInfosRsp对象的参数列表,详细请参见表3。
  • 响应参数 返回状态码为200:查询成功,响应体参考QueryDeviceRadiusServerTemplateRsp。 表2 QueryDeviceRadiusServerTemplateRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" pageIndex int32 [1-10000] - 当前页,从1开始。 1 pageSize int32 [1-10000] - 页大小。 10 totalRecords int32 [1-100000] - 总记录数。 100 data ARRAY_REFERENCE 0-10000个列表项,详细请参见表3。 设备RADIUS服务器模板信息 - 表3 DetailedDeviceRadiusServerTemplateInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 0~36个字符。 - 设备RADIUS服务器模板ID "00000000-0000-0000-0000-000000000000" templateInfo REFERENCE 详细请参见表6。 - - createTime string 0~13个字符。 - 创建时间 "1604909066000" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功,响应体参考QueryDeviceRadiusServerTemplateRsp。 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" : "", "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 100, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "templateInfo" : { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "name" : "RadiusServer1", "desc" : "RADIUS服务器", "isContainDomainName" : true, "sharedKey" : "Example@123", "primaryAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "10.134.6.5", "loopbackInterface" : "601" }, "secondAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "10.134.6.5", "loopbackInterface" : "601" }, "primaryAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "10.134.6.5", "loopbackInterface" : "601" }, "secondAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "10.134.6.5", "loopbackInterface" : "601" } }, "createTime" : "1604909066000" } ] } 返回状态码为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/rest/sdwan/v1/device/radius/template?pageIndex=1&pageSize=10&siteId=00000000-0000-0000-0000-000000000000&deviceId=00000000-0000-0000-0000-000000000000&name=radiusServer1 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/rest/sdwan/v1/device/radius/template 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 是 int32 [0-10000] - 起始页。 pageIndex或pageSize为0时表示查询该租户下符合其他查询条件的所有RADIUS服务器模板。 1 pageSize 是 int32 [0-100] - 页行记录数。 pageIndex或pageSize为0时表示查询该租户下符合其他查询条件的所有RADIUS服务器模板。 10 siteId 否 string 0~36个字符。 - 站点ID "00000000-0000-0000-0000-000000000000" deviceId 否 string 0~36个字符。 - 设备ID "00000000-0000-0000-0000-000000000000" name 否 string 0~32个字符。 - 设备RADIUS服务器模板名称,模糊查询。 "radiusServer1"
  • 响应示例 返回状态码为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的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-syslog:syslog-config/server 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:server" : [ { "ipaddress" : "E2:1:1:1:1:1:1:1", "vrf-name" : "_public_", "port" : 453, "transport-mode" : "tcp", "channel-id" : 5, "facility" : "local7", "ssl-policy-name" : "default" } ] }
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-syslog:syslog-config/server 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000"
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 server 是 REFERENCE 详细请参见表4。 服务 - 表4 syslog-config-exactProperties-server-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-syslog:server 否 ARRAY_REFERENCE 0-8个列表项,详细请参见表5。 服务 - 表5 syslog-config-exactProperties-server-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipaddress 是 string - - IP地址 "E2:1:1:1:1:1:1:1" vrf-name 是 string 1~31个字符。 - VPN名称,默认为__public__ "_public_" port 否 int64 [1-65535] - 端口 453 transport-mode 否 string udp tcp - 传输模式 "tcp" channel-id 否 int64 [0-9] - 通道ID 5 facility 否 string local0 local1 local2 local3 local4 local5 local6 local7 - 设施,枚举值,默认为local7 "local7" ssl-policy-name 否 string 1~23个字符。满足正则表达[a-z0-9_]*。 - ssl策略名称 "default"
  • 响应示例 返回状态码为200:创建成功,响应体参考PingConfigResponse。 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 { "errorCode" : 0, "errorMsg" : "", "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "taskName" : "task", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "networkType" : 0, "linkId" : "00000000-0000-0000-0000-000000000000", "virtualNetworkId" : "00000000-0000-0000-0000-000000000000", "ipType" : "IPv4", "sourceIp" : "192.168.1.1", "destination" : "192.168.1.1", "packetSize" : 100, "count" : 10, "status" : 1, "createTime" : "2019-02-16" } ] } 返回状态码为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:创建成功,响应体参考PingConfigResponse。 表3 PingConfigResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode int32 - - 错误码。 0 errorMsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-2147483647个列表项,详细请参见表4。 - - 表4 PingTask对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 任务ID。 "00000000-0000-0000-0000-000000000000" taskName string - - 任务名称。 "task" siteId string - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId string - - 设备ID。 "00000000-0000-0000-0000-000000000000" networkType Int2 - 0 网络类型:0 表示物理网络,1 表示虚拟网络。默认值为0(物理网络)。 0 linkId string - - 链路ID。 "00000000-0000-0000-0000-000000000000" virtualNetworkId string - - 虚拟网络ID。 "00000000-0000-0000-0000-000000000000" ipType string - - IP类型,值为IPv4或者IPv6。 "IPv4" sourceIp string - - 源IP。 "192.168.1.1" destination string - - 目的IP。 "192.168.1.1" packetSize Int4 - 56 包大小。默认值为56。 100 count Int2 - 5 请求包个数。默认值为5。 10 status Int2 - 0 Ping任务状态。0表示成功,1表示进行中,2表示超时。默认值为0(成功)。 1 createTime string - - Ping任务创建时间。 "2019-02-16" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v2/sdwan/diagnose/ping 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" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "subDeviceId" : "00000000-0000-0000-0000-000000000000", "networkType" : 1, "linkId" : "00000000-0000-0000-0000-000000000000", "tenantId" : "00000000-0000-0000-0000-000000000000", "virtualNetworkId" : "00000000-0000-0000-0000-000000000000", "ipType" : "IPv4", "sourceIp" : "192.168.1.1", "destination" : "192.168.1.1", "count" : 10, "packetSize" : 100, "teClass" : 100, "vpnInstanceName" : "" }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 Ping任务信息。 - 表2 PingConfigRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点Id,UUID格式。 "00000000-0000-0000-0000-000000000000" deviceId 是 string 36个字符。 - 设备Id,UUID格式。 "00000000-0000-0000-0000-000000000000" subDeviceId 否 string 36个字符。 - 子设备Id,UUID格式,仅6700V系列设备支持。 "00000000-0000-0000-0000-000000000000" networkType 是 int32 1个字符。 - 网络类型。 对非AR6700V设备,0 表示物理网络,1 表示虚拟网络;对AR6700V设备,仅0为合法值。 1 linkId 否 string 36个字符。 - 链路Id,用于ping物理网络。 SRv6隧道模式下,该字段无效。 "00000000-0000-0000-0000-000000000000" tenantId 否 string - - IWG场景类型为虚拟网络,MSP下的租户ID;networkType配置为虚拟网络,此字段必填。 "00000000-0000-0000-0000-000000000000" virtualNetworkId 否 string 36个字符。 - 虚拟网络Id,用于ping虚拟网络。 "00000000-0000-0000-0000-000000000000" ipType 否 string 0~10个字符。 - IP类型,值为IPv4或者IPv6。 "IPv4" sourceIp 否 string 0~255个字符。 - 源IP。 "192.168.1.1" destination 是 string 1~255个字符。 - 目的IP。 "192.168.1.1" count 否 int32 [1-64] 5 Ping包个数。默认值5。 10 packetSize 否 int32 [20-9600] 56 包大小。默认值56。 100 teClass 否 int32 [1-65535] - Te class,该字段仅支持SRv6隧道模式下使用。 100 vpnInstanceName 否 string 0~31个字符。 - 虚拟网络名称,预留字段,暂不支持。 -
  • 响应示例 返回状态码为200:更新内联链路成功,响应体参考InterLinkResponse。 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" : "a99f794e-b510-438c-a75d-de59f02347eb", "interLink" : { "type" : "l3-interface", "enableGre" : false, "vlanMin" : 4000, "vlanMax" : 4008, "extendVlans" : ["1:9"], "portPairs" : [ { "device1PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1PortType" : "GE", "device1PortNum" : "0/0/1", "device1PortAddress" : "192.168.101.1", "device1PortMask" : 24, "device2Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortType" : "GE", "device2PortNum" : "0/0/1", "device2PortAddress" : "192.168.101.1", "device2PortMask" : 24 } ], "mtu" : 1500, "mss" : 1200 } } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "interLink" : { "type" : "l3-interface", "enableGre" : false, "vlanMin" : 4000, "vlanMax" : 4008, "extendVlans" : ["1:9"], "portPairs" : [ { "device1PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1PortType" : "GE", "device1PortNum" : "0/0/1", "device1PortAddress" : "192.168.101.1", "device1PortMask" : 24, "device2Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortType" : "GE", "device2PortNum" : "0/0/1", "device2PortAddress" : "192.168.101.1", "device2PortMask" : 24 } ], "mtu" : 1500, "mss" : 1200 } } } ] } 返回状态码为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/net/site/interlink 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 { "interLinks" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "interLink" : { "type" : "l3-interface", "enableGre" : false, "vlanMin" : 4000, "vlanMax" : 4008, "extendVlans" : ["1:9"], "portPairs" : [ { "device1PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1PortType" : "GE", "device1PortNum" : "0/0/1", "device1PortAddress" : "192.168.101.1", "device1PortMask" : 24, "device2Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortType" : "GE", "device2PortNum" : "0/0/1", "device2PortAddress" : "192.168.101.1", "device2PortMask" : 24 } ], "mtu" : 1500, "mss" : 1200 } } ] }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 unbound-devices-from-binding 是 REFERENCE 详细请参见表2。 unbound devices from binding. - 表2 unbound-devices-from-binding-input对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template-binding:input REFERENCE 详细请参见表3。 - - 表3 unbound-devices-from-binding-input-body对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 device 是 ARRAY_REFERENCE 详细请参见表6。 list device - template-binding-id 否 string 0~128个字节。 - the identifier of the template application. "f3685151-6e70-46a8-934f-4004c532dcc4" delete-config-from-device 否 boolean true false false Whether delete config from device. true
  • 请求示例 HTTP的示例 POST /restconf/operations/huawei-nce-aoc-config-template-binding:unbound-template-binding Host: 192.168.1.125:26335 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "input": { "delete-config-from-device": true, "device": [{ "device-id": "8d394835-cb84-38f3-a4d5-36a7f2074b78" }], "template-binding-id": "7b685011-e7bd-4649-9264-c1e0557ba15b" } }
  • 响应示例 返回状态码为204:Successful operation HTTP/1.1 204 No Content Date: Fri,30 Dec 2022 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400:Internal Error HTTP/1.1 400 Bad Request Date: Fri,30 Dec 2022 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" : "", "data" : { "processStatus" : "running", "processProgress" : "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
  • 响应参数 返回状态码为200:重编排结果 表1 ProgressResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表2。 拓扑编排进度信息。 - 表2 ProgressInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 processStatus string 0~8个字符。 - 编排process的状态:running、success、fail。 "running" processProgress string 0~8个字符。 - 进程进度,返回百分比数值。 "100%" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
共100000条