所选语种没有对应资源,请选择:

本站点使用Cookies,继续浏览表示您同意我们使用Cookies。Cookies和隐私政策>

提示

尊敬的用户,您的IE浏览器版本过低,为获取更好的浏览体验,请升级您的IE浏览器。

升级

CloudEngine 12800, 12800E V200R005C10 RESTful API参考

本文档介绍了设备支持的OPS API,内容包含OPS 支持的操作、请求示例、请求中元素说明、响应示例、响应中元素说明和响应状态码说明。
评分并提供意见反馈 :
华为采用机器翻译与人工审校相结合的方式将此文档翻译成不同语言,希望能帮助您更容易理解此文档的内容。 请注意:即使是最好的机器翻译,其准确度也不及专业翻译人员的水平。 华为对于翻译的准确性不承担任何责任,并建议您参考英文文档(已提供链接)。
路由

路由

创建静态路由

操作

URI

描述

POST

/staticrt/staticrtbase/srRoutes

创建一条静态路由。

  • 请求示例:
    <?xml version="1.0" encoding="UTF-8"?>
           <srRoutes> 
              <srRoute> 
                 <vrfName>_public_</vrfName> 
                 <afType>ipv4unicast</afType> 
                 <topologyName>base</topologyName> 
                 <prefix>10.111.111.77</prefix> 
                 <maskLength>24</maskLength> 
                 <ifName>Ether3/0/0</ifName> 
                 <destVrfName>_public_</destVrfName> 
                 <nexthop>0.0.0.0</nexthop> 
                 <description></description> 
                 <preference></preference> 
                 <tag></tag> 
                 <bfdEnable>false</bfdEnable> 
                 <sessionName></sessionName> 
                 <trackNqaAdminName></trackNqaAdminName> 
                 <trackNqaTestName></trackNqaTestName> 
                 <isInheritCost>false</isInheritCost> 
                 <isPermanent>false</isPermanent> 
                 <trackEfmIfName>Invalid0</trackEfmIfName> 
                 <isRelayHostRoute>false</isRelayHostRoute> 
              </srRoute> 
           </srRoutes>

    请求中元素说明如表28-1所示。

    表28-1 请求中元素说明

    元素

    描述

    vrfName

    VPN实例名。

    afType

    地址族类型。

    topologyName

    拓扑名。

    prefix

    目的网络地址。

    maskLength

    掩码长度。

    ifName

    出接口。

    destVrfName

    下一跳VPN实例名。

    nexthop

    下一跳地址。

    description

    描述信息。

    preference

    优先级。

    tag

    TAG属性。

    bfdEnable

    使能动态BFD。

    sessionName

    静态BFD会话名。

    trackNqaAdminName

    NQA测试例管理者名称。

    trackNqaTestName

    NQA测试例名称。

    isInheritCost

    继承迭代路由cost。

    isPermanent

    是否永久活跃。

    trackEfmIfName

    EFM接口名称。

    isRelayHostRoute

    是否迭代主机路由。

  • 响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?> 
        <ok/>

    响应状态码说明如表28-2所示。

    表28-2 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

    无法执行请求操作,请求消息语法错误,或者请求消息中信息的属性不合法。

    500 Internal Server Error

    服务的各种内部异常导致请求操作失败,或者无法识别的处理异常。

删除静态路由

操作

URI

描述

DELETE

/staticrt/staticrtbase/srRoutes

删除一条静态路由。

  • 请求示例:
    <?xml version="1.0" encoding="UTF-8"?>
    <srRoutes>
    <srRoute>
    <vrfName>_public_</vrfName>
    <afType>ipv4unicast</afType>
    <topologyName>base</topologyName>
    <prefix>10.111.111.77</prefix>
    <maskLength>24</maskLength>
    <ifName>Ethernet3/0/1</ifName>
    <destVrfName>_public_</destVrfName>
    <nexthop>1.1.1.1</nexthop>
    </srRoute>
    </srRoutes>

    请求中元素说明如表28-3所示。

    表28-3 请求中元素说明

    元素

    描述

    vrfName

    VPN实例名。

    afType

    地址族类型。

    topologyName

    拓扑名。

    prefix

    目的网络地址。

    maskLength

    掩码长度。

    ifName

    出接口。

    destVrfName

    下一跳VPN实例名。

    nexthop

    下一跳地址。

  • 响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?> 
        <ok/>

    响应状态码说明如表28-4所示。

    表28-4 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

    无法执行请求操作,请求消息语法错误,或者请求消息中信息的属性不合法。

    500 Internal Server Error

    服务的各种内部异常导致请求操作失败,或者无法识别的处理异常。

