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

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

提示

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

升级

CloudEngine 12800, 12800E V200R005C10 RESTful API参考

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

LB测试

创建LB测试

操作

URI

描述

POST

/y1731/createLBTest

创建LB测试任务。

  • 请求示例:
    <?xml version="1.0" encoding="UTF-8"?>
            <createLBTest>
              <testName>test1</testName>
              <mdName>md1</mdName>
              <maName>ma1</maName>
              <mepId>1</mepId>
              <rmepId>2</rmepId>
            </createLBTest>

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

    表22-49 请求中元素说明

    元素

    描述

    testName

    指定测试例名字。

    mdName

    指定维护域的名称。

    maName

    指定维护联盟的名称。

    mepId

    指定MEP的ID。

    rmepId

    指定RMEP的ID。

    rmepMAC

    指定远端设备的MAC。

    priority

    指定报文的优先级。

    packetSize

    指定测试报文发送的字节数。

    packetCount

    指定测试报文发送的个数。

    timeout

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

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

    表22-50 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

停止LB测试

操作

URI

描述

POST

/y1731/stopLBTest

停止LB检测。

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

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

    表22-51 请求中元素说明

    元素

    描述

    testName

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

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

    表22-52 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

删除LB检测

操作

URI

描述

POST

/y1731/deleteLBTest

删除LB检测。

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

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

    表22-53 请求中元素说明

    元素

    描述

    testName

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

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

    表22-54 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

查询LB检测

操作

URI

描述

GET

/y1731/lbResults

查询所有LB检测结果。

GET

/y1731/lbResults

查询单个LB检测结果。

  • 请求示例:

    查询所有结果

    <?xml version="1.0" encoding="UTF-8"?>
            <lbResults>
              <lbResult>
                <testName></testName>
                <packetRecv></packetRecv>
                <packetSend></packetSend>
              </lbResult>
            </lbResults>
    查询单个结果
    <?xml version="1.0" encoding="UTF-8"?>
            <lbResults>
              <lbResult>
                <testName>12</testName>
                <packetRecv></packetRecv>
                <packetSend></packetSend>
              </lbResult>
            </lbResults>

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

    表22-55 请求中元素说明

    元素

    描述

    testName

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

    packetRecv

    收到的报文个数。

    packetSend

    发送的报文个数。

    lossRatio

    丢包率。

    rttMin

    最小时延。

    rttMax

    最大时延。

    averageRtt

    平均时延。

    status

    检测状态:

    • finished:结束
    • processing:进行中

    errorType

    结果类型:

    • success:成功
    • failed:失败

  • 成功响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?>
          <lbResults>
            <lbResult>
              <testName>test1</testName>
              <packetRecv>5</packetRecv>
              <packetSend>5</packetSend>
            </lbResult>
          </lbResults>

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

    表22-56 响应元素说明

    元素

    描述

    testName

    查询到的LB检测的名称。

    packetRecv

    收到的报文个数。

    packetSend

    发送的报文个数。

    lossRatio

    丢包率。

    rttMin

    最小时延。

    rttMax

    最大时延。

    averageRtt

    平均时延。

    status

    检测状态:

    • finished:结束
    • processing:进行中

    errorType

    结果类型:

    • success:成功
    • failed:失败

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

    表22-57 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

查询LB检测的详细结果

操作

URI

描述

GET

/y1731/lbResults

查询LB检测的详细结果。

  • 请求示例:
    <?xml version="1.0" encoding="UTF-8"?>
            <lbResults>
              <lbResult>
                <testName>test1</testName>
                <lbResultDetails>
                  <lbResultDetail>
                    <index></index>
                    <rmepMAC></rmepMAC>
                    <bytes></bytes>
                  </lbResultDetail>
                </lbResultDetails>
              </lbResult>
            </lbResults>

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

    表22-58 请求中元素说明

    元素

    描述

    testName

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

    index

    报文索引,必选参数。

    rmepMAC

    远端设备的MAC。

    bytes

    接收到的响应报文字节数。

    rtt

    时延。

    resultType

    结果类型:

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

  • 成功响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?>
          <lbResults>
            <lbResult>
              <testName>test1</testName>
              <lbResultDetails>
                <lbResultDetail>
                  <index>1</index>
                  <rmepMAC>bc9c-31a4-8804</rmepMAC>
                  <bytes>95</bytes>
                </lbResultDetail>
                <lbResultDetail>
                  <index>2</index>
                  <rmepMAC>bc9c-31a4-8804</rmepMAC>
                  <bytes>95</bytes>
                </lbResultDetail>
                <lbResultDetail>
                  <index>3</index>
                  <rmepMAC>bc9c-31a4-8804</rmepMAC>
                  <bytes>95</bytes>
                </lbResultDetail>
                <lbResultDetail>
                  <index>4</index>
                  <rmepMAC>bc9c-31a4-8804</rmepMAC>
                  <bytes>95</bytes>
                </lbResultDetail>
                <lbResultDetail>
                  <index>5</index>
                  <rmepMAC>bc9c-31a4-8804</rmepMAC>
                  <bytes>95</bytes>
                </lbResultDetail>
              </lbResultDetails>
            </lbResult>
          </lbResults>

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

    表22-59 响应元素说明

    元素

    描述

    testName

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

    index

    报文索引,必选参数。

    rmepMAC

    远端设备的MAC。

    bytes

    接收到的响应报文字节数。

    rtt

    时延。

    resultType

    结果类型:

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

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

    表22-60 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

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

文档编号:EDOC1100075559

浏览量:2549

下载量:44

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