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

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

提示

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

升级

CloudEngine 12800, 12800E V200R005C10 RESTful API参考

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

IPv4 Ping

发起IPv4 Ping

操作

URI

描述

POST

/dgntl/ipv4/startIpPing

发起IPv4 Ping检测。

  • 请求示例:
    <?xml version="1.0" encoding="UTF-8"?>
              <startIpPing>
                <testName>ping</testName>
                <destAddr>192.168.1.2</destAddr>
                <sourceAddr>192.168.1.1</sourceAddr>
              </startIpPing>

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

    表22-1 请求中元素说明

    元素

    描述

    destAddr

    发送ECHO-REQUEST报文的目的IP地址,必选参数。

    sourceAddr

    发送ECHO-REQUEST报文的源IP地址。

    ifName

    检测报文发送出去的接口名。

    packetCount

    检测报文发送的个数。

    packetSize

    检测报文发送的字节数。

    interval

    检测报文发送的时间间隔。

    timeout

    检测报文的超时时间。

    ttl

    发送ECHO-REQUEST报文的TTL值。

    tos

    发送ECHO-REQUEST报文的ToS值。

    vrfName

    VPN实例名称。

    testName

    发起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-2所示。

    表22-2 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

停止IPv4 Ping

操作

URI

描述

POST

/dgntl/ipv4/stopIpPing

停止IPv4 Ping检测。

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

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

    表22-3 请求中元素说明

    元素

    描述

    testName

    停止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-4所示。

    表22-4 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

删除IPv4 Ping

操作

URI

描述

Delete

/dgntl/ipv4/deleteIpPing

删除IPv4 Ping检测。

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

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

    表22-5 请求中元素说明

    元素

    描述

    testName

    删除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-6所示。

    表22-6 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

查询IPv4 Ping

操作

URI

描述

GET

/dgntl/ipv4/ipv4PingResults

查询所有IPv4 Ping结果。

GET

/dgntl/ipv4/ipv4PingResults

查询单个IPv4 Ping结果。

  • 请求示例:

    查询所有结果

    <?xml version='1.0' encoding='UTF-8'?>  
    <ipv4PingResults>
        <ipv4PingResult>
           <testName></testName> 
           <packetRecv/> 
           <packetSend/> 
           <lossRatio/> 
           <rttMin/> 
           <rttMax/> 
           <averageRtt/> 
           <status/> 
           <errorType/> 
        </ipv4PingResult>
    </ipv4PingResults>
    查询单个结果
    <?xml version='1.0' encoding='UTF-8'?> 
    <ipv4PingResults> 
        <ipv4PingResult> 
           <testName>s7</testName> 
           <packetRecv/> 
           <packetSend/> 
           <lossRatio/> 
           <rttMin/> 
           <rttMax/> 
           <averageRtt/> 
           <status/> 
           <errorType/> 
        </ipv4PingResult> 
    </ipv4PingResults>

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

    表22-7 请求中元素说明

    元素

    描述

    testName

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

    packetRecv

    收到的报文个数。

    packetSend

    发送的报文个数。

    lossRatio

    丢包率。

    rttMin

    最小时延。

    rttMax

    最大时延。

    averageRtt

    平均时延。

    status

    检测状态:

    • finished:结束
    • processing:进行中

    errorType

    结果类型:

    • success:成功
    • failed:失败

  • 成功响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?> 
    <ipv4PingResults> 
        <ipv4PingResult> 
            <testName>s7</testName> 
            <packetRecv>3</packetRecv> 
            <packetSend>3</packetSend> 
            <lossRatio>0</lossRatio> 
            <rttMin>1</rttMin> 
            <rttMax>1</rttMax> 
            <averageRtt>1</averageRtt> 
            <status>finished</status> 
            <errorType>success</errorType> 
        </ipv4PingResult> 
    </ipv4PingResults>

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

    表22-8 响应元素说明

    元素

    描述

    testName

    查询到的Ping检测的名称。

    packetRecv

    收到的报文个数。

    packetSend

    发送的报文个数。

    lossRatio

    丢包率。

    rttMin

    最小时延。

    rttMax

    最大时延。

    averageRtt

    平均时延。

    status

    检测状态:

    • finished:结束
    • processing:进行中

    errorType

    结果类型:

    • success:成功
    • failed:失败

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

    表22-9 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

查询IPv4 Ping的详细结果

操作

URI

描述

GET

/dgntl/ipv4/ipv4PingResults/ipv4PingResult

查询IPv4 Ping的详细结果。

  • 请求示例:
    <?xml version='1.0' encoding='UTF-8'?> 
    <ipv4PingResult>
    <testName>s7</testName>
    <pingResultDetails> 
        <pingResultDetail> 
           <testName></testName> 
           <index></index> 
           <ipAddr/> 
           <packetSize/> 
           <ttl/> 
           <rtt/> 
           <isDelete/> 
           <resultType/> 
        </pingResultDetail> 
    </pingResultDetails>
    </ipv4PingResult>

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

    表22-10 请求中元素说明

    元素

    描述

    testName

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

    index

    报文索引,必选参数。

    ipAddr

    报文的IP地址。

    packetSize

    报文的字节大小。

    ttl

    报文的TTL值。

    rtt

    时延。

    isDelete

    检测是否被删除。

    resultType

    结果类型:

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

  • 成功响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?> 
    <pingResultDetails> 
        <pingResultDetail> 
            <testName>s7</testName> 
            <index>2</index> 
            <ipAddr>127.0.0.1</ipAddr> 
            <packetSize>56</packetSize> 
            <ttl>255</ttl> 
            <rtt>1</rtt> 
            <isDelete>false</isDelete> 
            <resultType>success</resultType> 
        </pingResultDetail> 
    </pingResultDetails>

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

    表22-11 响应元素说明

    元素

    描述

    testName

    查询到的Ping检测的名称。

    index

    报文索引。

    ipAddr

    报文的IP地址。

    packetSize

    报文的字节大小。

    ttl

    报文的TTL值。

    rtt

    时延。

    isDelete

    检测是否被删除。

    resultType

    结果类型:

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

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

    表22-12 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

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

文档编号:EDOC1100075559

浏览量:2647

下载量:44

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