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

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

提示

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

升级

CloudEngine 12800, 12800E V200R005C10 RESTful API参考

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

IPv4 Trace

发起IPv4 Trace

操作

URI

描述

POST

/dgntl/ipv4/startIpTrace

发起IPv4 Trace检测。

  • 请求示例:
    <?xml version="1.0" encoding="UTF-8"?>
              <startIpTrace>
                <testName>trace</testName>
                <destIpAddr>192.168.1.2</destIpAddr>
                <sourceAddress>192.168.1.1</sourceAddress>
              </startIpTrace>

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

    表23-1 请求中元素说明

    元素

    描述

    destIpAddr

    发送Trace检测报文的目的IP地址,必选参数。

    sourceAddress

    发送Trace检测报文的源IP地址。

    ifName

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

    packetSize

    测试报文发送的字节数。

    probePktsNum

    测试报文发送的个数。

    udpPortNum

    目的端口号。

    timeout

    检测报文的超时时间。

    firstTtl

    测试过程中的第一个报文的生存时间值。

    maxTtl

    测试报文的生存时间值。

    vrfName

    VPN实例名称。

    testName

    发起Trace检测的名称,必选参数。

    showMplsLabelFlag

    显示标签信息标志。

    showHostNameFlag

    反向域名解析标志。

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

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

    表23-2 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

停止IPv4 Trace

操作

URI

描述

POST

/dgntl/ipv4/stopIpTrace

停止IPv4 Trace检测。

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

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

    表23-3 请求中元素说明

    元素

    描述

    testName

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

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

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

    表23-4 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

删除IPv4 Trace

操作

URI

描述

Delete

/dgntl/ipv4/deleteIpTrace

删除IPv4 Trace检测。

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

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

    表23-5 请求中元素说明

    元素

    描述

    testName

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

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

    响应状态码说明如表23-6所示。

    表23-6 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

查询IPv4 Trace

操作

URI

描述

GET

/dgntl/ipv4/ipv4TraceResults/ipv4TraceResult

查询单个IPv4 Trace结果。

  • 请求示例:
    查询单个结果
    <?xml version="1.0" encoding="UTF-8"?>
                <ipv4TraceResult>
                  <testName>trace</testName>
                    <status/>
                    <errorType/>
                </ipv4TraceResult>

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

    表23-7 请求中元素说明

    元素

    描述

    testName

    查询到的Ping检测的名称。

    status

    检测状态:

    • finished:结束
    • processing:进行中

    errorType

    测试结果:

    • success:成功
    • failed:失败

  • 成功响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?>
              <ipv4TraceResult>
                <testName>trace</testName>
                <status>finished</status>
                <errorType>success</errorType>
              </ipv4TraceResult>

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

    表23-8 响应元素说明

    元素

    描述

    testName

    测试名称。

    status

    检测状态:

    • finished:结束
    • processing:进行中

    errorType

    测试结果:

    • success:成功
    • failed:失败

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

    表23-9 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

查询IPv4 Trace的详细结果

操作

URI

描述

GET

/dgntl/ipv4/ipv4TraceResults/ipv4TraceResult/traceResultDetails

查询IPv4 Trace的详细结果。

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

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

    表23-10 请求中元素说明

    元素

    描述

    testName

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

    status

    检测状态:

    • finished:结束
    • processing:进行中

    errorType

    测试结果:

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

  • 成功响应示例(XML格式):
    <?xml version="1.0" encoding="UTF-8"?>
                <traceResultDetails>
                  <traceResultDetail>
                    <testName>trace</testName>
                    <hopIndex>1</hopIndex>
                    <ttl>1</ttl>
                    <rtt>2</rtt>
                    <dsIpAddr>192.168.1.2</dsIpAddr>
                    <isDelete>false</isDelete>
                    <hostName></hostName>
                  </traceResultDetail>
                  <traceResultDetail>
                    <testName>trace</testName>
                    <hopIndex>2</hopIndex>
                    <ttl>1</ttl>
                    <rtt>5</rtt>
                    <dsIpAddr>192.168.1.2</dsIpAddr>
                    <isDelete>false</isDelete>
                    <hostName></hostName>
                  </traceResultDetail>
                  <traceResultDetail>
                    <testName>trace</testName>
                    <hopIndex>3</hopIndex>
                    <ttl>1</ttl>
                    <rtt>8</rtt>
                    <dsIpAddr>192.168.1.2</dsIpAddr>
                    <isDelete>false</isDelete>
                    <hostName></hostName>
                  </traceResultDetail>
                </traceResultDetails>

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

    表23-11 响应元素说明

    元素

    描述

    testName

    测试名称。

    status

    测试状态。

    errorType

    测试操作状态。

    hopIndex

    标志测试路径的第几跳。

    ttl

    接收到的响应生存时间值。

    type

    各个节点的类型。

    rtt

    测试报文的往返时间,单位为毫秒。

    dsIpAddr

    测试对应Hop的目的地址。

    isDelete

    标志是否删除查询结果。

    hostName

    域名。

    mplsLabelInfo

    MPLS标签信息。

    labelCountIndex

    MPLS标签索引。

    mplsLabel

    MPLS标签。

    mplsExp

    MPLS 优先级。

    mplsStackBottom

    MPLS 栈底标记。

    mplsTtl

    MPLS 生存时间。

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

    表23-12 响应状态码说明

    状态码

    描述

    200 OK

    操作执行成功。

    400 Bad Request

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

    500 Internal Server Error

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

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

文档编号:EDOC1100075559

浏览量:2420

下载量:44

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