华为云用户手册

响应示例 返回状态码为201：创建成功。 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" : { "zoneId" : "00000000-0000-0000-0000-00000000000f", "name" : "dmzzz", "priority" : "88", "description" : "finance dmz", "predefined" : 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参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 securityZoneInfo 是 REFERENCE 详细请参见表2。 待创建的安全域。 - 表2 CreateZoneInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 是 string 1~32个字符。 - 安全 域名 称，不能为name或vpn-instance，支持的字符包括a～zA～Z_.@数字。 "dmzzz" description 否 string 0~64个字符。 - 安全域描述，支持的字符包括a～zA～Z_.-@数字空格。 "finance dmz" priority 是 integer [1-100] - 安全域优先级。数值越大，优先级更高。 "75"

请求示例 HTTP的示例 POST /controller/campus/v1/networkconfig/profile/securityzones 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 { "name" : "dmzzz", "description" : "finance dmz", "priority" : "75" }

请求示例 HTTP的示例 POST /v1/networkservice/hierarchy-template/template-groups/00000000-0000-0000-0000-000000000000/tasks/00000000-0000-0000-0000-000000000000/action/deploy-binding 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" : "" } 返回状态码为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 { "errcode" : "0", "errmsg" : "" } 返回状态码为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 /v1/networkservice/hierarchy-template/template-groups/{id}/tasks/{taskId}/action/deploy-binding 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。 - 模板组ID，UUID格式。 "00000000-0000-0000-0000-000000000000" taskId 是 string 36个字符。 - 绑定部署任务ID，UUID格式。 "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 { "errcode" : "0", "errmsg" : "", "totalRecords" : 100, "data" : [ { "parentId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "tenant1", "isExclusiveResource" : false, "vpnNumber" : 100, "bandWidth" : 100, "siteNumber" : 100, "sdwanBandwidth" : 100, "encryptedSdwanBandwidth" : 100, "vxlanBandwidth" : 100, "status" : 0, "role" : "Interworking Gateway", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1" } ] } 返回状态码为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/sdwan/v1/naas/virtual/device 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 { "deviceInfos" : [ { "parentId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "tenant1", "isExclusiveResource" : false, "vpnNumber" : 100, "bandWidth" : 100, "siteNumber" : 100, "sdwanBandwidth" : 100, "encryptedSdwanBandwidth" : 100, "vxlanBandwidth" : 100, "status" : 0, "role" : "Interworking Gateway", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1" } ] }

响应示例 返回状态码为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" : "", "success" : [ "4f350825-919c-47b7-b853-f51f15912396" ], "fail" : [ { "errcode" : "0302000020", "errmsg" : "The site ID format is incorrect or the site does not exist", "id" : "4f350825-919c-47b7-b853-f51f15912398" } ] } 返回状态码为207：删除ACL模板部分成功。 HTTP/1.1 207 Multi-Status 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" : [ "4f350825-919c-47b7-b853-f51f15912396" ], "fail" : [ { "errcode" : "0302000020", "errmsg" : "The site ID format is incorrect or the site does not exist", "id" : "4f350825-919c-47b7-b853-f51f15912398" } ] } 返回状态码为400：删除ACL模板全部失败。 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 { "errcode" : "0", "errmsg" : "", "success" : [ "4f350825-919c-47b7-b853-f51f15912396" ], "fail" : [ { "errcode" : "0302000020", "errmsg" : "The site ID format is incorrect or the site does not exist", "id" : "4f350825-919c-47b7-b853-f51f15912398" } ] } 返回状态码为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/v3/profile/acl/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" : [ "4f350825-919c-47b7-b853-f51f15912396" ] }

请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-cli:command-aliases/command-alias 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：操作成功。 表3 command-alias-list对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-cli:command-alias ARRAY_REFERENCE 详细请参见表4。 别名实例。 - 表4 command-aliases-exactProperties-command-alias对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 alias string 1~63个字符。满足正则表达[a-zA-Z][a-zA-Z0-9-]*。 - 指定别名。必填，支持大、小写字母，数字及连字符"-"，字母开头，不区分大小写，字符间不能有空格。别名定义出现循环嵌套或嵌套层次超过16层时，该别名节点无效，不会用于进行字符串替换。单一主键字段。 "test1" command string 1~511个字符。满足正则表达[^?]+。 - 指定别名命令行。必填，不支持英文问号，如果字符之间有空格，则字符串外必须使用双引号。指定别名参数配置后，必须在指定别名命令行里面包含进去。例如参数包含$a，则命令行格式应该为$a，"$a"，"xxx $a"，"xxx $a $xx"这样的形式。多个$参数必须连续保持在最后。 "test2" parameter string 2~511个字符。 - 指定别名参数。支持大、小写字母，数字及连字符"-"，必须以"$"符号开头，不区分大小写，取值范围是2～63，最多支持32个参数，参数之间以空格进行分隔。指定别名命令行配置后，必须在指定别名参数里面定义。例如命令行格式为$a，"$a"，"xxx $a"，"xxx $a $xx"这样的形式，则指定别名参数必须包含$a。 "$test3" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-cli:command-aliases/command-alias 表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：操作成功。 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-cli:command-alias" : [ { "alias" : "test1", "command" : "test2", "parameter" : "$test3" } ] } 返回状态码为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/performanceservice/endpointbehavior/loyalty?tagId=9dffc44b-1824-42a4-ac48-616e3f0eaa2a&tagType=0&startTime=1567526400&endTime=1567527800&timeUnit=day 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：接口调用成功，响应体参考FlowDistrResp。 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" : [ { "targetName" : "humanflow", "counts" : [ { "count" : "123", "stamp" : 1565049600000 } ] } ] } 返回状态码为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

