华为云用户手册

响应参数 返回状态码为200：操作成功。 表4 QueryLswSourceIpOutDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" pageIndex int32 [1-500] - 页码。 1 pageSize int32 [5-100] - 页面条数。 10 totalRecords int32 [0-5000] - 总条数。 10 data REFERENCE 详细请参见表5。 - - 表5 LswSourceIpDtoByPage对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 LswSourceIpDtoList ARRAY_REFERENCE 0-5000个列表项，详细请参见表5。 交换机source-ip分页配置实体信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为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" : "", "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 10, "data" : { "LswSourceIpDtoList" : [ { "devId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "devName" : "S5735-L48P4X-A", "esn" : "21980109442SL4600798", "sourceIp" : "10.20.0.0" } ] } } 返回状态码为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

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 requestBody 是 REFERENCE 详细请参见表3。 查询交换机源IP配置的参数 - 表3 QueryLswSourceIpByPage对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-500] 1 当前页码。 20 pageSize 否 int32 [5-100] 10 分页大小。 20 queryValue 否 string 0~64个字符。 - 查询关键字，当前支持查询deviceName、esn。 "dev1" sortField 否 string 0~64个字符。 - 排序关键字，当前支持name、esn。通过'-'、'+'控制升序降序排列。 "-name"

请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-direct-route-vlink:vlink-if/GE0%2F0%2F3 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：操作成功。 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-direct-route-vlink:vlink-if" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "if-name" : "GE0/0/3", "vlink-route" : [ { "address-family" : "ipv4uni" } ], "vlink-configuration" : { "preference" : 233 } } ] } 返回状态码为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-direct-route-vlink:vlink-if/{if-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" if-name 是 string 1~63个字符。 - interface name "GE0/0/3"

