华为云用户手册

  • 请求示例 HTTP的示例 PUT /controller/campus/rest/sdwan/v1/device/radius/template 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 { "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" } } }
  • 响应示例 返回状态码为200:修改成功,响应体参考DeviceRadiusCreateOrUpdateResponse。 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" : "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" } } } } 返回状态码为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参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 RequestBody 是 REFERENCE 详细请参见表2。 设备RADIUS服务器模板信息。 - 表2 DeviceRadiusServerTemplateInfoWithId对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 0~36个字符。 - 设备RADIUS服务器模板ID "00000000-0000-0000-0000-000000000000" templateInfo 是 REFERENCE 详细请参见表2。 - -
  • 响应参数 返回状态码为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,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" : "", "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,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的示例 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,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" : "tacacs1", "description" : "", "masterAuthenServerIp" : "10.0.0.10", "masterAuthenServerPort" : 20, "slaveAuthenServerIp" : "10.1.1.10", "slaveAuthenServerPort" : 20, "thirdAuthenServerIp" : "10.0.0.10", "thirdAuthenServerPort" : 20, "masterAuthorServerIp" : "10.0.0.10", "masterAuthorServerPort" : 30, "slaveAuthorServerIp" : "10.1.1.10", "slaveAuthorServerPort" : 30, "thirdAuthorServerIp" : "10.0.0.10", "thirdAuthorServerPort" : 30, "masterAccServerIp" : "10.0.0.10", "masterAccServerPort" : 40, "slaveAccServerIp" : "10.1.1.10", "slaveAccServerPort" : 40, "thirdAccServerIp" : "10.0.0.10", "thirdAccServerPort" : 40, "includeDomain" : false, "builtInServerEnable" : false, "sourceIpEnable" : true, "configName" : "abc", "id" : "fbb684c8-0d37-496f-bafa-4b06db151e2e" } }
  • 响应参数 返回状态码为200:新增成功,返回配置信息。 表3 createTacacsTmplResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表4。 - - 表4 tacacsTmplInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 1~32个字符。 - 名称(不支持$&?=+%][^_,#"相关特殊字符, 不支持修改)。 "tacacs1" description string 0~128个字符。 - 描述。 "" masterAuthenServerIp string - - 主认证服务器IP地址。 "10.0.0.10" masterAuthenServerPort integer [1-65535] - 主认证服务器端口。 20 slaveAuthenServerIp string - - 备认证服务器IP地址。 "10.1.1.10" slaveAuthenServerPort integer [1-65535] - 备认证服务器端口。 20 thirdAuthenServerIp string 0~15个字符。 - 第三认证服务器IP地址。 "10.0.0.10" thirdAuthenServerPort int32 [1-65535] - 第三认证服务器端口。 20 masterAuthorServerIp string - - 主授权服务器IP地址。 "10.0.0.10" masterAuthorServerPort integer [1-65535] - 主授权服务器端口。 30 slaveAuthorServerIp string - - 备授权服务器IP地址。 "10.1.1.10" slaveAuthorServerPort integer [1-65535] - 备授权服务器端口。 30 thirdAuthorServerIp string 0~15个字符。 - 第三授权服务器IP地址。 "10.0.0.10" thirdAuthorServerPort int32 [1-65535] - 第三授权服务器端口。 30 masterAccServerIp string - - 主计费服务器IP地址。 "10.0.0.10" masterAccServerPort integer [1-65535] - 主计费服务器端口。 40 slaveAccServerIp string - - 备计费服务器IP地址。 "10.1.1.10" slaveAccServerPort integer [1-65535] - 备计费服务器端口。 40 thirdAccServerIp string 0~15个字符。 - 主计费服务器IP地址。 "10.0.0.10" thirdAccServerPort int32 [1-65535] - 主计费服务器端口。 40 includeDomain boolean true false true 向Tacacs服务器发起认证的用户名是否包含 域名 。默认值为true。 false builtInServerEnable boolean true false false 是否启用内置服务器。目前还不支持,只用来做查询接口返回值,默认值为false。 false sourceIpEnable boolean true false - 源IP配置使能 true configName string 0~20个字符。满足正则表达^[a-zA-Z0-9._-]{0,20}$。 - 配置名称标识,用于tacacs-server-name "abc" id uuid - - Tacacs模板ID。 "fbb684c8-0d37-496f-bafa-4b06db151e2e"
  • 请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/profile/tacacs 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" : "tacacs1", "description" : "", "masterAuthenServerIp" : "10.0.0.10", "masterAuthenServerPort" : 20, "slaveAuthenServerIp" : "10.1.1.10", "slaveAuthenServerPort" : 20, "thirdAuthenServerIp" : "10.0.0.10", "thirdAuthenServerPort" : 20, "masterAuthorServerIp" : "10.0.0.10", "masterAuthorServerPort" : 30, "slaveAuthorServerIp" : "10.1.1.10", "slaveAuthorServerPort" : 30, "thirdAuthorServerIp" : "10.0.0.10", "thirdAuthorServerPort" : 30, "masterAccServerIp" : "10.0.0.10", "masterAccServerPort" : 40, "slaveAccServerIp" : "10.1.1.10", "slaveAccServerPort" : 40, "thirdAccServerIp" : "10.0.0.10", "thirdAccServerPort" : 40, "includeDomain" : false, "builtInServerEnable" : false, "sourceIpEnable" : true, "configName" : "abc", "shareKey" : "null" }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 tacacs服务器模板信息。 - 表2 createTacacsTmplInfoDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 是 string 1~32个字符。 - 名称(不支持$&?=+%][^_,#"相关特殊字符, 不支持修改)。 "tacacs1" description 否 string 0~128个字符。 - 描述。 "" masterAuthenServerIp 是 string - - 主认证服务器IP地址。 "10.0.0.10" masterAuthenServerPort 是 integer [1-65535] - 主认证服务器端口。 20 slaveAuthenServerIp 否 string - - 备认证服务器IP地址。 "10.1.1.10" slaveAuthenServerPort 否 integer [1-65535] - 备认证服务器端口。 20 thirdAuthenServerIp 否 string 0~15个字符。 - 第三认证服务器IP地址。 "10.0.0.10" thirdAuthenServerPort 否 int32 [1-65535] - 第三认证服务器端口。 20 masterAuthorServerIp 否 string - - 主授权服务器IP地址。 "10.0.0.10" masterAuthorServerPort 否 integer [1-65535] - 主授权服务器端口。 30 slaveAuthorServerIp 否 string - - 备授权服务器IP地址。 "10.1.1.10" slaveAuthorServerPort 否 integer [1-65535] - 备授权服务器端口。 30 thirdAuthorServerIp 否 string 0~15个字符。 - 第三授权服务器IP地址。 "10.0.0.10" thirdAuthorServerPort 否 int32 [1-65535] - 第三授权服务器端口。 30 masterAccServerIp 否 string - - 主计费服务器IP地址。 "10.0.0.10" masterAccServerPort 否 integer [1-65535] - 主计费服务器端口。 40 slaveAccServerIp 否 string - - 备计费服务器IP地址。 "10.1.1.10" slaveAccServerPort 否 integer [1-65535] - 备计费服务器端口。 40 thirdAccServerIp 否 string 0~15个字符。 - 主计费服务器IP地址。 "10.0.0.10" thirdAccServerPort 否 int32 [1-65535] - 主计费服务器端口。 40 includeDomain 否 boolean true false true 向Tacacs服务器发起认证的用户名是否包含域名。默认值为true。 false builtInServerEnable 否 boolean true false false 是否启用内置服务器。目前还不支持,只用来做查询接口返回值,默认值为false。 false sourceIpEnable 否 boolean true false - 源IP配置使能 true configName 否 string 0~20个字符。满足正则表达^[a-zA-Z0-9._-]{0,20}$。 - 配置名称标识,用于tacacs-server-name "abc" shareKey 是 password 1~255个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 秘钥(英文字母、数字、除空格和问号外特殊符号,建议长度不小于8位),秘钥不能全为“*”。 "null"
  • 响应示例 返回状态码为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-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"
  • 请求示例 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" } ] }
  • 请求示例 HTTP的示例 POST /v1/performanceservice/identify/instances 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" : "test", "description" : "五元组模板", "fiveTuple" : { "protocol" : "TCP", "srcIp" : "192.168.0.1/32", "dstIp" : "192.168.0.1/32", "srcPortRange" : "100-200", "dstPortRange" : "200", "fiveTupleType" : 0 } }
  • 响应示例 返回状态码为201:创建识别流模板成功后的状态返回码。 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" : "9a157da3-9e59-41c9-8312-254a38a3b275" } 返回状态码为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
  • 响应参数 返回状态码为201:创建识别流模板成功后的状态返回码。 表4 ResultCommonOut对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "Success" id string 1~128个字符。 - 模板ID "9a157da3-9e59-41c9-8312-254a38a3b275" 返回状态码为400:接口更新失败后的状态返回码。 详细信息请参见实际响应消息体。 返回状态码为500:接口发生内部错误后的状态返回码。 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 streamProfileInput 否 REFERENCE 详细请参见表2。 设置识别流模板 - 表2 StreamProfileInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~256个字符。 - 模板名称 "test" description 否 string 0~512个字符。 - 模板描述 "五元组模板" fiveTuple 否 REFERENCE 详细请参见表3。 五元组信息 - 表3 FiveTupleProfileData对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 protocol 否 string 0~4个字符。 - 协议号, TCP/UDP,或者协议号7 "TCP" srcIp 否 string 0~128个字符。 - 源IP "192.168.0.1/32" dstIp 否 string 0~128个字符。 - 目的IP "192.168.0.1/32" srcPortRange 否 string 0~11个字符。 - 源端口范围 "100-200" dstPortRange 否 string 0~11个字符。 - 源端口范围 "200" fiveTupleType 否 int32 - - 0-动态五元组 1-静态五元组 0
  • 响应示例 返回状态码为200:创建成功,响应体参考PingConfigResponse。 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 { "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,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:创建成功,响应体参考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:内部异常。 详细信息请参见实际响应消息体。
  • 请求参数 表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个字符。 - 虚拟网络名称,预留字段,暂不支持。 -
  • 请求示例 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" : "" }
  • 响应示例 返回状态码为200:更新内联链路成功,响应体参考InterLinkResponse。 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", "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,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" : "Success" }
  • 请求示例 HTTP的示例 POST /v1/performanceservice/identify/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 { "ids" : ["9a157da3-9e59-41c9-8312-254a38a3b275"] }
  • 请求示例 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 } } ] }
  • 响应示例 返回状态码为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-static-routing-ipv4:static-routing-ipv4 表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的示例 PATCH /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" { "huawei-nce-e-static-routing-ipv4:static-routing-ipv4" : { "destination-prefix" : "10.1.1.0/24", "vpn-instance" : "vpn1", "next-hop-type" : "Ip", "next-hop-addresses" : [ { "address" : "10.1.1.1", "preference" : 10, "track-setting" : "nqa", "nqa" : "test", "bfd-enable" : true } ], "next-hop-interfaces" : [ { "interface" : "GE0/0/1", "preference" : 10, "dhcp-enable" : true, "track-setting" : "nqa", "nqa" : "test" } ], "next-hop-interface-addresses" : [ { "address" : "10.1.1.1", "interface" : "GE0/0/1", "preference" : 10, "track-setting" : "nqa", "nqa" : "test", "bfd-enable" : true } ] } }
共100000条