华为云用户手册

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-queue-template:user-queue-profile 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" { "huawei-nce-e-queue-template:user-queue-profile" : [ { "config-status" : "reserved", "last-committed-time" : "last-committed-time", "related-pkg-version" : "related-pkg-version", "edit-state" : "RUNNING", "name" : "UserQueueProfile", "mode" : "normal", "description" : "test", "traffic-behavior-user-queue" : [ { "name" : "name", "scheduler-mode" : "pq", "weight" : 10, "cir" : 64, "pir" : 10, "cir-percent" : 20, "pir-percent" : 30, "cbs" : 10, "pbs" : 10 } ] } ] }

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-queue-template:user-queue-profile 是 REFERENCE 详细请参见表4。 QoS模板。 - 表4 nes-ne-user-queue-profile-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-queue-template:user-queue-profile 否 ARRAY_REFERENCE 详细请参见表5。 QoS模板。 - 表5 nes-ne-user-queue-profile对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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~63个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - 模板名称，单一主键字段。 "UserQueueProfile" mode 是 string normal time-range 8cos-enhance - 模板模式。AR6700V主设备，AR6700V子设备和AR6700V-L款型不支持。 "normal" description 否 string 1~63个字符。 - 描述。AR6700V主设备，AR6700V子设备和AR6700V-L款型不支持。 "test" traffic-behavior-user-queue 否 ARRAY_REFERENCE 0-256个列表项，详细请参见表6。 流行为用户队列。 - 表6 nes-ne-user-queue-profile-traffic-behavior-user-queue对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~31个字符。 - 流行为用户队列名称，单一主键字段。 "name" scheduler-mode 否 string pq drr not-config - 调度模式。 "pq" weight 否 int32 [1-100] - 权重。 10 cir 否 int64 [64-100000000] - 承诺速率。 64 pir 否 int64 [8-100000000] - 峰值速率。 10 cir-percent 否 int32 [1-100] - 承诺百分比。 20 pir-percent 否 int32 [1-100] - 峰值百分比。 30 cbs 否 int64 [0-4194304] - 承诺突发尺寸。 10 pbs 否 int64 [0-4194304] - 峰值突发尺寸。 10

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-queue-template:user-queue-profile 表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：更新成功，响应体参考BatchReplaceDeviceCertificateResponseDto。 表3 BatchReplaceDeviceCertificateResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~64个字符。 - 错误码。 "0" errmsg string 0~64个字符。 - 错误信息。 "" 返回状态码为400：校验异常，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：更新成功，响应体参考BatchReplaceDeviceCertificateResponseDto。 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

请求示例 HTTP的示例 POST /controller/campus/v1/oamservice/certification/device/certificate/batch-update 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 { "deviceIds" : [ "57f879c7-7f6a-4d3a-88af-bf2585cb61e0" ], "caServerId" : "00000000-0000-0000-0000-000000000000", "algorithm" : "rsa", "algLength" : "4096", "entity" : { "ipAddress" : "10.1.1.1", "fqdn" : "test.abc.com", "email" : "user@abc.com", "country" : "cn", "state" : "jiangsu", "organization" : "huawei", "department" : "huawei" }, "transportNetworkPortId" : "00000000-0000-0000-0000-000000000000", "challengePwd" : "password", "vpnId" : "18bd7aec-f163-4091-bc5e-d6c19725d72c", "vpnInstanceName" : "vpn1", "sourceInterface" : "loopback1", "urlMode" : 1, "sslClientVersion" : "tls1.2", "sslClientCipher" : 16, "pkiDomain" : "default" }

响应示例 返回状态码为200：接口调用成功，响应体参考IpsecTunnelResponse，返回的除GRE Tunnel配置中仅包含对应的ID。 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" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "00000000-0000-0000-0000-000000000000", "ipAddress" : "192.168.0.1/24", "srcIpAddress" : "192.168.1.1", "srcType" : "IP", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "mtu" : 1500, "TCPmss" : 1200, "securityZone" : "underlay_untrust" } ] } 返回状态码为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/net/site/inter/connect/ipsec/tunnel/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 { "ipsecTunnelInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "00000000-0000-0000-0000-000000000000", "ipAddress" : "192.168.0.1/24", "srcIpAddress" : "192.168.1.1", "srcType" : "IP", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "mtu" : 1500, "TCPmss" : 1200, "securityZone" : "underlay_untrust" } ] }

