华为云用户手册

  • 响应示例 返回状态码为200:配置成功,响应体参考ApplyPolicyResponse。 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" : "", "errparam" : "name", "processInstanceId" : "00000000-0000-0000-0000-000000000000" } 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考ApplyPolicyResponse。 HTTP/1.1 202 Accepted 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
  • 响应示例 返回状态码为200:修改控制器纳管非法设备防范功能开关成功,响应体参考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-device 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 { "controllerValidate" : "true" }
  • 请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-mpls-if:mpls-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" { "huawei-nce-e-mpls-if:mpls-if" : [ { "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" } ] }
  • 响应示例 返回状态码为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-mpls-if:mpls-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"
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-mpls-if:mpls-if 是 REFERENCE 详细请参见表4。 接口MPLS配置参数。 - 表4 nes-ne-mpls-if-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-mpls-if:mpls-if 否 ARRAY_REFERENCE 详细请参见表5。 接口MPLS配置参数。 - 表5 nes-ne-mpls-if对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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"
  • 请求示例 HTTP的示例 DELETE /controller/campus/v3/networkconfig/site/fbde1c5d-5b94-49e3-a912-48641015e45c/apssid 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" : [ "de5813f8ff1e41f5ba9c324da70b49ed" ] }
  • 响应示例 返回状态码为200:SSID删除成功,结构体参见DeleteSsidResponse。 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" : [ "de5813f8ff1e41f5ba9c324da70b49ed" ], "fail" : [ { "errcode" : "0302000020", "errmsg" : "The site ID format is incorrect or the site does not exist", "data" : "de5813f8ff1e41f5ba9c324da70b49ed" } ] } 返回状态码为204:SSID删除成功,结构体参见DeleteSsidResponse。 HTTP/1.1 204 No Content 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" : [ "de5813f8ff1e41f5ba9c324da70b49ed" ], "fail" : [ { "errcode" : "0302000020", "errmsg" : "The site ID format is incorrect or the site does not exist", "data" : "de5813f8ff1e41f5ba9c324da70b49ed" } ] }
  • 响应示例 返回状态码为200:更新文件返回结果。响应体参考UpdateFileInfoResponse 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" : "update file info success" } 返回状态码为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:更新文件返回结果。响应体参考UpdateFileInfoResponse 表4 UpdateFileInfoResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string - - 错误码。 0 : 无错误 1 : 参数校验或数据访问错误 详细信息见errMsg "0" errMsg string - - 错误信息。 "update file info success" 返回状态码为400:参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:服务内部错误。 详细信息请参见实际响应消息体。
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 FileUpdateInfo 是 REFERENCE 详细请参见表3。 更新文件信息 - 表3 UpdateFileInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 description 否 string 0~255个字符。 - 描述信息。 该字段对应UI页面上是:UI【描述】 "description" version 否 string 0~64个字符。 - 文件版本。 该字段对应UI页面上是:UI【版本】 "1"
  • 请求示例 HTTP的示例 PUT /controller/campus/baseservice/api/v1/filemgr/files/afed86db-49e1-4e81-a0e9-097f27372e16 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 { "description" : "description", "version" : "1" }
  • 请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:dhcpv4-global 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-dhcpv4:dhcpv4-global" : { "config-status" : "configured-database-success", "last-committed-time" : "2023-05-11 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "enable" : false, "option82" : { "global-formats" : { "global-format" : [ { "sub-option-type" : "remote-id", "option82-format" : "user-defined", "user-defind-text" : "77" } ] }, "encapsulation" : { "suboption" : "circuit-id remote-id subscriber-id vendor-specific-id" } } } }
  • 响应示例 返回状态码为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-dhcpv4:dhcpv4-global 表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"
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-dhcpv4:dhcpv4-global 是 REFERENCE 详细请参见表4。 全局DHCP配置。 - 表4 dhcpv4-global-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-dhcpv4:dhcpv4-global 否 REFERENCE 详细请参见表5。 全局DHCP配置。 - 表5 dhcpv4-global对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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个字符。 - 最后提交时间,该特性最后提交时间;不支持编辑,仅查询返回。 "2023-05-11 00:00:00" related-pkg-version 否 string 0~255个字符。 - 包版本,插件包版本;不支持编辑,仅查询返回。 "1.0.1" edit-state 否 string RUNNING CANDIDATE UNDEPLOYING UNDEPLOYED - 编辑状态,对应运行状态、候选状态、取消部署状态、未部署状态;不支持编辑,仅查询返回。 "RUNNING" enable 否 boolean true false false 使能全局DHCP。 false option82 否 REFERENCE 详细请参见表6。 配置DHCP option82特性。AR6700V主设备和AR6700V子设备不支持。 - 表6 option82对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 global-formats 否 REFERENCE 详细请参见表7。 Option82全局格式列表。 - encapsulation 否 REFERENCE 详细请参见表9。 配置DHCP Option82域子选项。 - 表7 global-formats对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 global-format 否 ARRAY_REFERENCE 详细请参见表8。 配置DHCP Option82全局模式。 - 表8 global-formats-global-format对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 sub-option-type 是 string circuit-id remote-id circuit-remote - DHCP option82全局子选项类型,单一主键字段。 "remote-id" option82-format 是 string common extend user-defined default type1 type2 self-define default-extra cn-telecom self-define-extra intracom-vxlan cn-telecom-inherit - DHCP option82子选项格式类型。 "user-defined" user-defind-text 否 string 0~255个字符。满足正则表达([^ ]{0,})。 - 用户定义DHCP Option82格式。关键词包含: sysname, portname, porttype, iftype, mac, slot, subslot, port, sVLAN, cVLAN,和length.可进行如下配置: '%portname:%sVLAN.%cVLAN %sysname/0/0/0/0/0' 或 0 %length %sVLAN %5slot %3subslot %8port 等等。请参考用户操作手册获取更多信息。 "77" 表9 encapsulation对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 suboption 否 string - circuit-id remote-id subscriber-id vendor-specific-id 配置DHCP Option82域子选项。 "circuit-id remote-id subscriber-id vendor-specific-id"
  • 响应示例 返回状态码为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/tunnel/mode 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 { "mode" : "EVPN", "enableSRPolicy" : true }
  • 响应参数 返回状态码为200:设置成功返回。 表3 CommonResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 tunnelModeDto 是 REFERENCE 详细请参见表2。 设置隧道模式。 - 表2 TunnelModeDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mode 是 string 0~8个字符。 - 隧道模式。取值范围:EVPN, IPSECVPN, SRV6。 "EVPN" enableSRPolicy 否 boolean true false false srv6模式下标记SR-Policy,开启:true,关闭:false。 true
  • 请求示例 HTTP的示例 PUT /controller/campus/api/v1/networkconfig/loopback/device/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-ACCESS-TOKEN: x-yyyyyy { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "id" : "fbb684c80d37496fbafa4b06d5151e2e", "deviceName" : "device1", "esn" : "1019A063325", "nameAllocMode" : "manual", "loopBackName" : "LoopBack1", "ipAddress" : "192.168.0.1", "mask" : 24, "description" : "description" }
  • 响应示例 返回状态码为200:修改Loopback配置成功,响应体参考LoopbackResponseDto。 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" : { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "id" : "fbb684c80d37496fbafa4b06d5151e2e", "deviceName" : "device1", "esn" : "1019A063325", "nameAllocMode" : "manual", "loopBackName" : "LoopBack1", "ipAddress" : "192.168.0.1", "mask" : 24, "description" : "description" } } 返回状态码为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:调用查询堆叠成功,响应体参考QueryStackIdsOutDtoData。 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" : [ { "deviceId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359cb", "stackId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359ca" } ] } 返回状态码为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:调用查询堆叠成功,响应体参考QueryStackIdsOutDtoData。 表3 QueryStackIdsOutDtoData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。当没有错误时返回0。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-1000个列表项,详细请参见表4。 设备ID和堆叠ID对应列表。 - 表4 StackIdsOutDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 1~64个字符。 - 设备ID,UUID格式。 "as25fdbf-8dee-4823-bac2-5bfe8e3359cb" stackId string 0~64个字符。 - 堆叠ID,UUID格式。 "as25fdbf-8dee-4823-bac2-5bfe8e3359ca" 返回状态码为400:调用查询堆叠接口入参非法,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:调用查询堆叠内部异常,无响应体。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v3/stack/ids/list 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 { "deviceIdList" : ["as25fdbf-8dee-4823-bac2-5bfe8e3359ca","as25fdbf-8dee-4823-bac2-5bfe8e3359cb"] }
  • 响应示例 返回状态码为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" : "", "networkVMsInfo" : [ { "vmId" : "00000000-0000-0000-0000-000000000000", "hostUnitId" : "00000000-0000-0000-0000-000000000000", "vmName" : "Forwarder", "vmStatus" : "active", "reason" : "", "vmCpuNumber" : "5", "vmCpuUsage" : "10%", "vmMemory" : "100", "vmMemoryUsage" : "10%", "cntrs" : [ { "cntrId" : "00000000-0000-0000-0000-000000000000", "cntrName" : "forward-ip-1", "cntrStatus" : "active", "cntrCpuUsage" : "IP", "cntrMemoryUsage" : "IP", "cntrInterfaces" : [ { "cnicId" : "00000000-0000-0000-0000-000000000000", "cnicName" : "GE0/0/1", "portPlane" : "outer-link", "dirverType" : "veth", "nfiName" : "GE0/0/1", "cnicIp" : "127.0.0.1" } ] } ] } ] } 返回状态码为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/sdwan/v1/naas/device/details?deviceId=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:查询成功返回。 表2 NaasNetworkDeviceDetailsResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 状态码,0:请求成功。 "0" errmsg string - - 接口调用的错误信息。 "" networkVMsInfo ARRAY_REFERENCE 详细请参见表3。 虚机资源 - 表3 NetworkFunctionVMInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 vmId string 0~128个字符。 - vm ID。 "00000000-0000-0000-0000-000000000000" hostUnitId string 0~128个字符。 - hostUnitId ID。 "00000000-0000-0000-0000-000000000000" vmName string 0~128个字符。 - vm 名称。 "Forwarder" vmStatus string 0~32个字符。 - vm运行状态。unknown:未知, active:激活, stopped:停止, building:构建中, error:故障, timeout:超时。 "active" reason string 0~10000个字符。 - 状态异常原因。 - vmCpuNumber string 0~32个字符。 - CPU 个数。 "5" vmCpuUsage string 0~32个字符。 - CPU利用率。 "10%" vmMemory string 0~32个字符。 - 内存。 "100" vmMemoryUsage string 0~32个字符。 - 内存利用率。 "10%" cntrs ARRAY_REFERENCE 1-1000个列表项,详细请参见表4。 服务容器。 - 表4 NetworkFunctionCntr对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 cntrId string 0~128个字符。 - 容器ID。 "00000000-0000-0000-0000-000000000000" cntrName string 0~128个字符。 - 容器名称。 "forward-ip-1" cntrStatus string 0~32个字符。 - 容器运行状态。unknown:未知, created:创建中, running:运行中, paused:暂停, restarting:重启中, removing:移除中, exited:退出, dead:终止。 "active" cntrCpuUsage string 0~32个字符。 - 容器CPU利用率。 "IP" cntrMemoryUsage string 0~32个字符。 - 容器内存利用率。 "IP" cntrInterfaces ARRAY_REFERENCE 1-1000个列表项,详细请参见表5。 容器接口。 - 表5 CntrInterface对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 cnicId string 0~128个字符。 - 接口ID。 "00000000-0000-0000-0000-000000000000" cnicName string 0~128个字符。 - 接口名称。 "GE0/0/1" portPlane string 0~32个字符。 - 端口业务面。 "outer-link" dirverType string 0~32个字符。 - 驱动类型。 "veth" nfiName string 0~32个字符。 - 接口名称。 "GE0/0/1" cnicIp string 0~128个字符。 - 接口IP地址。 "127.0.0.1" 返回状态码为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" : "", "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
共100000条
提示

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