URI /controller/campus/v1/performanceservice/endpointbehavior/loyalty 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 tagId 否 string - - 查询维度具体id,UUID格式,根据tagType确定，当tagType为0或1时，tagId必填. "9dffc44b-1824-42a4-ac48-616e3f0eaa2a" tagType 是 string 0 1 2 - 查询类型： 0---站点维度查询，TagID为站点ID。 1---设备标签维度查询，TagID为设备标签ID。 2---租户维度查询，TagID不做校验，可为空。 "0" startTime 是 int32 - - 时间戳（秒），最大时间差不超过一年。 1567526400 endTime 是 int32 - - 时间戳（秒），最大时间差不超过一年。 1567527800 timeUnit 是 string day week month custom - 时间维度。 day---天维度 week---周维度 month---月维度 custom---自定义维度 "day"

响应示例 返回状态码为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" : { "id" : "fbb684c8-0d37-496f-bafa-4b06db151e2e", "name" : "TEST", "ikeVersion" : "v1", "ikeEncryptAlgorithm" : "aes-256", "ikeNegotiationMode" : "main", "ikeAuthAlgorithm" : "sha2-256", "ikeIntegrityAlgorithm" : "sha2-256", "ikePrf" : "sha2-256", "ipsecTransformProtocol" : "ah", "ipsecEncapsulationMode" : "tunnel", "ipsecAhAuthAlgorithm" : "sha2-256", "ipsecAuthAlgorithm" : "sha2-256", "ipsecEncryptAlgorithm" : "aes-256", "ipsecPfs" : "group1", "ipsecLifetimeSeconds" : "30", "ipsecLifetimeKilobytes" : "256", "ipsecDpdType" : "periodic", "ipsecDpdMsg" : "seq-hash-notify", "ipsecDpdInterval" : "30", "ipsecDpdTimeout" : "15", "ikeDh" : "group1", "ikeLifeTime" : "60" } }

请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/profile/apvpn/encryptionpolicy 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 { "id" : "fbb684c8-0d37-496f-bafa-4b06db151e2e", "name" : "TEST", "ikeVersion" : "v1", "ikeEncryptAlgorithm" : "aes-256", "ikeNegotiationMode" : "main", "ikeAuthAlgorithm" : "sha2-256", "ikeIntegrityAlgorithm" : "sha2-256", "ikePrf" : "sha2-256", "ipsecTransformProtocol" : "ah", "ipsecEncapsulationMode" : "tunnel", "ipsecAhAuthAlgorithm" : "sha2-256", "ipsecAuthAlgorithm" : "sha2-256", "ipsecEncryptAlgorithm" : "aes-256", "ipsecPfs" : "group1", "ipsecLifetimeSeconds" : "30", "ipsecLifetimeKilobytes" : "256", "ipsecDpdType" : "periodic", "ipsecDpdMsg" : "seq-hash-notify", "ipsecDpdInterval" : "30", "ipsecDpdTimeout" : "15", "ikeDh" : "group1", "ikeLifeTime" : "60" }

