华为云用户手册

响应参数 返回状态码为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,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" : [ { "name" : "vn1", "vpnInstanceName" : "vpn1", "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUC CES S", "errMsg" : "" } ], "ipsecEncryption" : true, "overlayHeadLength" : 36, "enableIPv6" : true, "description" : "vn", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6" } ] } 返回状态码为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/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：配置成功，响应体参考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：内部异常。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：配置成功，响应体参考ReflectorConfigResponse。 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" : { "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,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的示例 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 }

请求参数 表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,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的示例 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：查询成功。 表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

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

请求示例 HTTP的示例 DELETE /controller/campus/v1/sdwan/netstream/global/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

响应参数 返回状态码为200：删除成功，响应体参考CommonResponse。 表2 CommonResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string 0~10个字符。 - 错误码。 "0" errMsg string 0~255个字符。 - 错误描述。 "" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：删除成功，响应体参考CommonResponse。 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" : "" } 返回状态码为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/v1/sdwan/policy/traffic/vpn-qosgroup/unconfiged/vpn?policyFilter=false 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：查询成功，响应体参考VpnInfoResponse。 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" : "", "totalRecords" : 1, "pageSize" : 10, "pageIndex" : 1, "vpnList" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "VPN1" } ] } 返回状态码为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：光口资源查询成功。 HTTP/1.1 200 OK Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "code" : 0, "data" : [ { "name" : "XGigabitEthernet0/0/1", "adminstatus" : "1", "operstatus" : "1", "ipaddress" : "10.x.x.x", "ipnetmask" : "0.0.0.0", "portindex" : "70664270" } ], "pageSize" : 1, "totalSize" : 100, "description" : "查询成功。" } 返回状态码为400：参数错误。 HTTP/1.1 400 Bad Request Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为404：rest接口没找到。 HTTP/1.1 404 Not Found Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：默认ServiceException异常码，应用内部错误。 HTTP/1.1 500 Internal Server Error Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

URI /rest/openapi/network/otpoint 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nedn 否 string 1~100个字符。 - 设备DN。 "047f72d1-7ad3-11e9-b906-000c29b01448" start 否 integer - 0 指定从哪个起始记录位置开始返回查询结果集。缺省值是0。说明：如果值小于0，将使用缺省值。 0 size 否 integer - 20 指定返回查询结果集总数，支持1～100条，缺省值是20。说明：如果值小于1或大于100时，将使用缺省值。 20 fields 否 string - - 指定查询结果所包含的列。需要查询的列名为fields参数的值，多个列名时可用英文逗号隔开。 说明： 此请求参数只有指定了fields请求参数后才有效，不指定默认返回所有字段。包含字段name, adminstatus, operstatus, ipaddress, ipnetmask, portindex "name"

请求示例 cURL的示例 curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88bybuqp7xmlup9htd5gpg4bmmrufvnt4aan' 'https://192.168.1.125:18002/rest/openapi/network/otpoint?nedn=047f72d1-7ad3-11e9-b906-000c29b01448&start=0&size=20&fields=name' HTTP的示例 GET /rest/openapi/network/otpoint?nedn=047f72d1-7ad3-11e9-b906-000c29b01448&start=0&size=20&fields=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-rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88bybuqp7xmlup9htd5gpg4bmmrufvnt4aan

响应参数 返回状态码为200：光口资源查询成功。 表2 OTPointResResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 code int32 - 0 操作返回码。可以是如下值之一： 0：成功 非0：失败 0 data ARRAY_REFERENCE 详细请参见表3。 - - pageSize integer - - 记录总页数。 1 totalSize integer - - 记录总数。 100 description string - - 描述信息。 "查询成功。" 表3 OTPointResData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string - - 光口名称。 "XGigabitEthernet0/0/1" adminstatus string - - 光口管理状态，可以是如下值之一： 1：up 2：down 3：planning "1" operstatus string - - 光口操作状态，可以是如下值之一： 1：up 2：down 3：testing 4：unknown 5：dormant 6：notPresent 7：lowerLayerDown "1" ipaddress string - - 光口IP地址。 "10.x.x.x" ipnetmask string - - 光口子网掩码。 "0.0.0.0" portindex string - - 光口索引。 "70664270" 返回状态码为400：参数错误。 详细信息请参见实际响应消息体。 返回状态码为404：rest接口没找到。 详细信息请参见实际响应消息体。 返回状态码为500：默认ServiceException异常码，应用内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为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" : { "authType" : "default", "profileId" : "aeb684c8-0d37-496f-bafa-4b06d5151e2e", "cmdEnable" : true, "authProtocol" : "", "authenticationEnable" : false, "authorizationEnable" : false, "accountingEnable" : false } } 返回状态码为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

响应参数 返回状态码为200：查询成功，返回配置信息。 表2 GetDeviceMgrAuthConfigResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表3。 - - 表3 DeviceMgrAuthServerInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 authType string default tacacs radius - 设备管理认证方式。取值范围：default---默认、tacacs---HWTACA CS 认证、radius---RADIUS认证。 "default" profileId string 36个字符。 - 设备管理认证服务器模板ID。字符串为UUID格式。当authType为tacacs或radius时，profileId必填。 "aeb684c8-0d37-496f-bafa-4b06d5151e2e" cmdEnable boolean true false false 命令行授权，当authType为tacacs时，cmdEnable必填。默认值为false。 true authProtocol string PAP CHAP PAP 认证协议，当authType为radius时，authProtocol必填。默认值为PAP。 - authenticationEnable boolean true false false 认证逃生使能。当authType为tacacs或radius时，authenticationEnable必填。默认值为false。 false authorizationEnable boolean true false false 授权逃生使能。当authType为tacacs时，authorizationEnable必填。默认值为false。 false accountingEnable boolean true false false 计费逃生使能。当authType为tacacs或radius时，accountingEnable必填。默认值为false。 false 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

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

请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/devicemgrauth/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/devicemgrauth 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,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

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-direct-route-vlink:vlink-if 表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的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-direct-route-vlink:vlink-if 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"

配置VTY优先级缺省模板（仅V600版本AR设备） 表1 ConfigVtyPrivilegeLevel模板参数解释 参数名称 类型 取值范围 参数解释 index Integer 34~54 终端索引。指定用户终端接口的TTY索引。 对应设备命令行的vty index为0~20 privilege_level Integer 0~3 用户的优先级。 下发到设备的命令： user-interface vty 0 user privilege level level 父主题： iMaster NCE-Campus内置缺省模板参数介绍