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

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

提示

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

升级

CloudEngine 12800, 12800E V200R005C10 RESTful API参考

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

ICMP

创建ICMP测试例

操作

URI

描述

POST

/nqa/instance/nqaIcmps/nqaIcmp

创建ICMP测试例。

  • 请求示例:
    <?xml version="1.0" encoding="UTF-8"?>
                 <nqaIcmp operation="create">
                 <adminName>1</adminName>
                 <testName>1</testName>
                 <destAddr>1.1.1.1</destAddr>       
              </nqaIcmp>

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

    表24-1 请求中元素说明

    元素

    描述

    adminName

    管理者名称。

    testName

    测试例名称。

    destAddr

    目的IP地址。

    sourceAddr

    源IP地址。

    ttl

    TTL字段。

    interval

    报文发送间隔。(单位:毫秒)

    probeCount

    报文探测轮次。

    packetSize

    报文大小。(单位:字节)

    passRoute

    是否不查路由。

    tos

    TOS字段。

    vrfName

    VPN实例名称。

    failPercent

    判断测试例执行是否成功的丢包率(%)。

    testFails

    测试例失败次数,是发送告警/事件的阈值。

    hardwareEnable

    硬件发包。

    timestampFlag

    时间戳单位。

    outIfName

    出接口名称。

    fwdIfName

    模拟入接口名称。

    timeout

    测试报文的超时时间。(单位:秒)

    resultNum

    测试例探测结果个数。

    historyNum

    测试例探测历史结果个数。

    description

    测试例描述信息。

    ageTime

    测试例老化时间。

    frequency

    测试例执行周期(秒),测试例执行周期必须大于(报文发送个数-1)*报文发送间隔+超时时间,否则测试结果可能不准确。

    startType

    测试例启动类型。

  • 响应示例(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>

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

    表24-2 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

配置ICMP测试例

操作

URI

描述

PUT

/nqa/instance/nqaIcmps/nqaIcmp

配置ICMP测试例。

  • 请求示例:
    <?xml version="1.0" encoding="UTF-8"?>
                 <nqaIcmp operation="merge">
                 <adminName>1</adminName>
                 <testName>1</testName>
                 <destAddr>1.1.1.1</destAddr>       
                 </nqaIcmp>

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

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

    响应状态码说明如表24-3所示。

    表24-3 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

删除ICMP测试例

操作

URI

描述

DELETE

/nqa/instance/nqaIcmps/nqaIcmp

删除ICMP测试例。

  • 请求示例:
     <?xml version="1.0" encoding="UTF-8"?>
                 <nqaIcmp operation="delete">
                 <adminName>1</adminName>
                 <testName>1</testName>
                 <destAddr>1.1.1.1</destAddr>       
                 </nqaIcmp>

    请求中元素说明如表24-4所示。

    表24-4 请求中元素说明

    元素

    描述

    adminName

    管理者名称。

    testName

    测试例名称。

  • 响应示例(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>

    响应状态码说明如表24-5所示。

    表24-5 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

查询ICMP

操作

URI

描述

GET

/nqa/instance/nqaIcmps/nqaIcmp

查询ICMP结果。

  • 请求示例:

    查询结果

     <?xml version="1.0" encoding="UTF-8"?>
                <nqaIcmp>
                  <testName>1</testName>
                  <adminName>1</adminName>
                </nqaIcmp>

    请求中元素说明如表24-6所示。

    表24-6 请求中元素说明

    元素

    描述

    adminName

    管理者名称。

    testName

    测试例名称。

  • 成功响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?>
              <nqaIcmp>
                <adminName>1</adminName>
                <testName>1</testName>
                <destAddr>1.1.1.1</destAddr>
                <sourceAddr/>
                <vrfName>_public_</vrfName>
                <outIfName></outIfName>
                <fwdIfName></fwdIfName>
                <interval>4</interval>
                <packetCount>3</packetCount>
                <timeout>3</timeout>
                <frequency/>
                <failPercent>100</failPercent>
                <packetSize>0</packetSize>
                <packetFill/>
                <tos>0</tos>
                <ttl>30</ttl>
                <passRoute>0</passRoute>
                <probeFails>1</probeFails>
                <testFails>1</testFails>
                <trapFlag>0</trapFlag>
                <resultNum>5</resultNum>
                <historyNum>60</historyNum>
                <description/>
                <startPolicy>
                  <adminName>shen</adminName>
                  <testName>jun</testName>
                  <startType>stop</startType>
                </startPolicy>
              </nqaIcmp>

    响应元素说明如表24-7所示。

    表24-7 响应元素说明

    元素

    描述

    adminName

    管理者名称。

    testName

    测试例名称。

    响应状态码说明如表24-8所示。

    表24-8 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

查询NQA测试例结果记录表

操作

URI

描述

GET

/nqa/record/nqaRecord/nqaResults/nqaResult

查询NQA测试例结果记录表。

GET

/nqa/record/nqaRecord/nqaResults/nqaResult/nqaHops/nqaHop

查询NQA测试例每一跳的结果表

查询NQA测试例结果记录表:

请求示例:
<?xml version="1.0" encoding="UTF-8"?>
              <nqaResult>
                <adminName></adminName>
                <testName></testName>
                <runningIndex></runningIndex>
              </nqaResult>

请求中元素说明如表24-9所示。

表24-9 请求中元素说明

元素

描述

adminName

管理者名称。

testName

测试例名称。

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

    响应元素说明如表24-10所示。

    表24-10 响应元素说明

    元素

    描述

    adminName

    管理者名称。

    testName

    测试例名称。

    runningIndex

    运行索引。

    completions

    执行结果。

    testBeginTime

    开始时间。

    testEndTime

    结束时间。

    testAttempts

    探测次数。

    drops

    丢包数。

    disconnects

    连接失败数。

    timeouts

    超时数。

    busies

    系统繁忙计数。

    noConnections

    连接断开数。

    sequenceErrors

    报文序列号错误数。

    rttStatsErrors

    RTT统计失败次数。

查询NQA测试例每一跳的结果表:

请求示例:
<?xml version="1.0" encoding="UTF-8"?>
                  <nqaHop>
                    <hopIndex></hopIndex>
                    <packetSend></packetSend>
                    <packetRecv></packetRecv>
                  </nqaHop>

请求中元素说明如表24-11所示。

表24-11 请求中元素说明

元素

描述

adminName

管理者名称。

testName

测试例名称。

  • 响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?>
                    <nqaHop>
                      <hopIndex>1</hopIndex>
                      <packetSend>0</packetSend>
                      <packetRecv>0</packetRecv>
                    </nqaHop>

    响应元素说明如表24-12所示。

    表24-12 响应元素说明

    元素

    描述

    adminName

    管理者名称。

    testName

    测试例名称。

    hopIndex

    hop索引。

    packetSend

    发送报文的总个数。

    packetRecv

    接收报文的总个数。

    destIpAddr

    目的IP地址。

    destIpv6Addr

    IPV6目的IP地址。

    lossRatio

    丢包率(%)。

    hopEndTime

    最后一次回报文的时间。

    minRtt

    所有测试报文的RTT最小值。(单位:毫秒)

    averageRtt

    所有测试报文的RTT平均值。(单位:毫秒)

    maxRtt

    所有测试报文的RTT最大值。(单位:毫秒)

    响应状态码说明如表24-13所示。

    表24-13 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

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

文档编号:EDOC1100075559

浏览量:2525

下载量:44

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