响应参数 返回状态码为200：删除AP子网配置成功，响应体参考DeleteApSubnetResponseDto。 表4 DeleteApSubnetResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 删除AP子网成功列表，结构体参见BaseInfo。 - fail ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 删除AP子网失败列表，结构体参见BaseInfo。 - 表5 BaseInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 32个字符。 - 子网id。 "e4d2b0e95bb94ef0a75b6a530d0b41be" name string 1~32个字符。 - 子网名称。 "subnet" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务错误 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：删除AP子网配置成功，响应体参考DeleteApSubnetResponseDto。 { "errcode": "0", "errmsg": "", "success": [ { "id": "e4d2b0e95bb94ef0a75b6a530d0b41be", "name": "subnet" } ] } 返回状态码为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/lanwan/vn?vnId=a99f794e-b510-438c-a75d-de59f02347eb 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：查询成功返回。 表2 QueryVnResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-300个列表项，详细请参见表4。 VN信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为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" : "vn1", "vpnInstanceName" : "vpn1", "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ], "ipsecEncryption" : true, "overlayHeadLength" : 36, "enableIPv6" : true, "description" : "vn", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6" } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应示例 返回状态码为200：删除成功。响应体参考DeleteUserRoleResponseDto。 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 { "errmsg" : "", "errcode" : "", "successList" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"], "failList" : [ { "errmsg" : "", "errcode" : "0", "roleId" : "e87c9b41-087f-411a-b8bd-274b32d0546e" } ] } 返回状态码为400：校验错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /controller/campus/v2/accountservice/userrole/role/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 { "roleIdList" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"] }

响应参数 返回状态码为200：配置成功，响应体参考ReflectorConfigResponse。 表3 ReflectorConfigResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表4。 反射端配置响应结果 - 表4 ReflectorConfigOutPut对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId uuid - - 设备ID，UUID格式。 "00000000-0000-0000-0000-000000000000" interfaceName string 0~50个字符。 - 接口名称。 "GigabitEthernet0/0/1" srcPort int16 [1-65534] 49187 源端口。默认值49187。 49187 destPort int16 [1-65534] 7 目的端口。默认值7。 7 status int32 - - 状态。 0 表示开，1 表示关。 1 updateTime int64 - - 最近操作时间 1629947096000 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/interface/reflector 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", "srcPort" : 49187, "destPort" : 7 }

响应示例 返回状态码为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

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 reflectorConfig 是 REFERENCE 详细请参见表2。 反射端配置信息。 - 表2 ReflectorConfigInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 uuid - - 设备ID，UUID格式。 "00000000-0000-0000-0000-000000000000" interfaceName 是 string 0~50个字符。 - 接口名称。 "GigabitEthernet0/0/1" srcPort 是 int16 [1-65534] 49187 源端口。默认值49187。 49187 destPort 是 int16 [1-65534] 7 目的端口。默认值7。 7

响应示例 返回状态码为200：移除堆叠成员成功，响应体参考DeleteStackMemberOut。 返回状态码为400：校验异常，无响应体 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部服务错误，无响应体 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /controller/campus/baseservice/api/v1/device/stack/member/action/batch-delete?stackId=d25de9be-1d9a-4d06-a519-09ff92fee050 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 { "memberIds" : ["d25de9be-1d9a-4d06-a519-09ff92fee050","d25de9be-1d9a-4d06-a519-09ff92fee050"] }

响应示例 返回状态码为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

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-queue-template:port-queue-template HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy restconf-transaction-id: "00000000-0000-0000-0000-000000000000" { "huawei-nce-e-queue-template:port-queue-template" : [ { "config-status" : "reserved", "last-committed-time" : "last-committed-time", "related-pkg-version" : "related-pkg-version", "edit-state" : "RUNNING", "name" : "Port Queue Template", "queue" : [ { "service-class" : "be", "port-wred-name" : "Port wred name", "queue-schedule-mode" : "pq", "weight" : 10, "pbs" : 65534, "low-latency" : "enable", "shaping-value" : 64, "shaping-percentage" : 10, "cir-schedule-mode" : "pq", "pir-schedule-mode" : "pq", "pir-weight" : 10, "cbs" : 65534, "pir-pbs" : 65534, "cir-value" : 10, "pir-value" : 10, "cir-percentage" : 10, "pir-percentage" : 10 } ] } ] }

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-queue-template:port-queue-template 是 REFERENCE 详细请参见表4。 端口队列模板。 - 表4 nes-ne-port-queue-template-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-queue-template:port-queue-template 否 ARRAY_REFERENCE 详细请参见表5。 端口队列模板。 - 表5 nes-ne-port-queue-template对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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]*)。 - 名称，单一主键字段。 "Port Queue Template" queue 否 ARRAY_REFERENCE 0-8个列表项，详细请参见表6。 端口队列。 - 表6 nes-ne-port-queue-template-queue对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 service-class 否 string be af1 af2 af3 af4 ef cs6 cs7 - 服务等级，单一主键字段。 "be" port-wred-name 否 string 1~31个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - WRED模板。 "Port wred name" queue-schedule-mode 否 string pq wfq lpq - 队列调度模式。 "pq" weight 否 int32 [1-100] - 权重。 10 pbs 否 int64 [1-65535] - 峰值突发尺寸（Byte）。 65534 low-latency 否 string enable - 低时延。 "enable" shaping-value 否 int64 [0-4294967294] - 整形值。 64 shaping-percentage 否 int32 [0-100] - 整形百分比。 10 cir-schedule-mode 否 string pq - 承诺调度模式。 "pq" pir-schedule-mode 否 string pq wfq lpq - 峰值调度模式。 "pq" pir-weight 否 int32 [1-100] - 峰值权重。 10 cbs 否 int64 [1-65535] - 承诺突发尺寸。 65534 pir-pbs 否 int64 [1-65535] - 峰值速率-峰值突发尺寸。 65534 cir-value 否 int64 [0-4294967294] - 承诺速率。 10 pir-value 否 int64 [0-4294967294] - 峰值速率。 10 cir-percentage 否 int32 [0-100] - 承诺百分比。 10 pir-percentage 否 int32 [0-100] - 峰值百分比。 10

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-queue-template:port-queue-template 表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：查询成功。 表2 SSHFirstEnableResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码：当没有错误时返回0。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表3。 - - 表3 SSHFirstEnableDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 sshFirstTimeEnable boolean true false false 用于标识SSH客户端首次认证免公钥开关是否打开。默认值为false。 true sshPnfFirstTimeEnable boolean true false true 用于标识pnf设备SSH客户端首次认证免公钥开关是否打开。默认值为true。 true

请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/ssh/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/sshfirstenable 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：查询成功。 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" : { "sshFirstTimeEnable" : true, "sshPnfFirstTimeEnable" : true } }

URI /controller/campus/v1/networkservice/networkconfig/net/ssh/sites/{siteId}/sshfirstenable 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

请求示例 HTTP的示例 GET /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

响应示例 返回状态码为200：查询tacacs服务器模板信息返回体数据结构。 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：删除成功，响应体参考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" : "" } 返回状态码为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