响应参数 返回状态码为200：创建成功。 表3 EncryptitonPolicyResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息 "" data REFERENCE 详细请参见表4。 VPN配置数据 - 表4 EncryptitonPolicyConfigDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 36个字符。 - id "fbb684c8-0d37-496f-bafa-4b06db151e2e" name string 0~15个字符。 - 加密策略名称，请输入1-15位字符，由字母、数字、下划线、短线、点号、@符组成。 "TEST" ikeVersion string 0~3个字符。 - ike版本。取值【v1|v2|all】。只有当取值为v1时，需要配置协商模式,认证算法。 "v1" ikeEncryptAlgorithm string 0~7个字符。 - ike加密算法。取值【des|3des|aes-128|aes-192|aes-256】。 "aes-256" ikeNegotiationMode string 0~10个字符。 - （仅IKEv1）协商模式。取值【main|aggressive】。 "main" ikeAuthAlgorithm string 0~8个字符。 - （仅IKEv1）认证算法。取值【md5|sha1|sha2-256|sha2-384|sha2-512|sm3】。 "sha2-256" ikeIntegrityAlgorithm string 0~11个字符。 - （仅IKEv2）完整性算法。取值【aes-xcbc-96|md5|sha1|sha2-256|sha2-384|sha2-512】。 "sha2-256" ikePrf string 0~12个字符。 - （仅IKEv2）协商伪随机数产生函数（PRF）的算法。取值【aes-xcbc-128|md5|sha1|sha2-256|sha2-384|sha2-512】。 "sha2-256" ipsecTransformProtocol string 0~6个字符。 - ipsec 安全协议。取值【ah|esp|ah-esp】。当取值为ah、ah-esp时，需要配置认证算法。当取值为esp、ah-esp时，需要配置esp加密算法、esp认证算法。 "ah" ipsecEncapsulationMode string 0~8个字符。 - ipsec 封装模式。取值【tunnel|transport】。 "tunnel" ipsecAhAuthAlgorithm string 0~8个字符。 - ipsec 认证算法，ah、ah-esp安全协议下使用。取值【md5|sha1|sha2-256|sha2-384|sha2-512|sm3】。 "sha2-256" ipsecAuthAlgorithm string 0~8个字符。 - ipsec ESP认证算法，esp、ah-esp安全协议下使用。取值【md5|sha1|sha2-256|sha2-384|sha2-512】。 "sha2-256" ipsecEncryptAlgorithm string 0~15个字符。 - ipsec ESP加密算法。取值【3des|des|aes-128|aes-192|aes-256|none|aes-128-gcm-128|aes-192-gcm-128|aes-256-gcm-128】。 "aes-256" ipsecPfs string 0~7个字符。 - ipsec pfs。取值【group1|group2|group5|group14|group15|group16】。 "group1" ipsecLifetimeSeconds string 0~6个字符。 - ipsec sa 存活时间（基于时间）。取值30-604800。 "30" ipsecLifetimeKilobytes string 0~9个字符。 - ipsec sa 允许处理的最大流量（基于流量）。取值256-200000000。 "256" ipsecDpdType string 0~9个字符。 - ipsec dpd检测方式。取值【periodic|on-demand】。 "periodic" ipsecDpdMsg string 0~15个字符。 - ipsec dpd 载 荷顺序。取值【seq-hash-notify|seq-notify-hash】。 "seq-hash-notify" ipsecDpdInterval string 0~4个字符。 - ipsec dpd 检测时间间隔（秒）。取值10-3600。 "30" ipsecDpdTimeout string 0~2个字符。 - ipsec dpd 重传时间间隔（秒）。取值2-60。 "15" ikeDh string 0~7个字符。 - dh组。取值【group1|group2|group5|group14|group15|group16】。 "group1" ikeLifeTime string 0~6个字符。 - SA超时时间。取值30-604800。 "60"

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 AP IPSEC 模板配置参数体。 - 表2 EncryptitonPolicyConfigDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 string 36个字符。 - id "fbb684c8-0d37-496f-bafa-4b06db151e2e" name 否 string 0~15个字符。 - 加密策略名称，请输入1-15位字符，由字母、数字、下划线、短线、点号、@符组成。 "TEST" ikeVersion 否 string 0~3个字符。 - ike版本。取值【v1|v2|all】。只有当取值为v1时，需要配置协商模式,认证算法。 "v1" ikeEncryptAlgorithm 否 string 0~7个字符。 - ike加密算法。取值【des|3des|aes-128|aes-192|aes-256】。 "aes-256" ikeNegotiationMode 否 string 0~10个字符。 - （仅IKEv1）协商模式。取值【main|aggressive】。 "main" ikeAuthAlgorithm 否 string 0~8个字符。 - （仅IKEv1）认证算法。取值【md5|sha1|sha2-256|sha2-384|sha2-512|sm3】。 "sha2-256" ikeIntegrityAlgorithm 否 string 0~11个字符。 - （仅IKEv2）完整性算法。取值【aes-xcbc-96|md5|sha1|sha2-256|sha2-384|sha2-512】。 "sha2-256" ikePrf 否 string 0~12个字符。 - （仅IKEv2）协商伪随机数产生函数（PRF）的算法。取值【aes-xcbc-128|md5|sha1|sha2-256|sha2-384|sha2-512】。 "sha2-256" ipsecTransformProtocol 否 string 0~6个字符。 - ipsec 安全协议。取值【ah|esp|ah-esp】。当取值为ah、ah-esp时，需要配置认证算法。当取值为esp、ah-esp时，需要配置esp加密算法、esp认证算法。 "ah" ipsecEncapsulationMode 否 string 0~8个字符。 - ipsec 封装模式。取值【tunnel|transport】。 "tunnel" ipsecAhAuthAlgorithm 否 string 0~8个字符。 - ipsec 认证算法，ah、ah-esp安全协议下使用。取值【md5|sha1|sha2-256|sha2-384|sha2-512|sm3】。 "sha2-256" ipsecAuthAlgorithm 否 string 0~8个字符。 - ipsec ESP认证算法，esp、ah-esp安全协议下使用。取值【md5|sha1|sha2-256|sha2-384|sha2-512】。 "sha2-256" ipsecEncryptAlgorithm 否 string 0~15个字符。 - ipsec ESP加密算法。取值【3des|des|aes-128|aes-192|aes-256|none|aes-128-gcm-128|aes-192-gcm-128|aes-256-gcm-128】。 "aes-256" ipsecPfs 否 string 0~7个字符。 - ipsec pfs。取值【group1|group2|group5|group14|group15|group16】。 "group1" ipsecLifetimeSeconds 否 string 0~6个字符。 - ipsec sa 存活时间（基于时间）。取值30-604800。 "30" ipsecLifetimeKilobytes 否 string 0~9个字符。 - ipsec sa 允许处理的最大流量（基于流量）。取值256-200000000。 "256" ipsecDpdType 否 string 0~9个字符。 - ipsec dpd检测方式。取值【periodic|on-demand】。 "periodic" ipsecDpdMsg 否 string 0~15个字符。 - ipsec dpd 载 荷顺序。取值【seq-hash-notify|seq-notify-hash】。 "seq-hash-notify" ipsecDpdInterval 否 string 0~4个字符。 - ipsec dpd 检测时间间隔（秒）。取值10-3600。 "30" ipsecDpdTimeout 否 string 0~2个字符。 - ipsec dpd 重传时间间隔（秒）。取值2-60。 "15" ikeDh 否 string 0~7个字符。 - dh组。取值【group1|group2|group5|group14|group15|group16】。 "group1" ikeLifeTime 否 string 0~6个字符。 - SA超时时间。取值30-604800。 "60"