响应示例 返回状态码为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" : "" } 返回状态码为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/lanwan/vn/action/redeploy 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 { "vnId" : "b09a0266-f34e-125d-ce23-ad1278b6c59a", "memberType" : "SITE", "memberIds" : ["b09a0266-f34e-125d-ce23-ad1278b6c59a"] }

响应参数 返回状态码为200：重下发成功返回。 表3 CommonResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nat-if:nat-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-ACCESS-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 返回状态码为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-nat-if:nat-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：修改成功。 表3 CliSwitchPutResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表4。 - - 表4 CliSwitchDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 cliEnable boolean true false - 是否使能设备本地CLI配置开关。 false

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

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 租户内设备本地CLI配置开关配置参数体。 - 表2 CliSwitchDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 cliEnable 是 boolean true false - 是否使能设备本地CLI配置开关。 false

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/cliswitch 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 { "cliEnable" : false }

响应示例 返回状态码为200：接口调用成功，响应体参考DeviceCountTrendResp。 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" : [ { "timestamp" : 1537407600, "deviceOnlineCount" : "", "deviceOfflineCount" : "", "deviceUnregisteredCount" : "" } ] } 返回状态码为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的示例 GET /controller/campus/v1/performanceservice/basicperformance/devicecounttrend?mode=tenant&timeDimension=day&beginTime=1537408636&endTime=1537495036 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/v1/performanceservice/basicperformance/devicecounttrend 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mode 是 string - tenant 查询维度，tenant---租户。 "tenant" timeDimension 是 string day week month year day 统计周期，day---天、week---周、month---月、year---年。 "day" beginTime 是 int64 [0-2208959999] - 起始格林威治时间（时间精度对应到秒）。 1537408636 endTime 是 int64 [0-2208959999] - 结束格林威治时间（时间精度对应到秒）。 1537495036

响应参数 返回状态码为200：接口调用成功，响应体参考DeviceCountTrendResp。 表2 DeviceCountTrendResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码信息。 "0" errmsg string 0~256个字符。 - 结果信息。 "" data ARRAY_REFERENCE 0-2147483647个列表项，详细请参见表3。 设备状态历史趋势信息。 - 表3 DeviceCountTrend对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 timestamp int64 - - 格林威治时间。 1537407600 deviceOnlineCount int32 [0-2147483647] - 在线设备数量。 - deviceOfflineCount int32 [0-2147483647] - 离线设备数量。 - deviceUnregisteredCount int32 [0-2147483647] - 未注册设备数量。 - 返回状态码为400：参数非法，查询失败。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-ipv4-urpf:ipv4-urpf 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-ipv4-urpf:ipv4-urpf" : [ { "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/1", "mode" : "strict", "default-route" : 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 返回状态码为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 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-ipv4-urpf:ipv4-urpf 是 REFERENCE 详细请参见表4。 接口IPv4 URPF配置。 - 表4 nes-ne-ipv4-urpf-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-ipv4-urpf:ipv4-urpf 否 ARRAY_REFERENCE 详细请参见表5。 接口IPv4 URPF配置。 - 表5 nes-ne-ipv4-urpf对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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" if-name 是 string 1~63个字符。 - 接口名称，单一主键字段。 "GE0/0/1" mode 是 string strict loose - 检查方式，分为严格检查和松散检查。 "strict" default-route 否 boolean true false false 使能缺省路由检查。 true

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-ipv4-urpf:ipv4-urpf 表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的示例 PUT /v1/accountservice/parameterconfig 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 { "parameterConfigList" : [ { "serviceType" : "serviceType", "configItemKey" : "configItemKey", "configItemValue" : "configItemValue" } ] }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 parameterConfigRequestDto 是 REFERENCE 详细请参见表2。 租户全局高级参数配置 - 表2 ParameterConfigRequestDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 parameterConfigList 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 参数配置列表 - 表3 ParameterConfigItem对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 serviceType 是 string 1~128个字符。 - 业务类型 "serviceType" configItemKey 是 string 1~128个字符。 - 配置项key "configItemKey" configItemValue 否 string 0~1024个字符。 - 配置项Value "configItemValue"

响应参数 返回状态码为200：更新租户全局高级参数配置成功 表4 CommonResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息描述。 "" 返回状态码为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" : "" } 返回状态码为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