华为云用户手册

  • 响应参数 返回状态码为200:查询的路由器设备静态路由配置。 表3 GetArStaticrouteResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表4。 - - 表4 ArStaticrouteInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pageIndex integer [1-65535] - 页面索引。 1 pageSize integer [1-1000] - 每页显示记录数。 20 totalRecords integer [1-65535] - 总记录数。 10 routes ARRAY_REFERENCE 0-100个列表项,详细请参见表5。 路由器设备静态路由配置信息。 - 返回状态码为400:校验失败信息。 详细信息请参见实际响应消息体。
  • URI /controller/campus/v1/networkservice/networkconfig/net/arstaticroute/devices/{deviceId}/staticroute 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备标识,UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 integer [1-65535] - 页面索引。 1 pageSize 是 integer [1-1000] - 每页显示记录数。 20
  • 响应示例 返回状态码为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" : { "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 10, "routes" : [ { "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
  • 响应参数 返回状态码为201:创建成功,响应体参考SiteQosPolicyResponse。 表3 SiteQosPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表6。 站点QoS策略详细信息 - processInstanceId string 0~36个字符。 - 编排流程实例ID,UUID格式。当接口返回码为202时非空。 - 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考SiteQosPolicyResponse。 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为201:创建成功,响应体参考SiteQosPolicyResponse。 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" : "", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "name" : "qos1", "direction" : "", "qosRules" : [ { "qosRuleId" : "00000000-0000-0000-0000-000000000000", "qosClassificationId" : "00000000-0000-0000-0000-000000000000", "qosClassificationName" : "qosClassificationName", "qosProfileId" : "00000000-0000-0000-0000-000000000000", "qosProfileName" : "templateName", "lanQosProfileId" : "00000000-0000-0000-0000-000000000000", "lanQosProfileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "qosPriority" : 1 } ], "status" : 1, "isActive" : true, "bindMode" : "siteMode" }, "processInstanceId" : "" } 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考SiteQosPolicyResponse。 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 返回状态码为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/traffic/sites/00000000-0000-0000-0000-000000000000/qos-policy 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", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "name" : "qos1", "direction" : "", "qosRules" : [ { "qosRuleId" : "00000000-0000-0000-0000-000000000000", "qosClassificationId" : "00000000-0000-0000-0000-000000000000", "qosClassificationName" : "qosClassificationName", "qosProfileId" : "00000000-0000-0000-0000-000000000000", "qosProfileName" : "templateName", "lanQosProfileId" : "00000000-0000-0000-0000-000000000000", "lanQosProfileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "qosPriority" : 1 } ], "status" : 1, "isActive" : true, "bindMode" : "siteMode" }
  • 响应示例 返回状态码为200:查询成功,响应体参考QueryVpnBandwidthPolicyResponse。 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" : "", "totalRecords" : 1, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "VpnBandwidthPolicy", "direction" : "outbound", "enableStatistic" : false, "enableFixMode" : false, "bandwidthAllocations" : [ { "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidth" : 10 } ] } ] } 返回状态码为204:执行成功,无响应体。 HTTP/1.1 204 No Content 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
  • 响应参数 返回状态码为200:查询成功,响应体参考QueryVpnBandwidthPolicyResponse。 表2 QueryVpnBandwidthPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表6。 VPN带宽分配策略信息。 - 返回状态码为204:执行成功,无响应体。 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/vpn-bandwidth-policies?id=00000000-0000-0000-0000-000000000000&policyName=policy 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:删除成功,响应体参考CommonResponse。 CommonResponse对象的参数列表,详细请参见表4。 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考Dot1xTemplateDeleteResponse。 Dot1xTemplateDeleteResponse对象的参数列表,详细请参见表5。 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/rest/sdwan/v1/device/dot1x/template/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" : ["f01f8fa3-6477-49d7-9888-3c233fe38e6f","81d04156-90eb-495d-8de5-f71f283d1af2"] }
  • 响应示例 返回状态码为200:删除成功,响应体参考CommonResponse。 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" : "" } 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考Dot1xTemplateDeleteResponse。 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" : "", "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
  • 响应示例 返回状态码为201:接口调用成功,响应体参考OspfRouteInterfaceParamResponse,返回的OSPF路由信息中仅包含对应的ID。 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" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "processId" : 501, "ipSubnets" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1, "mtuEnable" : false, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ], "transportNetworkPorts" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1, "mtuEnable" : false, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ] } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "processId" : 501, "ipSubnets" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1, "mtuEnable" : false, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ], "transportNetworkPorts" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1, "mtuEnable" : false, "networkType" : "broadcast", "cost" : 1, "drPriority" : 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
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ospfRouteInterfaceParamInfos 是 REFERENCE 详细请参见表2。 OSPF路由接口信息。 - 表2 OspfRouteInterfaceParamInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 interfaceParams 否 ARRAY_REFERENCE 1-8个列表项,详细请参见表3。 Ospf路由接口参数信息。 - 表3 OspfRouteInterfaceParamInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 对应站点ID。格式是uuid,创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId 是 uuid - - 设备ID。格式是uuid,创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId 否 uuid - - 所在VPN ID。格式是uuid,创建overlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" tnpId 否 uuid - - 所在TNP ID。格式是uuid,创建underlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" processId 是 int32 [1-65535] - 接口需要绑定的ospf进程id 501 ipSubnets 否 ARRAY_REFERENCE 0-64个列表项,详细请参见表13。 三层接口参数。创建overlay ospf时必填。 - transportNetworkPorts 否 ARRAY_REFERENCE 0-64个列表项,详细请参见表13。 TNP接口参数。创建underlay ospf时必填。 -
  • 响应参数 返回状态码为201:接口调用成功,响应体参考OspfRouteInterfaceParamResponse,返回的OSPF路由信息中仅包含对应的ID。 表4 OspfRouteInterfaceParamResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-8个列表项,详细请参见表5。 创建或者更新成功的OSPF路由全局进程信息。 - fail ARRAY_REFERENCE 0-8个列表项,详细请参见表6。 创建或者更新失败的OSPF路由全局进程信息。 - 表5 OspfRouteInterfaceParamInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 对应站点ID。格式是uuid,创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId uuid - - 设备ID。格式是uuid,创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId uuid - - 所在VPN ID。格式是uuid,创建overlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" tnpId uuid - - 所在TNP ID。格式是uuid,创建underlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" processId int32 [1-65535] - 接口需要绑定的ospf进程id 501 ipSubnets ARRAY_REFERENCE 0-64个列表项,详细请参见表25。 三层接口参数。创建overlay ospf时必填。 - transportNetworkPorts ARRAY_REFERENCE 0-64个列表项,详细请参见表25。 TNP接口参数。创建underlay ospf时必填。 - 表6 FailOspfRouteInterfaceParamInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表5。 OSPF路由接口信息 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/routing-protocol/ospf/interface-param 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 { "interfaceParams" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "processId" : 501, "ipSubnets" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1, "mtuEnable" : false, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ], "transportNetworkPorts" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1, "mtuEnable" : false, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ] } ] }
  • 请求示例 HTTP的示例 POST /controller/campus/v1/accountservice/mac/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" : ["fb9317cf-fdb6-40fe-821f-3c20fc6a63eb"] }
  • 响应示例 返回状态码为200:删除成功,响应体参考DeleteMacsOutput。 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" : "", "errorMessage" : "", "deleteNameList" : ["name"], "failList" : [ { "errcode" : "0308000221", "errmsg" : "The selected user does not exist", "id" : "51cdcbe3-5e14-492b-ab27-86950b661d19", "name" : "mac1" } ] } 返回状态码为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:修改成功,响应体参考CustomApplicationResponse。 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" : "", "processInstanceId" : "", "success" : [ { "id" : "00000000-0000-0000-0000-000000000000", "appName" : "app", "description" : "", "extendApp" : false, "appType" : "", "appGroups" : [ "00000000-0000-0000-0000-000000000000" ], "applicationGroups" : [ { "applicationGroupName" : "", "applicationGroupId" : "" } ], "applicationRules" : [ { "ruleName" : "rule", "ruleId" : "00000000-0000-0000-0000-000000000000", "description" : "tcpRule", "destinationIP" : "10.1.1.1/32", "port" : "1,2,3-20", "protocolType" : "tcp", "signatureEnable" : false, "context" : "flow", "direction" : "request", "plainString" : "abcde", "dscp" : 20, "domain" : "www.example.com", "sourceIp" : "192.168.10.5/32", "sourcePortRange" : "30-50" } ], "configId" : "00000000-0000-0000-0000-000000000000" } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "appName" : "app", "description" : "", "extendApp" : false, "appType" : "", "appGroups" : [ "00000000-0000-0000-0000-000000000000" ], "applicationGroups" : [ { "applicationGroupName" : "", "applicationGroupId" : "" } ], "applicationRules" : [ { "ruleName" : "rule", "ruleId" : "00000000-0000-0000-0000-000000000000", "description" : "tcpRule", "destinationIP" : "10.1.1.1/32", "port" : "1,2,3-20", "protocolType" : "tcp", "signatureEnable" : false, "context" : "flow", "direction" : "request", "plainString" : "abcde", "dscp" : 20, "domain" : "www.example.com", "sourceIp" : "192.168.10.5/32", "sourcePortRange" : "30-50" } ], "configId" : "00000000-0000-0000-0000-000000000000" } } ] } 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考CustomApplicationResponse。 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 返回状态码为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:修改成功,响应体参考CustomApplicationResponse。 CustomApplicationResponse对象的参数列表,详细请参见表6。 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考CustomApplicationResponse。 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/application/custom-applications 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 { "customApplications" : [ { "id" : "00000000-0000-0000-0000-000000000000", "appName" : "app", "description" : "", "extendApp" : false, "appType" : "", "appGroups" : [ "00000000-0000-0000-0000-000000000000" ], "applicationGroups" : [ { "applicationGroupName" : "", "applicationGroupId" : "" } ], "applicationRules" : [ { "ruleName" : "rule", "ruleId" : "00000000-0000-0000-0000-000000000000", "description" : "tcpRule", "destinationIP" : "10.1.1.1/32", "port" : "1,2,3-20", "protocolType" : "tcp", "signatureEnable" : false, "context" : "flow", "direction" : "request", "plainString" : "abcde", "dscp" : 20, "domain" : "www.example.com", "sourceIp" : "192.168.10.5/32", "sourcePortRange" : "30-50" } ], "configId" : "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-arp:arp" : { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "static-arp" : [ { "ip-addr" : "10.1.1.1", "vpn-instance" : "_public_", "mac-addr" : "xxxx-xxxx-xxxx", "vxlan-id" : 233, "source-addr" : "10.1.1.2", "peer-addr" : "10.1.1.3" } ], "speed-limit" : [ { "slot-id" : "23", "suppress-type" : "arp", "ip-type" : "dest-ip", "suppress-value" : 2333 } ] } } 返回状态码为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-arp:arp 表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"
  • 响应参数 返回状态码为200:操作成功。 表3 arp-info对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-arp:arp REFERENCE 详细请参见表4。 ARP配置。 - 表4 arp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 config-status string reserved initial configuring-database configured-database-success configured-database-failed configuring-device configured-device-success configured-device-failed reserved 配置状态,对应保留未用状态、初始状态、数据库存储中状态、预配置状态、数据库存储失败状态、部署中状态、成功状态、失败状态;不支持编辑,仅查询返回。 "configured-database-success" last-committed-time string 0~255个字符。 - 最后提交时间,该特性最后提交时间;不支持编辑,仅查询返回。 "2022-01-01 00:00:00" related-pkg-version string 0~255个字符。 - 包版本,插件包版本;不支持编辑,仅查询返回。 "1.0.1" edit-state string RUNNING CANDIDATE UNDEPLOYING UNDEPLOYED - 编辑状态,对应运行状态、候选状态、取消部署状态、未部署状态;不支持编辑,仅查询返回。 "RUNNING" static-arp ARRAY_REFERENCE 详细请参见表5。 静态ARP。 - speed-limit ARRAY_REFERENCE 详细请参见表6。 配置接口板抑制ARP消息的时间戳抑制速率。 - 表5 arp-static-arp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ip-addr string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - IPv4地址,联合主键字段。 "10.1.1.1" vpn-instance string 1~31个字符。 _public_ VPN实例,联合主键字段。 "_public_" mac-addr string 0~255个字符。满足正则表达[0-9a-f]{4}(-[0-9a-f]{4}){2}。 - MAC地址。 "xxxx-xxxx-xxxx" vxlan-id int64 [1-16777215] - VxLAN ID。 233 source-addr string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - 本端地址。 "10.1.1.2" peer-addr string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - 对端地址。 "10.1.1.3" 表6 arp-speed-limit对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 slot-id string 1~24个字符。 - 槽位号,联合主键字段。 "23" suppress-type string arp arp-miss - 抑制类型,联合主键字段。 "arp" ip-type string dest-ip src-ip - IP类型,联合主键字段。 "dest-ip" suppress-value int64 [0-65536] - 限速值。 2333 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-arp:arp 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"
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/globalparam/tenant/1d27faea37f3410992e98c9761b25b9d/cliauth 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 { "cliAuthEnable" : "true" }
  • 响应示例 返回状态码为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" : { "cliAuthEnable" : "true" } }
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 设备本地CLI配置授权信息。 - 表3 CliAuthInfoDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 cliAuthEnable 是 boolean true false true 设备本地CLI配置授权开关。默认值为true。 "true"
  • URI /controller/campus/v1/networkservice/networkconfig/net/globalparam/tenant/{tenantId}/cliauth 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 tenantId 是 string - - 租户ID。 "1d27faea37f3410992e98c9761b25b9d"
  • 响应参数 返回状态码为200:查询成功,响应体参考QueryDeviceVTYResponse。 表2 QueryDeviceVTYResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data ARRAY_REFERENCE 0-2000个列表项,详细请参见表4。 - - pageIndex int32 [1-10000] - 当前页。 1 pageSize int32 [1-10000] - 页大小。 10 totalRecords int32 [1-100000] - 总记录数。 100 返回状态码为400:请求参数错误,响应体参考CommonResponse。 CommonResponse对象的参数列表,详细请参见表5。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
共100000条
提示

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