查询基本路由表

操作

URI

描述

GET

/rm/rmbase/uniAfs/uniAf

查询基本路由表。

  • 请求示例:
    <?xml version="1.0" encoding="UTF-8"?> 
     <uniAf> 
         <vrfName></vrfName> 
         <afType>ipv4unicast</afType> 
         <topologys> 
             <topology> 
                 <topologyName></topologyName> 
                 <routes> 
                     <route> 
                         <prefix></prefix> 
                         <maskLength></maskLength> 
                         <protocolId></protocolId> 
                         <preference></preference> 
                         <cost></cost> 
                         <flags></flags> 
                         <nextHop></nextHop> 
                         <ifName></ifName> 
                         <relayNexthop></relayNexthop> 
                         <processId></processId> 
                         <frrType></frrType> 
                         <directNexthop></directNexthop> 
                     </route> 
                 </routes> 
             </topology> 
         </topologys> 
     </uniAf>

    请求中元素说明如表28-5所示。

    表28-5 请求中元素说明

    元素

    描述

    vrfName

    VPN实例名。

    afType

    地址族类型。

    topologyName

    拓扑名。

    prefix

    目的网络地址。

    maskLength

    掩码长度。

    protocolId

    路由协议

    preference

    优先级。

    cost

    路由开销。

    flags

    路由标记,即路由表头的Route Flags。

    nextHop

    下一跳地址。

    ifName

    出接口。

    relayNexthop

    迭代下一跳地址。

    processId

    路由协议的进程号。

    frrType

    FRR类型。

    directNexthop

    直连下一跳地址。

  • 响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?> 
     <uniAf> 
         <vrfName>_public_</vrfName> 
         <afType>ipv4unicast</afType> 
         <topologys> 
            <topology> 
                <topologyName>base</topologyName> 
                <routes> 
                    <route> 
                        <maskLength>32</maskLength> 
                        <protocolId>Direct</protocolId> 
                        <processId>0</processId> 
                        <preference>0</preference> 
                        <cost>0</cost> 
                        <ifName>InLoopBack0</ifName> 
                        <flags>D</flags> 
                        <frrType>Primary</frrType> 
                        <prefix>255.255.255.255</prefix> 
                        <relayNexthop>0.0.0.0</relayNexthop> 
                        <nextHop>127.0.0.1</nextHop> 
                        <directNexthop>127.0.0.1</directNexthop> 
                    </route> 
                </routes> 
            </topology> 
         </topologys> 
     </uniAf>

    响应元素说明如表28-6所示。

    表28-6 响应元素说明

    元素

    描述

    vrfName

    VPN实例名。

    afType

    地址族类型。

    topologyName

    拓扑名。

    prefix

    目的网络地址。

    maskLength

    掩码长度。

    protocolId

    路由协议

    preference

    优先级。

    cost

    路由开销。

    flags

    路由标记,即路由表头的Route Flags。

    nextHop

    下一跳地址。

    ifName

    出接口。

    relayNexthop

    迭代下一跳地址。

    processId

    路由协议的进程号。

    frrType

    FRR类型。

    directNexthop

    直连下一跳地址。

    响应状态码说明如表28-7所示。

    表28-7 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

    无法执行请求操作,请求消息语法错误,或者请求消息中信息的属性不合法。

    500 Internal Server Error

    服务的各种内部异常导致请求操作失败,或者无法识别的处理异常。

创建路由策略

操作

URI

描述

edit-config:create

/rtp/routePolicys

创建路由策略。

  • 请求示例:
