华为云用户手册

  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-queue-template:flow-queue-template/{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]*)。 - 流队列模板名称,单一主键字段。 "FlowQueueTemplate"
  • 请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-queue-template:flow-queue-template/FlowQueueTemplate 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000"
  • 响应示例 返回状态码为200:查询返回的ACL模板信息。 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, "data" : [ { "id" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "name" : "ACLTemplate1", "aclNumber" : "3001", "description" : "ACLTemplate1", "aclType" : "Advanced", "ruleList" : [ { "ruleId" : "1", "ip" : "", "domain" : "", "policy" : "permit", "protocol" : "tcp", "tcpFlag" : "ack,fin", "srcIp" : "192.168.1.0/24", "srcPort" : "23", "dstIp" : "192.168.2.0/24", "dstPort" : "24", "dscp" : 2, "description" : "Rule1" } ], "ipType" : "ipv4" } ] } 返回状态码为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
  • 响应参数 返回状态码为200:查询返回的ACL模板信息。 表2 QueryAclRet对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 查询匹配到的ACL模板总数。 1 data ARRAY_REFERENCE 0-100个列表项,详细请参见表5。 返回的ACL模板记录信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v3/profile/acl?ipType=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
  • 请求示例 HTTP的示例 POST /controller/campus/v1/accesscfg/device/authdevice/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" : ["5c37d9e8-cdf6-11e8-a4fc-286ed488df6b"] }
  • 响应示例 返回状态码为200:删除成功,响应体参考ApiBatchDeleteDto。 HTTP/1.1 200 OK Date: Tue,16 Aug 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode": "0", "errmsg": "", "success": [ "ba3490cb-efba-457d-96a6-320f30ffa7f7" ], "failure": [ { "errcode": "0x00c80006", "errmsg": "The device does not exist.", "id": "8a660b9c-a198-4b67-ae0d-4d1430847df1" } ] "errcode" : "0", "errmsg" : "", "data" : { "name" : "device", "description" : "this is device", "ip" : "10.254.254.254", "backupIp" : "10.254.254.253", "deviceGroupId" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b", "series" : "Huawei NAC", "enableRadius" : true, "radiusParam" : { "accountingKey" : "******", "authenKey" : "******", "coaPort" : 1700, "accountingPeriod" : 5, "macPwdEnable" : false, "macAuthPwd" : "******", "radiusServiceTypeEnable" : false, "radiusServiceTypeDevice" : 8, "radiusServiceTypeTerminal" : 4 }, "enablePortal" : true, "portalParam" : { "protol" : "CMCC Portal", "portalKey" : "******", "urlKey" : "******", "stations" : ["10.254.254.254"], "enableUserSync" : false, "port" : 80, "portalServiceTypeEnable" : true, "portalServiceTypeTerminal" : 4 }, "enableTacacs" : true, "tacacsParam" : { "key" : "******" }, "id" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b" } } 返回状态码为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
  • 响应示例 返回状态码为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-traffic-behavior:traffic-behavior" : [ { "config-status" : "reserved", "last-committed-time" : "last-committed-time", "related-pkg-version" : "related-pkg-version", "edit-state" : "RUNNING", "name" : "Traffic Behavior", "description" : "Description", "filter-action" : { "filter" : "permit" }, "remark-action-colors" : { "remark-action-color" : [ { "remark-type" : "8021p", "remark-value" : 254 } ] }, "remark-actions" : { "remark-action" : [ { "action-type" : "8021p", "remark-value" : 254, "after-trust" : "enable" } ] }, "set-te-classes" : { "class-id" : 1 }, "service-class-actions" : { "service-class-action" : [ { "action-type" : "service-class", "service-class" : "be", "color" : "green", "remark-switch" : "enable", "bfd-session-name" : "BFD Session Name" } ] }, "statistic-action" : { "statistic-enable" : "Statistic enable" }, "car-actions" : { "car-action" : [ { "action-type" : "car", "cir" : 4294967294, "pir" : 4294967294, "cbs" : 4294967294, "pbs" : 4294967294, "adjust" : 10, "green-action" : "pass", "green-container" : { "green-service-class" : "be", "green-color" : "green", "green-remark-dscp" : 62 }, "yellow-action" : "pass", "yellow-container" : { "yellow-service-class" : "be", "yellow-color" : "yellow", "yellow-remark-dscp" : 62 }, "red-action" : "pass", "red-container" : { "red-service-class" : "be", "red-color" : "red", "red-remark-dscp" : 62 }, "color-aware" : "enable", "limit-type" : "pps", "share-mode" : "enable" } ] }, "pbr" : { "pbr-ipv4" : { "redirect-tunnel" : { "tunnel-name" : "Tunnel Name" }, "ipv4-nexthops" : { "nexthop-addresses" : { "nexthop-address" : [ { "ip-address" : "10.1.0.0" } ] } }, "redirect-srv6-te-policy" : { "endpoint" : "Endpoint IPv6", "color" : 4294967294, "sid-type" : "sid", "sid-ip" : "Sid IP" }, "ipv4-nexthop" : { "nexthop-address" : "10.1.0.0", "none" : { "deny" : false }, "interface" : { "if-name" : "Interface Name" } } }, "pbr-ipv6" : { "ipv6-nexthops" : { "nexthop-addresses" : { "nexthop-address" : [ { "ipv6-address" : "fc00::/7" } ] } }, "ipv6-nexthop" : { "nexthop-address" : "fc00::/7", "none" : { "deny" : false }, "interface" : { "if-name" : "Interface Name" } } } }, "flow-queue-action" : { "flow-queue-name" : "name1", "queue-name" : "name2" }, "qos-profile-action" : { "qos-profile-name" : "name1", "user-queue-name" : "name2" } } ] } 返回状态码为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:操作成功。 表3 traffic-behavior-list对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-traffic-behavior:traffic-behavior ARRAY_REFERENCE 详细请参见表4。 流行为配置。 - 表4 nes-ne-traffic-behavior对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 config-status string reserved initial configuring-database configured-database-success configured-database-failed configuring-device configured-device-success configured-device-failed reserved 配置状态,对应保留未用状态、初始状态、数据库存储中状态、预配置状态、数据库存储失败状态、部署中状态、成功状态、失败状态;不支持编辑,仅查询返回。 "reserved" last-committed-time string 0~255个字符。 - 最后提交时间,该特性最后提交时间;不支持编辑,仅查询返回。 "last-committed-time" related-pkg-version string 0~255个字符。 - 包版本,插件包版本;不支持编辑,仅查询返回。 "related-pkg-version" edit-state string RUNNING CANDIDATE UNDEPLOYING UNDEPLOYED - 编辑状态,对应运行状态、候选状态、取消部署状态、未部署状态;不支持编辑,仅查询返回。 "RUNNING" name string 1~31个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - 名称,单一主键字段。 "Traffic Behavior" description string 1~127个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - 描述。AR6700V主设备,AR6700V子设备和AR6700V-L款型不支持。 "Description" filter-action REFERENCE 详细请参见表5。 过滤动作。AR6700V主设备和AR6700V子设备不支持。 - remark-action-colors REFERENCE 详细请参见表6。 重标记颜色。 - remark-actions REFERENCE 详细请参见表8。 重标记。AR6700V主设备,AR6700V子设备和AR6700V-L款型不支持。 - set-te-classes REFERENCE 详细请参见表10。 TE Class。AR6700V主设备和AR6700V子设备不支持。 - service-class-actions REFERENCE 详细请参见表11。 服务等级。AR6700V主设备,AR6700V子设备和AR6700V-L款型不支持。 - statistic-action REFERENCE 详细请参见表13。 统计。 - car-actions REFERENCE 详细请参见表14。 流量监管。 - pbr REFERENCE 详细请参见表19。 重定向。AR6700V主设备和AR6700V子设备不支持。 - flow-queue-action REFERENCE 详细请参见表36。 流队列行为。 - qos-profile-action REFERENCE 详细请参见表37。 QoS模板行为。 - 表5 filter-action对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 filter string permit deny permit 类型。 "permit" 表6 remark-action-colors对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 remark-action-color ARRAY_REFERENCE 详细请参见表7。 重标记颜色。 - 表7 remark-action-colors-remark-action-color对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 remark-type string 8021p dscp qos-local-precedence mpls-exp - 标记类型,单一主键字段。 "8021p" remark-value int32 [0-255] - 值。 254 表8 remark-actions对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 remark-action ARRAY_REFERENCE 0-8个列表项,详细请参见表9。 重标记。 - 表9 remark-actions-remark-action对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 action-type string 8021p ipv4-dscp tos ipv6-dscp ip-precedence - 操作类型,单一主键字段。 "8021p" remark-value int64 [0-255] - 标记值。 254 after-trust string enable - 在简单流后重新标记VLAN报文的802.1p值。 "enable" 表10 set-te-classes对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 class-id int32 [1-65535] - Class ID。 1 表11 service-class-actions对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 service-class-action ARRAY_REFERENCE 0-3个列表项,详细请参见表12。 指定服务等级与颜色。 - 表12 service-class-actions-service-class-action对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 action-type string service-class service-class-master-bfd service-class-slave-bfd - 动作类型,单一主键字段。 "service-class" service-class string be af1 af2 af3 af4 ef cs6 cs7 - 服务等级。 "be" color string green yellow red - 颜色。 "green" remark-switch string enable disable enable 标记开关。 "enable" bfd-session-name string 1~64个字符。满足正则表达([^\s?]+[\s]*[^?]*[^\s?]+|[^\s?]*)。 - BFD 会话名称。 "BFD Session Name" 表13 statistic-action对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 statistic-enable string - - 使能统计。 "Statistic enable" 表14 car-actions对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 car-action ARRAY_REFERENCE 详细请参见表15。 流量监管。 - 表15 car-actions-car-action对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 action-type string car - 监管类型,单一主键字段。 "car" cir int64 [0-4294967295] - 承诺速率。 4294967294 pir int64 [0-4294967295] - 峰值速率。 4294967294 cbs int64 [0-4294967295] - 承诺突发尺寸。 4294967294 pbs int64 [0-4294967295] - 峰值突发尺寸。 4294967294 adjust int32 - - 调整。AR6700V主设备,AR6700V子设备和AR6700V-L款型不支持。需满足:-32..-1 | 1..31. 10 green-action string pass discard - 绿色报文行为。 "pass" green-container REFERENCE 详细请参见表16。 绿色报文的行为参数。AR6700V主设备和AR6700V子设备不支持。 - yellow-action string pass discard - 黄色报文行为。 "pass" yellow-container REFERENCE 详细请参见表17。 黄色报文的行为参数。AR6700V主设备和AR6700V子设备不支持。 - red-action string pass discard - 红色报文行为。 "pass" red-container REFERENCE 详细请参见表18。 红色报文的行为参数。AR6700V主设备和AR6700V子设备不支持。 - color-aware string enable - 色敏模式。 "enable" limit-type string pps - 限制类型。AR6700V主设备,AR6700V子设备和AR6700V-L款型不支持。 "pps" share-mode string enable - 共享模式。 "enable" 表16 green-container对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 green-service-class string be af1 af2 af3 af4 ef cs6 cs7 - 绿色报文服务等级。 "be" green-color string green yellow red - 绿色报文重新定义的颜色。 "green" green-remark-dscp int32 [0-63] - 绿色报文的DHCP优先级。AR6700V-L款型不支持。 62 表17 yellow-container对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 yellow-service-class string be af1 af2 af3 af4 ef cs6 cs7 - 黄色报文服务等级。 "be" yellow-color string green yellow red - 黄色报文重新定义的颜色。 "yellow" yellow-remark-dscp int32 [0-63] - 黄色报文的DHCP优先级。AR6700V-L款型不支持。 62 表18 red-container对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 red-service-class string be af1 af2 af3 af4 ef cs6 cs7 - 红色报文服务等级。 "be" red-color string green yellow red - 红色报文重新定义的颜色。 "red" red-remark-dscp int32 [0-63] - 红色报文的DHCP优先级。AR6700V-L款型不支持。 62 表19 pbr对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pbr-ipv4 REFERENCE 详细请参见表20。 重定向IPv4。 - pbr-ipv6 REFERENCE 详细请参见表29。 重定向IPv6。 - 表20 pbr-ipv4对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 redirect-tunnel REFERENCE 详细请参见表21。 重定向隧道。 - ipv4-nexthops REFERENCE 详细请参见表22。 IPv4多下一跳。 - redirect-srv6-te-policy REFERENCE 详细请参见表25。 重定向策略。 - ipv4-nexthop REFERENCE 详细请参见表26。 IPv4下一跳。 - 表21 redirect-tunnel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 tunnel-name string 1~63个字符。 - 隧道名称。 "Tunnel Name" 表22 ipv4-nexthops对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nexthop-addresses REFERENCE 详细请参见表23。 下一跳地址。 - 表23 ipv4-nexthops-nexthop-addresses对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nexthop-address ARRAY_REFERENCE 0-16个列表项,详细请参见表24。 下一跳地址。 - 表24 nexthop-addresses-nexthop-address对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ip-address 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}]+)?。 - IP地址,单一主键字段。 "10.1.0.0" 表25 redirect-srv6-te-policy对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 endpoint string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - 端点IPv6地址。 "Endpoint IPv6" color int64 [0-4294967295] - 颜色。 4294967294 sid-type string sid vpnsid - Sid类型。 "sid" sid-ip string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - Sid IPv6地址。 "Sid IP" 表26 ipv4-nexthop对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nexthop-address 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.0.0" none REFERENCE 详细请参见表27。 无接口。 - interface REFERENCE 详细请参见表28。 重定向接口。 - 表27 ipv4-nexthop-none对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deny boolean true false false 阻断。 false 表28 ipv4-nexthop-interface对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 if-name string 1~63个字符。 - 接口名称。 "Interface Name" 表29 pbr-ipv6对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ipv6-nexthops REFERENCE 详细请参见表30。 IPv6多下一跳。 - ipv6-nexthop REFERENCE 详细请参见表33。 IPv6下一跳。 - 表30 ipv6-nexthops对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nexthop-addresses REFERENCE 详细请参见表31。 下一跳地址。 - 表31 ipv6-nexthops-nexthop-addresses对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nexthop-address ARRAY_REFERENCE 0-16个列表项,详细请参见表32。 下一跳地址。 - 表32 nexthops-nexthop-addresses-nexthop-address对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ipv6-address string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - IPv6地址,单一主键字段。 "fc00::/7" 表33 ipv6-nexthop对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nexthop-address string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - 下一跳地址。 "fc00::/7" none REFERENCE 详细请参见表34。 无接口。 - interface REFERENCE 详细请参见表35。 重定向接口。 - 表34 ipv6-nexthop-none对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deny boolean true false false 阻断。 false 表35 ipv6-nexthop-interface对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 if-name string 1~63个字符。 - 接口名称。 "Interface Name" 表36 flow-queue-action对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 flow-queue-name string 1~31个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - 流队列名称。 "name1" queue-name string 1~31个字符。 - 流行为队列名称。 "name2" 表37 qos-profile-action对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 qos-profile-name string 1~63个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - QoS模板名称。 "name1" user-queue-name string 1~31个字符。 - 用户队列名称。 "name2" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-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"
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-traffic-behavior:traffic-behavior 表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"
  • URI /controller/campus/v1/sdwan/policy/traffic/internet/{vpnId}/centralized-access 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 uuid - - VPN ID。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 areaId 否 uuid - - Area ID。 不填表示查询全局集中上网信息; 填写areaId表明查询指定区域的集中上网信息。 "00000000-0000-0000-0000-000000000000"
  • 响应示例 返回状态码为200:查询成功,响应体参考CentralizedAccessResponse。 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" : { "areaId" : "00000000-0000-0000-0000-000000000000", "areaName" : "area_1", "description" : "centralized access", "centralizedSiteInfos" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "priority" : "1" } ], "enableIpv6" : false }, "processInstanceId" : "" } 返回状态码为400:请求参数错误,无响应体。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部错误,无响应体。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/internet/00000000-0000-0000-0000-000000000000/centralized-access?areaId=00000000-0000-0000-0000-000000000000 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
  • 请求示例 HTTP的示例 GET /controller/campus/ui/v1/sdwan/lan/wlans?site_id=00000000-0000-0000-0000-000000000000&vpn_id=00000000-0000-0000-0000-000000000000 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/ui/v1/sdwan/lan/wlans 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 site_id 是 uuid 0~36个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" vpn_id 否 uuid 0~36个字符。 - VPN业务ID。 "00000000-0000-0000-0000-000000000000"
  • 响应示例 返回状态码为200:查询成功,查询指定站点的所有LAN子网列表。 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 { "errparams" : [ "siteId" ], "errcode" : "0", "errmsg" : "", "data" : { "Subnets" : [ { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "id" : "00000000-0000-0000-0000-000000000000", "ssid" : "接入描述。", "effectiveRadio" : "RADIO_2.4GHZ", "vlanId" : "100", "encryptionMethod" : "WPA1", "sharedKey" : "Example@123", "hideSsid" : false, "maxAccessNum" : "30", "downLinkTraffic" : "1200", "upLinkTraffic" : "1400", "enableRadioConfig" : false, "transmitPower" : "1", "countryCode" : "CN", "channelBandwidth" : "20mhz", "channel" : "1", "enableWlan" : true } ] } }
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/qos-bound/query-by-siteids 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 { "siteIds" : [ "00000000-0000-0000-0000-000000000000" ] }
  • 响应参数 返回状态码为200:查询成功,响应体参考QosSwitchInfos。 表3 QosSwitchInfos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 QosSwitchInfos ARRAY_REFERENCE 0-100个列表项,详细请参见表5。 Qos使能开关 - 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功,响应体参考QosSwitchInfos。 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 [ { "siteId" : "00000000-0000-0000-0000-000000000000", "inBoundEnable" : true, "outBoundEnable" : true } ] 返回状态码为400:请求参数错误,无响应体。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部错误,无响应体。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 disableReflectorConfig 是 REFERENCE 详细请参见表2。 去使能反射端配置信息。 - 表2 DisableReflectorConfigInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 uuid - - 设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" interfaceName 是 string 0~50个字符。 - 接口名称。 "GigabitEthernet0/0/1"
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/interface/reflector/disable 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 { "deviceId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GigabitEthernet0/0/1" }
  • 响应示例 返回状态码为200:配置成功,响应体参考ReflectorConfigResponse。 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" : { "deviceId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GigabitEthernet0/0/1", "srcPort" : 49187, "destPort" : 7, "status" : 1, "updateTime" : 1629947096000 } } 返回状态码为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:接口调用成功,响应体参考CheckOpsParamResponse。 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 { "status" : "0", "result" : "" } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/net/cloud/ops/check 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" }
  • 响应参数 返回状态码为200:接口调用成功,响应体参考CheckOpsParamResponse。 表3 CheckOpsParamResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 status string 0~10个字符。 - 检测状态。0表示成功,非0表示失败。 "0" result string 0~256个字符。 - 检测结果。 "" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 opsParam 是 REFERENCE 详细请参见表2。 OPS参数。 - 表2 CheckOpsParamDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 uuid 0~36个字符。 - 站点ID,uuid格式。必填。 "00000000-0000-0000-0000-000000000000"
  • 请求示例 HTTP的示例 POST /controller/cloud/v2/northbound/accessuser/haca/cutuser 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 { "thirdUserInfos" : [ { "deviceMac" : "XX-XX-XX-XX-XX-XX", "deviceEsn" : "21500829352SG5900059", "terminalIpV4" : "10.66.85.177", "terminalIpV6" : "FC00::1101", "terminalMac" : "XX-XX-XX-XX-XX-XX", "userName" : "test", "psessionid" : "5ea660be98a84618fa3d6d03f65f47ab578ba3b4216790186a932f9e8c8c880d", "nodeIp" : "192.168.211.236" } ] }
  • 响应参数 返回状态码为200:查询成功。响应体参考CutUserOutputDto。 表4 CutUserOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息描述。 "" success ARRAY_REFERENCE 详细请参见表5。 成功下线用户信息。 - failure ARRAY_REFERENCE 详细请参见表5。 下线失败用户信息。 - 表5 CutUserData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 message string - - 成功结果。 "success" psessionid string - - 用户会话ID, 长度1-128。 "5ea660be98a84618fa3d6d03f65f47ab578ba3b4216790186a932f9e8c8c880d" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功。响应体参考CutUserOutputDto。 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" : [ { "message" : "success", "psessionid" : "5ea660be98a84618fa3d6d03f65f47ab578ba3b4216790186a932f9e8c8c880d" } ], "failure" : [ { "message" : "success", "psessionid" : "5ea660be98a84618fa3d6d03f65f47ab578ba3b4216790186a932f9e8c8c880d" } ] } 返回状态码为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
共100000条
提示

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