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

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

提示

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

升级

CloudEngine 12800, 12800E V200R005C10 RESTful API参考

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

LSP Ping

发起LSP Ping

操作

URI

描述

POST

/dgntl/lsp/startLspPing

发起LSP Ping检测。

  • 请求示例:
    <?xml version="1.0" encoding="UTF-8"?>
              <startLspPing>
                <testName>lsp_ping</testName>
                <testIndex>0</testIndex>
                <tunnelName>Tunnel1/0/0</tunnelName>
              </startLspPing>

    请求中元素说明如表22-25所示。

    表22-25 请求中元素说明

    元素

    描述

    testName

    测试名称。

    testIndex

    测试索引。

    tunnelName

    隧道名称。

    packetCount

    测试报文发送的个数。

    exp

    MPLS 报文中的标签字段的EXP值。用来区分MPLS报文的服务类型。

    ttl

    测试报文的最大TTL。

    interval

    测试报文发送的时间间隔,单位是毫秒。

    replyMode

    测试例应答报文的回复方式。

    packetSize

    测试报文发送的字节数,单位是字节。

    timeout

    测试报文的超时时间,单位是毫秒。测试超时时间是指发送完探测报文后,等待响应报文的时间,如果超过此时间没有收到响应报文,则认为报文超时。

    lspType

    Lsp类型,用于区分te和bgp。

    destIpAddr

    目的地址。

    maskLen

    掩码长度。

    loopbackAddress

    MPLS Ping报文IP头的目的地址,前缀为127.0.0.0/8。

    lspPath

    Lsp路径。

    apId

    Ap编号。

    apAddress

    Ap地址。

    lspPathNv

    Lsp路径的类型:“working”表示当前工作隧道,“primary”表示主隧道,“hotStandby”表示备隧道。

    vaTunnelName

    虚拟隧道名称。

    fragmentFlag

    设置报文分片标志。

    srTeVersion

    SR-TE版本:“RFC4379”表示报文中封装NilFec,“DRAFT”表示报文中封装RSVP IPV4。

    sourceIpAddr

    源IP地址。

    autoTunnelName

    auto-tunnel隧道名称。

    compatibleModeFlag

    compatible-mode 标识,互通兼容。

    remoteIpAddr

    远端IP地址

  • 响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?>
    <rpc-reply message-id="801" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
      <ok/>
    </rpc-reply>

    响应状态码说明如表22-26所示。

    表22-26 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

停止LSP Ping

操作

URI

描述

POST

/dgntl/lsp/stopLspPing

停止LSP Ping检测。

  • 请求示例:
    <?xml version="1.0" encoding="UTF-8"?>
              <stopLspPing>
                <testName>lsp_ping</testName>
              </stopLspPing>

    请求中元素说明如表22-27所示。

    表22-27 请求中元素说明

    元素

    描述

    testName

    停止LSP Ping检测的名称,必选参数。

  • 响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?>
    <rpc-reply message-id="801" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
      <ok/>
    </rpc-reply>

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

    表22-28 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

删除LSP Ping

操作

URI

描述

POST

/dgntl/lsp/deleteLspPing

删除LSP Ping检测。

  • 请求示例:
    <?xml version="1.0" encoding="UTF-8"?>
              <deleteLspPing>
                <testName>lsp_ping</testName>
              </deleteLspPing>

    请求中元素说明如表22-29所示。

    表22-29 请求中元素说明

    元素

    描述

    testName

    删除LSP Ping检测的名称,必选参数。

  • 响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?>
    <rpc-reply message-id="801" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
      <ok/>
    </rpc-reply>

    响应状态码说明如表22-30所示。

    表22-30 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

查询LSP Ping

操作

URI

描述

GET

/dgntl/lsp/lspPingResults

查询所有LSP Ping结果。

GET

/dgntl/lsp/lspPingResults

查询单个LSP Ping结果。

  • 请求示例:
    <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1">
              <lspPingResults>
                <lspPingResult>
                  <testName></testName>
                  <tunnelName/>
                  <packetSend/>
                  <packetRecv/>
                  <lossRatio/>
                  <rttMin/>
                  <rttMax/>
                  <rttAverage/>
                  <status/>
                  <errorType/>
                </lspPingResult>
              </lspPingResults>
    </rpc>
    查询单个结果
    <rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1">
           <lspPingResults>
                <lspPingResult>
                  <testName>12</testName>
                  <tunnelName/>
                  <packetSend/>
                  <packetRecv/>
                  <lossRatio/>
                  <rttMin/>
                  <rttMax/>
                  <rttAverage/>
                  <status/>
                  <errorType/>
                </lspPingResult>
         </lspPingResults>
    </rpc>

    请求中元素说明如表22-31所示。

    表22-31 请求中元素说明

    元素

    描述

    testName

    查询LSP Ping检测的名称,必选参数。

    packetRecv

    收到的报文个数。

    packetSend

    发送的报文个数。

    lossRatio

    丢包率。

    rttMin

    最小时延。

    rttMax

    最大时延。

    rttAverage

    平均时延。

    status

    检测状态:

    • finished:结束
    • processing:进行中

    errorType

    结果类型:

    • success:成功
    • failed:失败

  • 成功响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?>
            <lspPingResults>
              <lspPingResult>
                <testName>lsp_ping</testName>
                <tunnelName>Tunnel1/0/0</tunnelName>
                <packetSend>5</packetSend>
              </lspPingResult>
            </lspPingResults>

    响应元素说明如表22-32所示。

    表22-32 响应元素说明

    元素

    描述

    testName

    查询到的LSP Ping检测的名称。

    packetRecv

    收到的报文个数。

    packetSend

    发送的报文个数。

    lossRatio

    丢包率。

    rttMin

    最小时延。

    rttMax

    最大时延。

    rttAverage

    平均时延。

    status

    检测状态:

    • finished:结束
    • processing:进行中

    errorType

    结果类型:

    • success:成功
    • failed:失败

    响应状态码说明如表22-33所示。

    表22-33 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

