华为云用户手册

  • 响应示例 返回状态码为200:查询成功。 { "errcode": "0", "errmsg": "", "data": { "deadInterval": 5, "deadCount": 2, "deadDetect": "by-server-ip" } } 返回状态码为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 { "errcode" : "51384336", "errmsg" : "设备组Id格式错误或设备组不存在。", "errdesc" : "", "errreason" : "", "errdetail" : "", "erradvice" : "" } 返回状态码为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/api/v1/networkconfig/radiusdetect/site/fbb684c8-0d37-496f-bafa-4b06d5151e2e 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
  • 请求示例 HTTP的示例 POST /restconf/operations/huawei-nce-aoc-config-template:edit-temporary-template HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "huawei-nce-aoc-config-template:input": { "job-id": "5c261eb5-2f4a-4acc-a747-c77ee1d18083", "edit-template":[ { "template-name":"新增特性A", "content-type":"yaml", "template-content":"---\nhuawei-nce-e-vlan:vlan:\n- vlan-id: 1\n name: \"vlan1\"\n description: \"vlan1\"\n unknown-flow-drop: null\nhuawei-nce-e-snmp-user:snmp-user:\n agent-enable: true\n password-min-length: 10\n version: \"{snmp_user_version}\"" } ] } }
  • 响应示例 返回状态码为204:成功 HTTP/1.1 204 No Content Date: Thu,21 Dec 2023 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: Thu,21 Dec 2023 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 edit-temporary-template 是 REFERENCE 详细请参见表2。 edit temporary template - 表2 edit-temporary-template-input对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template:input REFERENCE 详细请参见表3。 - - 表3 edit-temporary-template-input-body对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 job-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 "5c261eb5-2f4a-4acc-a747-c77ee1d18083" edit-template 是 ARRAY_REFERENCE 0-100个列表项,详细请参见表4。 edit temporary input - 表4 edit-temporary-template-input-body-edit-template对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 template-name 是 string 1~128个字符。 - 模板名称 "test_template" content-type 是 string json yaml - 模板内容格式Json/Yaml "yaml" template-content 是 string 0~1048576个字符。 - 模板内容 "---\\nhuawei-nce-e-vlan:vlan:\\n- vlan-id: 1\\n name: \\\"vlan1\\\"\\n description: \\\"vlan1\\\"\\n unknown-flow-drop: null\\nhuawei-nce-e-snmp-user:snmp-user:\\n agent-enable: true\\n password-min-length: 10\\n version: \\\"{snmp_user_version}\\\""
  • 响应示例 返回状态码为201:接口调用成功,响应体参考BridgeDomainResponse。 HTTP/1.1 201 Created 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" : "", "success" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "ports" : [ { "id" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0", "tagMode" : "tag", "portLagFlag" : false, "isAutoNegotiation" : false } ], "vlanId" : 2, "description" : "description", "configSource" : "Wan" } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "ports" : [ { "id" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0", "tagMode" : "tag", "portLagFlag" : false, "isAutoNegotiation" : false } ], "vlanId" : 2, "description" : "description", "configSource" : "Wan" } } ] } 返回状态码为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
  • 响应参数 返回状态码为201:接口调用成功,响应体参考BridgeDomainResponse。 表5 BridgeDomainResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项,详细请参见表6。 创建或者更新成功的Bridge Domain信息。 - fail ARRAY_REFERENCE 0-100个列表项,详细请参见表8。 创建或者更新失败的Bridge Domain信息。 - 表6 BridgeDomainInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - Bridge Domain ID,主键,格式是uuid。创建时不填,自动生成,更新以及删除时必填。 "00000000-0000-0000-0000-000000000000" deviceId uuid - - 设备ID,格式是uuid。创建时必填。 "00000000-0000-0000-0000-000000000000" ports ARRAY_REFERENCE 0-64个列表项,详细请参见表7。 同一设备的二层端口信息列表,最大64个(包括增量和全量)。创建时必填。 - vlanId int32 [1-4094] - VLAN标识。创建时必填。网络编排资源中的属性cleanDefaultMngInterfaceConfig设置为true时,创建站点,创建TNP后,vlanId才可以指定为1。当VLAN被IpSubnet引用时,vlanId不允许修改。 2 description string 0~200个字符。 - Bridge Domain对应的描述。此功能仅用于展示,不下发配置到设备。 "description" configSource string 0~32个字符。 - 配置源信息,用于区分是WAN业务还是LanWan互联业务,仅查询接口使用,不能修改,取值范围:Wan、LanWan。 "Wan" 表7 BridgeDomainPortInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - 接口ID,主键,格式是uuid,ID为必填参数。 "00000000-0000-0000-0000-000000000000" interfaceName string 0~128个字符。 - 接口名称,创建时不填,查询时返回。 "GE0/0/0" tagMode string 0~16个字符。 tag 取值范围:tag、untag。新建、修改时必填。对于同一个二层物理口,多个BridgeDomain只能有一个为untag。 "tag" portLagFlag boolean true false false Lag标志位。使能时ID为Lag的ID,反之为Port的ID。 false isAutoNegotiation boolean true false - VLAN放通的接口是否是自动创建。 false 表8 FailBridgeDomainInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表6。 - - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/overlay-network/bridge-domains 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 { "bridgeDomains" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "ports" : [ { "id" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0", "tagMode" : "tag", "portLagFlag" : false, "isAutoNegotiation" : false } ], "vlanId" : 2, "description" : "description", "configSource" : "Wan" } ], "fullReplace" : false }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 bridgeDomainInfos 是 REFERENCE 详细请参见表2。 Bridge Domain的信息。 - 表2 BridgeDomainInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 bridgeDomains 否 ARRAY_REFERENCE 1-100个列表项,详细请参见表3。 Bridge Domain信息。 - fullReplace 否 boolean true false false 开关为true时,表示全量更新。Bridge Domain以本次入参为准,不在本次入参范围内的将会被删除。开关为false时,表示增量更新,只对本次操作的数据生效。参数不传与false的效果一致。该开关对创建与删除无效,仅更新操作有效。 false 表3 BridgeDomainInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - Bridge Domain ID,主键,格式是uuid。创建时不填,自动生成,更新以及删除时必填。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备ID,格式是uuid。创建时必填。 "00000000-0000-0000-0000-000000000000" ports 否 ARRAY_REFERENCE 0-64个列表项,详细请参见表4。 同一设备的二层端口信息列表,最大64个(包括增量和全量)。创建时必填。 - vlanId 否 int32 [1-4094] - VLAN标识。创建时必填。网络编排资源中的属性cleanDefaultMngInterfaceConfig设置为true时,创建站点,创建TNP后,vlanId才可以指定为1。当VLAN被IpSubnet引用时,vlanId不允许修改。 2 description 否 string 0~200个字符。 - Bridge Domain对应的描述。此功能仅用于展示,不下发配置到设备。 "description" configSource 否 string 0~32个字符。 - 配置源信息,用于区分是WAN业务还是LanWan互联业务,仅查询接口使用,不能修改,取值范围:Wan、LanWan。 "Wan" 表4 BridgeDomainPortInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 uuid - - 接口ID,主键,格式是uuid,ID为必填参数。 "00000000-0000-0000-0000-000000000000" interfaceName 否 string 0~128个字符。 - 接口名称,创建时不填,查询时返回。 "GE0/0/0" tagMode 否 string 0~16个字符。 tag 取值范围:tag、untag。新建、修改时必填。对于同一个二层物理口,多个BridgeDomain只能有一个为untag。 "tag" portLagFlag 否 boolean true false false Lag标志位。使能时ID为Lag的ID,反之为Port的ID。 false isAutoNegotiation 否 boolean true false - VLAN放通的接口是否是自动创建。 false
  • 响应示例 返回状态码为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
  • 请求示例 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-ACCESS-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。 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的示例 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:更新成功,响应体参考BatchReplaceDeviceCertificateResponseDto。 表3 BatchReplaceDeviceCertificateResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~64个字符。 - 错误码。 "0" errmsg string 0~64个字符。 - 错误信息。 "" 返回状态码为400:校验异常,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 请求示例 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:接口调用成功,响应体参考IpsecTunnelResponse,返回的除GRE Tunnel配置中仅包含对应的ID。 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" : [ { "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,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/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:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为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" : "" } 返回状态码为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的示例 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,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-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:修改成功。 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" : { "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:修改成功。 表3 CliSwitchPutResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表4。 - - 表4 CliSwitchDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 cliEnable boolean true false - 是否使能设备本地CLI配置开关。 false
  • 请求示例 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
  • 响应参数 返回状态码为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:参数非法,查询失败。 详细信息请参见实际响应消息体。
共100000条