华为云用户手册

  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 queryDynamicQosDetailRequest 是 REFERENCE 详细请参见表3。 创建动态QoS策略请求数据。 - 表3 DeleteDynamicQosRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policyIds 否 ARRAY_REFERENCE 0-16个列表项,详细请参见表4。 动态QoS策略id列表。 - 表4 DeleteDynamicQosPolicyDetail对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policyId 否 uuid 0~64个字符。 - 动态QoS策略id。 "00000000-0000-0000-0000-000000000000" policyName 否 string 0~64个字符。 - 动态QoS策略Name。 "policy"
  • 响应示例 返回状态码为200:查询成功,响应体参考QueryTaskRsp。 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-000000000000", "createTime" : 1616828400000, "status" : "0", "failureReason" : "", "startTime" : 1616824800000, "endTime" : 1616828400000 } ] } 返回状态码为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/sdwan/performance/spr-statistics/export-task 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
  • 响应参数 返回状态码为200:查询成功,响应体参考QueryTaskRsp。 表1 QueryTaskRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码,成功返回0 "0" errmsg string - - 错误信息 "" data ARRAY_REFERENCE 详细请参见表4。 返回数据 - 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-queue-template:port-queue-template/Port+Queue+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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000" { "huawei-nce-e-queue-template:port-queue-template" : [ { "config-status" : "reserved", "last-committed-time" : "last-committed-time", "related-pkg-version" : "related-pkg-version", "edit-state" : "RUNNING", "name" : "Port Queue Template", "queue" : [ { "service-class" : "be", "port-wred-name" : "Port wred name", "queue-schedule-mode" : "pq", "weight" : 10, "pbs" : 65534, "low-latency" : "enable", "shaping-value" : 64, "shaping-percentage" : 10, "cir-schedule-mode" : "pq", "pir-schedule-mode" : "pq", "pir-weight" : 10, "cbs" : 65534, "pir-pbs" : 65534, "cir-value" : 10, "pir-value" : 10, "cir-percentage" : 10, "pir-percentage" : 10 } ] } ] }
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-queue-template:port-queue-template/{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" name 是 string 1~31个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - 名称,单一主键字段。 "Port Queue Template"
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-queue-template:port-queue-template 是 REFERENCE 详细请参见表4。 端口队列模板。 -
  • 响应示例 返回状态码为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
  • 响应参数 返回状态码为200:上下电成功,响应体参考PowerSupplyOutputDto。 表3 PowerSupplyOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码:当没有错误时返回0。 "0" errmsg string 0~256个字符。 - 接口调用结果的描述信息。 "error" 返回状态码为400:校验异常,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v1/oamservice/powersupply 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" : "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2", "frameNo" : "1", "boardName" : "LPU5", "operation" : "on" }
  • 响应示例 返回状态码为200:上下电成功,响应体参考PowerSupplyOutputDto。 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" : "error" } 返回状态码为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参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 request 是 REFERENCE 详细请参见表2。 请求参数。 - 表2 PowerSupplyDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备ID,UUID格式。 "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2" frameNo 是 integer 1 2 - 机框号。 "1" boardName 是 string 1~36个字符。 - 单板名称。 "LPU5" operation 是 string 1~36个字符。 - 上下电操作。取值范围:on---代表上电,off---代表下电。 "on"
  • 响应示例 返回状态码为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-queue-template:port-queue-template" : [ { "config-status" : "reserved", "last-committed-time" : "last-committed-time", "related-pkg-version" : "related-pkg-version", "edit-state" : "RUNNING", "name" : "Port Queue Template", "queue" : [ { "service-class" : "be", "port-wred-name" : "Port wred name", "queue-schedule-mode" : "pq", "weight" : 10, "pbs" : 65534, "low-latency" : "enable", "shaping-value" : 64, "shaping-percentage" : 10, "cir-schedule-mode" : "pq", "pir-schedule-mode" : "pq", "pir-weight" : 10, "cbs" : 65534, "pir-pbs" : 65534, "cir-value" : 10, "pir-value" : 10, "cir-percentage" : 10, "pir-percentage" : 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
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-queue-template:port-queue-template 表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:操作成功。 表3 port-queue-template-list对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-queue-template:port-queue-template ARRAY_REFERENCE 详细请参见表4。 端口队列模板。 - 表4 nes-ne-port-queue-template对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 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~31个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - 名称,单一主键字段。 "Port Queue Template" queue ARRAY_REFERENCE 0-8个列表项,详细请参见表5。 端口队列。 - 表5 nes-ne-port-queue-template-queue对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 service-class string be af1 af2 af3 af4 ef cs6 cs7 - 服务等级,单一主键字段。 "be" port-wred-name string 1~31个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - WRED模板。 "Port wred name" queue-schedule-mode string pq wfq lpq - 队列调度模式。 "pq" weight int32 [1-100] - 权重。 10 pbs int64 [1-65535] - 峰值突发尺寸(Byte)。 65534 low-latency string enable - 低时延。 "enable" shaping-value int64 [0-4294967294] - 整形值。 64 shaping-percentage int32 [0-100] - 整形百分比。 10 cir-schedule-mode string pq - 承诺调度模式。 "pq" pir-schedule-mode string pq wfq lpq - 峰值调度模式。 "pq" pir-weight int32 [1-100] - 峰值权重。 10 cbs int64 [1-65535] - 承诺突发尺寸。 65534 pir-pbs int64 [1-65535] - 峰值速率-峰值突发尺寸。 65534 cir-value int64 [0-4294967294] - 承诺速率。 10 pir-value int64 [0-4294967294] - 峰值速率。 10 cir-percentage int32 [0-100] - 承诺百分比。 10 pir-percentage int32 [0-100] - 峰值百分比。 10 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-queue-template:port-queue-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 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 { "errcode" : "0", "errmsg" : "", "data" : { "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" : "" } } 返回状态码为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:查询成功返回。 表2 NaasNetworkResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表3。 NaasNetwork返回体。 - 表3 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 详细请参见表4。 服务功能。 - networkResources REFERENCE 详细请参见表6。 资源。 - networkFunctions REFERENCE 详细请参见表8。 服务功能。 - initialLoadBalanceNumber int32 [1-8] 3 部署1个子设备的forwarder个数。 - bandwidthRedundancy int32 [0-300] 50 带宽冗余度。 - nodeMaxDeviceNumber int32 [1-1000] 512 每个forwarder部署的子设备最大数量。 - 表4 NetworkInfrastructure对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 subnet ARRAY_REFERENCE 1-16个列表项,详细请参见表5。 地址池。 - 表5 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" 表6 NetworkResources对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 resources ARRAY_REFERENCE 2个列表项,详细请参见表7。 服务链资源组。 - 表7 NetworkResource对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 hostUnitType string 1~32个字符。 - 取值为director或者forwarder,且director与forwarder必须同时填写。 "director" number int32 [1-150] - 资源数量。 24 表8 NetworkFunctions对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 networkFunction ARRAY_REFERENCE 1个列表项,详细请参见表9。 服务组。 - 表9 NetworkFunction对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 interfaces ARRAY_REFERENCE 1-16个列表项,详细请参见表10。 服务接口组。 - 表10 NetworkFunctionInterface对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nfiName string 1~64个字符。 - 服务名称。 "GE0/0/1" subnetName string 1~127个字符。 - 子网名称 "subnet" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/sdwan/v1/naas/template?naasNetworkId=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
  • 响应示例 返回状态码为201:接口调用成功,响应体参考ExternalPortResponse。 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" : "", "success" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "name" : "Connect to PE", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "portId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "isSubInterface" : true, "vlanId" : 2, "isEnableMpls" : true, "ipConnection" : { "ipv4" : { "ipMode" : "Static", "customerAddress" : "192.168.0.1", "prefixLength" : 24 } }, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "description" : "" } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "name" : "Connect to PE", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "portId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "isSubInterface" : true, "vlanId" : 2, "isEnableMpls" : true, "ipConnection" : { "ipv4" : { "ipMode" : "Static", "customerAddress" : "192.168.0.1", "prefixLength" : 24 } }, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "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
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/overlay-network/external-ports 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 { "externalPorts" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "name" : "Connect to PE", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "portId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "isSubInterface" : true, "vlanId" : 2, "isEnableMpls" : true, "ipConnection" : { "ipv4" : { "ipMode" : "Static", "customerAddress" : "192.168.0.1", "prefixLength" : 24 } }, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "description" : "" } ] }
  • 响应参数 返回状态码为201:接口调用成功,响应体参考ExternalPortResponse。 表7 ExternalPortResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项,详细请参见表8。 创建或者更新成功的外部接口信息。 - fail ARRAY_REFERENCE 0-100个列表项,详细请参见表12。 创建或者更新失败的外部接口信息。 - 表8 ExternalPortInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - ExternalPort ID,创建时不填,自动生成,更新时必填。格式是uuid。 "fbb684c8-0d37-496f-bafa-4b06d515a7l6" name string 0~64个字符。 - 外部接口名称。创建时必填。 "Connect to PE" siteId uuid - - 站点ID。创建时必填。格式是uuid。 "fbb684c8-0d37-496f-bafa-4b06d515a7l6" deviceId uuid - - 设备ID。创建时必填。格式是uuid。 "fbb684c8-0d37-496f-bafa-4b06d515a7l6" portId uuid - - 物理端口ID。格式是uuid。 "fbb684c8-0d37-496f-bafa-4b06d515a7l6" isSubInterface boolean true false false 是否子接口。 true vlanId int32 [1-4094] - 子接口号。 2 isEnableMpls boolean true false - 接口是否使能mpls。创建时,默认值为false。 true ipConnection REFERENCE 详细请参见表9。 外部接口的ip链接信息。 - attributes REFERENCE 详细请参见表11。 外部接口属性。 - description string 0~200个字符。 - ExternalPort对应的描述。 - 表9 ExternalPortIpConnection对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ipv4 REFERENCE 详细请参见表10。 Ipv4外部接口信息。 - 表10 ExternalPortIpv4对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ipMode string 4~6个字符。 - ip分配模式:Static。创建时必填。 "Static" customerAddress string 0~15个字符。 - IP地址。 "192.168.0.1" prefixLength int32 [1-32] - 掩码。 24 表11 ExternalPortAttributes对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 mtu int32 [68-9202] 1500 MTU 取值范围:68-9202,默认1500。 1500 TCPmss int32 [128-2048] 1200 TCPmss 取值范围:128-2048,默认1200。 1200 表12 FailExternalPortInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表8。 - - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 externalPortInfos 是 REFERENCE 详细请参见表2。 外部接口信息 - 表2 ExternalPortInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 externalPorts 否 ARRAY_REFERENCE 1-100个列表项,详细请参见表3。 - - 表3 ExternalPortInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - ExternalPort ID,创建时不填,自动生成,更新时必填。格式是uuid。 "fbb684c8-0d37-496f-bafa-4b06d515a7l6" name 否 string 0~64个字符。 - 外部接口名称。创建时必填。 "Connect to PE" siteId 否 uuid - - 站点ID。创建时必填。格式是uuid。 "fbb684c8-0d37-496f-bafa-4b06d515a7l6" deviceId 否 uuid - - 设备ID。创建时必填。格式是uuid。 "fbb684c8-0d37-496f-bafa-4b06d515a7l6" portId 否 uuid - - 物理端口ID。格式是uuid。 "fbb684c8-0d37-496f-bafa-4b06d515a7l6" isSubInterface 否 boolean true false false 是否子接口。 true vlanId 否 int32 [1-4094] - 子接口号。 2 isEnableMpls 否 boolean true false - 接口是否使能mpls。创建时,默认值为false。 true ipConnection 否 REFERENCE 详细请参见表4。 外部接口的ip链接信息。 - attributes 否 REFERENCE 详细请参见表6。 外部接口属性。 - description 否 string 0~200个字符。 - ExternalPort对应的描述。 - 表4 ExternalPortIpConnection对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipv4 否 REFERENCE 详细请参见表5。 Ipv4外部接口信息。 - 表5 ExternalPortIpv4对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipMode 否 string 4~6个字符。 - ip分配模式:Static。创建时必填。 "Static" customerAddress 否 string 0~15个字符。 - IP地址。 "192.168.0.1" prefixLength 否 int32 [1-32] - 掩码。 24 表6 ExternalPortAttributes对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mtu 否 int32 [68-9202] 1500 MTU 取值范围:68-9202,默认1500。 1500 TCPmss 否 int32 [128-2048] 1200 TCPmss 取值范围:128-2048,默认1200。 1200
  • 响应示例 返回状态码为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
  • 请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-bd:bd/10 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-bd:bd" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "bd-id" : 10, "vni" : 10, "vlan-id" : 10, "split-horizon" : "disable" } ] }
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-bd:bd/{bd-id} 表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" bd-id 是 int64 [1-16777215] - Bridge Domain ID,单一主键字段。 "10"
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bd:bd 是 REFERENCE 详细请参见表4。 Bridge Domain配置参数。 -
  • 响应示例 返回状态码为201:创建成功,响应体参考CentralizedAccessBatchResponse。 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" : "", "success" : [ { "areaId" : "00000000-0000-0000-0000-000000000000", "areaName" : "area_1", "description" : "centralized access", "centralizedSiteInfos" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "priority" : "1" } ], "enableIpv6" : false } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "areaId" : "00000000-0000-0000-0000-000000000000", "areaName" : "area_1", "description" : "centralized access", "centralizedSiteInfos" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "priority" : "1" } ], "enableIpv6" : false } } ], "processInstanceId" : "" } 返回状态码为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:创建成功,响应体参考CentralizedAccessBatchResponse。 表4 CentralizedAccessBatchResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-2000个列表项,详细请参见表6。 成功的集中上网策略信息列表。 - fail ARRAY_REFERENCE 0-2000个列表项,详细请参见表5。 失败的集中上网策略信息列表。 - processInstanceId string 0~36个字符。 - 编排流程实例ID,UUID格式。当接口返回码为202时非空。 - 表5 FailCentralizedAccessInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0x00c8000c" errmsg string - - 错误信息。 "The parameter is invalid." data REFERENCE 详细请参见表6。 失败的集中上网策略请求体 - 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 centralizedAccessInfos 是 REFERENCE 详细请参见表3。 创建集中上网配置请求数据。 - 表3 CentralizedAccessInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 centralizedAccessInfo 否 ARRAY_REFERENCE 1-100个列表项,详细请参见表3。 集中上网策略添加或者更新的请求体。 -
共100000条
提示

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