URI /v1/networkservice/hierarchy-template/template-groups/{id}/members/batch-delete/details 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。 - 模板组ID，UUID格式。 "00000000-0000-0000-0000-000000000000"

响应示例 返回状态码为200：Success。 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 { "totalRecords" : 100, "progress" : 0.9, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "TemplateBinding1", "templateId" : "00000000-0000-0000-0000-000000000000", "createTime" : "1713880927744", "description" : "this is TemplateBinding1", "totalDeviceNum" : 100, "deployedLastestSuccessDeviceCount" : 100, "templateBindingStatus" : "last-template-partly-deployed", "deployLastVersion" : true, "templateName" : "this is template1", "devices" : { "totalRecords" : 100, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "device1", "ip" : "127.0.0.1", "siteName" : "site1", "deployStatus" : "deployment-successed", "deployTime" : "1713880927744", "deployLastVersion" : true, "deployErrorMsg" : {"errorCode":"0x00c8000c","errorType":"APPLICATION","message":"The request failed because the mandatory node is empty"} } ] } } ] } 返回状态码为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 { "errcode" : "0", "errmsg" : "" } 返回状态码为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 /v1/networkservice/hierarchy-template/template-groups/00000000-0000-0000-0000-000000000000/members/batch-delete/details 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 { "pageIndex" : 1, "pageSize" : 10, "templateName" : "template1", "bindingName" : "binding1", "deviceName" : "device1", "siteName" : "site1", "deleteTemplateGroupInput" : { "deleteIds" : ["00000000-0000-0000-0000-000000000000"] }, "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-bd:bd 表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-bd:bd 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 { "huawei-nce-e-cli:command-alias" : [ { "alias" : "test1", "command" : "test2", "parameter" : "$test3" } ] } 返回状态码为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 /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-cli:command-aliases/command-alias/test1 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-cli:command-aliases/command-alias/{alias} 表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" alias 是 string 1~63个字符。满足正则表达[a-zA-Z][a-zA-Z0-9-]*。 - 指定别名。必填，支持大、小写字母，数字及连字符"-"，字母开头，不区分大小写，字符间不能有空格。别名定义出现循环嵌套或嵌套层次超过16层时，该别名节点无效，不会用于进行字符串替换。单一主键字段。 "test1"