<?xml version="1.0" encoding="UTF-8"?>   
<routePolicy>
   <name>aa</name>
   <routePolicyNodes>
      <routePolicyNode operation="create">
          <nodeSequence>10</nodeSequence>
          <matchMode>permit</matchMode>
          <description>aa</description>
       </routePolicyNode>
    </routePolicyNodes>
</routePolicy>
  • 响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?>
    <routePolicy>
       <name>aa</name>
       <routePolicyNodes>
          <routePolicyNode>
              <nodeSequence></nodeSequence>
              <matchMode></matchMode>
              <description></description>
           </routePolicyNode>
       </routePolicyNodes>
    </routePolicy>

请求与响应中元素说明如表28-8所示

表28-8 响应元素说明

元素

描述

取值范围

元素可选性

name

策略名,字符串形式。

字符串形式,长度范围是1~40。

必选

nodeSequence

节点序列号,为该表主键。

整数形式,取值范围是1~4294967295。缺省情况下,该序号值按照配置先后顺序依次递增,每次加10,第一个序号值为10。

说明:

一个地址前缀列表最多支持配置65535个index。

必选

matchMode

匹配模式。

匹配模式:

permit:指定地址前缀列表的匹配模式为允许。在该模式下,如果过滤的IP地址在定义的范围内,则通过过滤,进行相应的设置;否则,必须进行下一节点的测试。

可选

description

路由策略的描述信息。

字符串形式,长度范围是0~80。

可选

创建ip-prefix过滤器

操作

URI

描述

edit-config:create

/rtp/prefixFilters/prefixFilter

创建过滤器ip-prefix。

  • 请求示例:
<?xml version="1.0" encoding="UTF-8"?>   
<prefixFilter operation="create">   
    <name>prefix</name>   
    <prefixFilterNodes>   
        <prefixfilternode operation="merge">   
            <nodesequence>10</nodesequence>   
            <matchmode>permit</matchmode>   
            <address>192.168.1.10</address>   
            <masklength>0</masklength>     
        </prefixfilternode>   
    </prefixFilterNodes>   
</prefixFilter>
  • 响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?> 
     <prefixFilter>
          <name>prefix</name>
          <prefixFilterNodes>
           <prefixFilterNode>
              <nodeSequence>10</nodeSequence>
              <matchMode>permit</matchMode>
              <address>192.168.1.10</address>
              <maskLength>0</maskLength>
            </prefixFilterNode>
          </prefixFilterNodes>
      </prefixFilter>
    

请求与响应中元素说明如表28-9所示

表28-9 响应元素说明

元素

描述

取值范围

元素可选性

name

指定地址前缀列表的名称。

该名称必须唯一。字符串形式,区分大小写,不支持空格,不支持问号“?”,取值范围是1~169。

必选

nodeSequence

节点序列号,为该表主键。

整数形式,取值范围是1~4294967295。缺省情况下,该序号值按照配置先后顺序依次递增,每次加10,第一个序号值为10。

说明:

一个地址前缀列表最多支持配置65535个index。

必选

matchMode

匹配模式。

匹配模式:

permit:指定地址前缀列表的匹配模式为允许。在该模式下,如果过滤的IP地址在定义的范围内,则通过过滤,进行相应的设置;否则,必须进行下一节点的测试。

可选

address

IPv4地址。

点分十进制格式。

可选

maskLength

掩码长度。

整数形式,取值范围是0~32。

可选

matchNetwork

匹配网段地址。

参数参考下列关键字:

true:匹配网段地址。

false:不匹配网段地址。

可选

greaterEqual

最小掩码长度。

整数形式,参数greaterEqual的取值限制为:maskLength<=greaterEqual<=lessEqual<=32。

可选

lessEqual

最大掩码长度。

整数形式,参数greaterEqual的取值限制为:maskLength<=greaterEqual<=lessEqual<=32。

可选

翻译
下载文档
更新时间:2019-04-03

文档编号:EDOC1100075559

浏览量:2593

下载量:44

平均得分:
本文档适用于这些产品
相关文档
相关版本
分享
上一页 下一页