华为云用户手册

  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-nat-address-group:snat-address-group 是 REFERENCE 详细请参见表4。 源NAT地址池。 -
  • 响应示例 返回状态码为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
  • 请求示例 HTTP的示例 DELETE /controller/campus/rest/sdwan/v2/radius/template 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 { "ids" : ["c6c76e11-6f75-41fb-8d90-594323c9f811","c6c76e11-6f75-41fb-8d90-594323c9f812"] }
  • 响应参数 返回状态码为200:删除成功,响应体参考CommonResponse。 表3 CommonResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 响应参数 返回状态码为200:修改CPE接入非法控制器防范功能开关成功,响应体参考ControllerValidateModifyOutput。 表3 ControllerValidateModifyOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~2048个字符。 - 错误信息。 "OK" controllerValidate string 4~5个字符。 - 校验开关状态,该字段为“true”时,开关已开启,该字段为“false”时,开关未开启。 "true" 返回状态码为500:接口调用内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:修改CPE接入非法控制器防范功能开关成功,响应体参考ControllerValidateModifyOutput。 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" : "OK", "controllerValidate" : "true" } 返回状态码为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/systemparameter/securityconfig/verify-controller 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 { "controllerValidate" : "true" }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 controllerValidateModifyInput 是 REFERENCE 详细请参见表2。 修改CPE接入非法控制器防范功能开关请求体。 - 表2 ControllerValidateModifyInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 controllerValidate 否 string 4~5个字符。 - 校验开关状态,该字段为“true”时,开关已开启,该字段为“false”时,开关未开启。 "true"
  • 请求示例 HTTP的示例 POST /controller/campus/v4/devices/query 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 { "discoverProtocol" : ["NETCONF","SNMP","COAP"], "deviceGroupId" : "c43fd065268d31b8bdfcc7faaec15726", "status" : ["NORMAL","ALARM"], "roles" : ["Gateway","CORE"], "types" : ["WAC","AP"], "keyWord" : "127.0.0.1", "name" : "AA02350", "esn" : "DLR00000", "model" : "P6050", "softwareVersion" : "R020C00", "patchVersion" : "patch001", "manageStatus" : ["NORMAL","DEVICE_ISOLATE"], "sortField" : "name", "pageIndex" : "4", "pageSize" : "20", "createTimeBegin" : 1616554000, "createTimeEnd" : 1616554000, "registerTimeBegin" : 1616554000, "registerTimeEnd" : 1616554000 }
  • 响应示例 返回状态码为200:调用查询设备成功,响应体参考QueryDeviceResult。 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", "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 2, "data" : [ { "id" : "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42", "name" : "AR1", "esn" : "2102351BTJ0000000666", "deviceModel" : "AR161EW", "deviceType" : "AR", "status" : "0", "siteId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "mac" : "", "ip" : "192.168.0.10", "manageIp" : "192.168.0.10", "neType" : "AR161EW", "version" : "V300R003C00", "vendor" : "HUAWEI", "description" : "HUAWEI", "resourceId" : "HUAWEI", "tenantId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "tenantName" : "XXX@XXX.com", "siteName" : "test1", "createTime" : "2017-12-13 01:37:28", "registerTime" : "2017-12-13 01:37:28", "modifyTime" : "2017-12-13 01:37:28", "startupTime" : "2017-12-13 01:37:28", "tags" : [ "" ], "systemIp" : "192.168.1.1", "patchVersion" : "V200R019SPH", "ztpConfirm" : false, "manageStatus" : "ABNORMAL", "manageStatusDownReason" : ["NEED_ZTP_CONFIRM","DEVICE_HAS_BEEN_ISOLATED"], "role" : ["Gateway"], "performance" : "", "uptime" : "0 天 1 时 10 分" } ] } 返回状态码为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/sdwan/v1/naas/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 { "naasNetworkId" : "00000000-0000-0000-0000-000000000000", "naasNetworkName" : "Template1", "naasNetworkPlatformType" : "", "networkInfrastructure" : { "subnet" : [ { "subnetName" : "subnet", "subnetId" : "00000000-0000-0000-0000-000000000000", "networkId" : "00000000-0000-0000-0000-000000000000", "portGroup" : "PortGroup-vmware", "segment" : "127.1.0.0/16", "reservedIps" : "127.1.1.1;127.1.1.2", "portGroupFc" : "PortGroup-fc" } ] }, "networkResources" : { "resources" : [ { "hostUnitType" : "director", "number" : 24 } ] }, "networkFunctions" : { "networkFunction" : [ { "interfaces" : [ { "nfiName" : "GE0/0/1", "subnetName" : "subnet" } ] } ] }, "initialLoadBalanceNumber" : "", "bandwidthRedundancy" : "", "nodeMaxDeviceNumber" : "" }
  • 响应示例 返回状态码为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" : "", "naasNetworkId" : "" } 返回状态码为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
  • 响应参数 返回状态码为201:创建成功返回。 表10 NaasNetworkUpdateResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" naasNetworkId string - - 创建的ID。 "" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 naasNetwork 是 REFERENCE 详细请参见表2。 NaasNetwork信息。 - 表2 NaasNetworkInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 naasNetworkId 否 string 0~64个字符。 - 模板ID, 创建时不使用。 "00000000-0000-0000-0000-000000000000" naasNetworkName 是 string 1~32个字符。 - 服务链名称。 "Template1" naasNetworkPlatformType 否 int32 [1-3] 1 虚机平台类型,1:openstack, 2:vmware,3:FusionCompute。 - networkInfrastructure 否 REFERENCE 详细请参见表3。 服务功能。 - networkResources 否 REFERENCE 详细请参见表5。 资源。 - networkFunctions 否 REFERENCE 详细请参见表7。 服务功能。 - initialLoadBalanceNumber 否 int32 [1-8] 3 部署1个子设备的forwarder个数。 - bandwidthRedundancy 否 int32 [0-300] 50 带宽冗余度。 - nodeMaxDeviceNumber 否 int32 [1-1000] 512 每个forwarder部署的子设备最大数量。 - 表3 NetworkInfrastructure对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 subnet 否 ARRAY_REFERENCE 1-16个列表项,详细请参见表4。 地址池。 - 表4 NetworkInfrastructureSubnet对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 subnetName 是 string 1~127个字符。 - 子网名称。 "subnet" subnetId 否 string 1~127个字符。 - 子网UUID。 "00000000-0000-0000-0000-000000000000" networkId 否 string 1~127个字符。 - 网络UUID。 "00000000-0000-0000-0000-000000000000" portGroup 否 string 1~127个字符。 - 端口组名字,针对VMWare平台。 "PortGroup-vmware" segment 否 string 1~128个字符。 - 子网CIDR。 "127.1.0.0/16" reservedIps 否 string 0~1024个字符。 - 子网。 "127.1.1.1;127.1.1.2" portGroupFc 否 string 1~127个字符。 - 端口组名字,针对FusionCompute平台。 "PortGroup-fc" 表5 NetworkResources对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 resources 否 ARRAY_REFERENCE 2个列表项,详细请参见表6。 服务链资源组。 - 表6 NetworkResource对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 hostUnitType 是 string 1~32个字符。 - 取值为director或者forwarder,且director与forwarder必须同时填写。 "director" number 是 int32 [1-150] - 资源数量。 24 表7 NetworkFunctions对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 networkFunction 否 ARRAY_REFERENCE 1个列表项,详细请参见表8。 服务组。 - 表8 NetworkFunction对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 interfaces 是 ARRAY_REFERENCE 1-16个列表项,详细请参见表9。 服务接口组。 - 表9 NetworkFunctionInterface对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nfiName 是 string 1~64个字符。 - 服务名称。 "GE0/0/1" subnetName 是 string 1~127个字符。 - 子网名称 "subnet"
  • 响应示例 返回状态码为200:修改设备基本信息成功,响应体参考ModifyDeviceBean。 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" : "00000000-0000-0000-0000-000000000001", "name" : "AR1", "description" : "AR", "resourceId" : "HUAWEI", "siteId" : "00000000-0000-0000-0000-000000000001", "esn" : "2102351BTJ0000000666", "tags" : ["AP01"], "systemIp" : "192.168.1.1", "ztpConfirm" : true, "role" : ["Gateway"] } } 返回状态码为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/v3/devices/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 { "name" : "AR1", "description" : "AR", "resourceId" : "HUAWEI", "siteId" : "00000000-0000-0000-0000-000000000001", "esn" : "2102351BTJ0000000666", "tags" : ["AP01"], "systemIp" : "192.168.1.1", "ztpConfirm" : true, "role" : ["Gateway"], "performance" : 0 }
  • 请求参数 表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-ACCESS-TOKEN: x-yyyyyy { "name" : "dmzzz", "description" : "finance dmz", "priority" : "75" }
  • 响应示例 返回状态码为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
  • 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"
  • 请求示例 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
  • 请求示例 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:更新成功返回。 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
  • 响应示例 返回状态码为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" ] }
  • 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 /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:内部错误。 详细信息请参见实际响应消息体。
共100000条
提示

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