查询LSP Ping的详细结果

操作

URI

描述

GET

/dgntl/lsp/lspPingResults/lspPingResult

查询LSP Ping的详细结果。

  • 请求示例:
    <?xml version='1.0' encoding='UTF-8'?>
                <lspPingResult>
                  <testName>lspping</testName>
                  <tunnelName></tunnelName>
                  <packetSend></packetSend>
                  <packetRecv></packetRecv>
                  <lossRatio></lossRatio>
                  <rttMin></rttMin>
                  <rttMax></rttMax>
                  <rttAverage></rttAverage>
                  <status></status>
                  <errorType></errorType>
                    <pingResultDetails>
                      <pingResultDetail>
                        <testName>lspping</testName>
                      </pingResultDetail>
                    </pingResultDetails>
                </lspPingResult>

    请求中元素说明如表22-34所示。

    表22-34 请求中元素说明

    元素

    描述

    testName

    查询LSP Ping检测的名称,必选参数。

    index

    报文索引,必选参数。

    destIpAddr

    测试对应Hop的目的地址。

    packetSize

    报文的字节大小。

    ttl

    报文的TTL值。

    rtt

    时延。

    isDelete

    检测是否被删除。

    resultType

    结果类型:

    • success:成功
    • timeout:超时
    • failed:失败

  • 成功响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?>
              <lspPingResult>
                <testName>lspping</testName>
                  <tunnelName/>
                    <packetSend>5</packetSend>
                    <packetRecv>5</packetRecv>
                    <lossRatio>0</lossRatio>
                    <rttMin>2</rttMin>
                    <rttMax>12</rttMax>
                    <rttAverage>4</rttAverage>
                    <status>finished</status>
                    <errorType>success</errorType>
                      <pingResultDetails>
                        <pingResultDetail>
                          <testName>lspping</testName>
                          <index>1</index>
                          <destIpAddr>2.2.2.9</destIpAddr>
                          <rtt>12</rtt>
                          <ttl>255</ttl>
                          <retCode>3</retCode>
                          <subCode>1</subCode>
                          <isDelete>false</isDelete>
                          <resultType>success</resultType>
                          <packetSize>100</packetSize>
                          <destIpv6Addr>::</destIpv6Addr>
                        </pingResultDetail>
                        <pingResultDetail>
                          <testName>lspping</testName>
                          <index>2</index>
                          <destIpAddr>2.2.2.9</destIpAddr>
                          <rtt>3</rtt>
                          <ttl>255</ttl>
                          <retCode>3</retCode>
                          <subCode>1</subCode>
                          <isDelete>false</isDelete>
                          <resultType>success</resultType>
                          <packetSize>100</packetSize>
                          <destIpv6Addr>::</destIpv6Addr>
                        </pingResultDetail>
                        <pingResultDetail>
                          <testName>lspping</testName>
                          <index>3</index>
                          <destIpAddr>2.2.2.9</destIpAddr>
                          <rtt>2</rtt>
                          <ttl>255</ttl>
                          <retCode>3</retCode>
                          <subCode>1</subCode>
                          <isDelete>false</isDelete>
                          <resultType>success</resultType>
                          <packetSize>100</packetSize>
                          <destIpv6Addr>::</destIpv6Addr>
                        </pingResultDetail>
                        <pingResultDetail>
                          <testName>lspping</testName>
                          <index>4</index>
                          <destIpAddr>2.2.2.9</destIpAddr>
                          <rtt>4</rtt>
                          <ttl>255</ttl>
                          <retCode>3</retCode>
                          <subCode>1</subCode>
                          <isDelete>false</isDelete>
                          <resultType>success</resultType>
                          <packetSize>100</packetSize>
                          <destIpv6Addr>::</destIpv6Addr>
                        </pingResultDetail>
                        <pingResultDetail>
                          <testName>lspping</testName>
                          <index>5</index>
                          <destIpAddr>2.2.2.9</destIpAddr>
                          <rtt>3</rtt>
                          <ttl>255</ttl>
                          <retCode>3</retCode>
                          <subCode>1</subCode>
                          <isDelete>false</isDelete>
                          <resultType>success</resultType>
                          <packetSize>100</packetSize>
                          <destIpv6Addr>::</destIpv6Addr>
                        </pingResultDetail>
                      </pingResultDetails>
              </lspPingResult>

    响应元素说明如表22-35所示。

    表22-35 响应元素说明

    元素

    描述

    testName

    查询到的LSP Ping检测的名称。

    index

    报文索引。

    destIpAddr

    报文的IP地址。

    packetSize

    报文的字节大小。

    ttl

    报文的TTL值。

    rtt

    时延。

    isDelete

    检测是否被删除。

    resultType

    结果类型:

    • success:成功
    • timeout:超时
    • failed:失败

    响应状态码说明如表22-36所示。

    表22-36 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

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

文档编号:EDOC1100075559

浏览量:2978

下载量:44

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