No relevant resource is found in the selected language.

This site uses cookies. By continuing to browse the site you are agreeing to our use of cookies. Read our privacy policy>Search

Reminder

To have a better experience, please upgrade your IE browser.

upgrade

RESTful API Reference

CloudEngine 12800 and 12800E V200R005C10

This document describes the OPS APIs supported by the device, including OPS-supported operations, request examples, elements in the requests, response examples, elements in the responses, and response status codes.
Rate and give feedback:
Huawei uses machine translation combined with human proofreading to translate this document to different languages in order to help you better understand the content of this document. Note: Even the most advanced machine translation cannot match the quality of professional translators. Huawei shall not bear any responsibility for translation accuracy and it is recommended that you refer to the English document (a link for which has been provided).
IPv6 Ping

IPv6 Ping

Start an IPv6 Ping Test

Operation

URI

Description

POST

/dgntl/ipv6/startIpPing

Start an IPv6 ping test.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
              <startIpPing>
                <testName>ipv6_ping</testName>
                <destAddr>2001:db8::2</destAddr>
                <sourceAddr>2001:db8::3</sourceAddr>
                <ifName>XXX</ifName>
              </startIpPing>

    Table 22-13 describes elements in requests.

    Table 22-13 Elements

    Element

    Description

    destAddr

    Specifies the destination IP address of ICMP Echo Request packets. This element is mandatory.

    sourceAddr

    Specifies the source IP address of ICMP Echo Request packets.

    ifName

    Specifies the name of an interface for sending ICMP packets.

    packetCount

    Specifies the number of ICMP packets sent.

    packetSize

    Specifies the number of bytes of ICMP packets sent.

    interval

    Specifies an interval at which ICMP packets are sent.

    timeout

    Specifies the timeout period of ICMP packets.

    ttl

    Specifies the TTL of ICMP Echo Request packets to be sent.

    tos

    Specifies the ToS of ICMP Echo Request packets to be sent.

    vrfName

    Specifies a VPN instance name.

    testName

    Specifies a ping test name. This element is mandatory.

  • Response example (XML format)
    <?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>

    Table 22-14 describes status codes in responses.

    Table 22-14 Status codes in responses

    Status Code

    Description

    200 OK

    The operation succeeded.

    400 Bad Request

    The request operation failed because the request is incorrect in syntax or the information attribute in the request is incorrect.

    500 Internal Server Error

    The request operation failed because of internal errors in services or unidentified processing errors.

Stop an IPv6 Ping Test

Operation

URI

Description

POST

/dgntl/ipv6/stopIpPing

Stop an IPv6 ping test.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
              <stopIpPing>
                <testName>ipv6_ping</testName>
              </stopIpPing>

    Table 22-15 describes elements in requests.

    Table 22-15 Elements

    Element

    Description

    testName

    Specifies a ping test name. This element is mandatory.

  • Response example (XML format)
    <?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>

    Table 22-16 describes status codes in responses.

    Table 22-16 Status codes in responses

    Status Code

    Description

    200 OK

    The operation succeeded.

    400 Bad Request

    The request operation failed because the request is incorrect in syntax or the information attribute in the request is incorrect.

    500 Internal Server Error

    The request operation failed because of internal errors in services or unidentified processing errors.

Delete an IPv6 Ping Test

Operation

URI

Description

POST

/dgntl/ipv6/deleteIpPing

Delete an IPv6 Ping Test

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
              <deleteIpPing>
                <testName>ipv6_ping</testName>
              </deleteIpPing>

    Table 22-17 describes elements in requests.

    Table 22-17 Elements

    Element

    Description

    testName

    Delete ping test name. This element is mandatory.

  • Response example (XML format)
    <?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>

    Table 22-18 describes status codes in responses.

    Table 22-18 Status codes in responses

    Status Code

    Description

    200 OK

    The operation succeeded.

    400 Bad Request

    The request operation failed because the request is incorrect in syntax or the information attribute in the request is incorrect.

    500 Internal Server Error

    The request operation failed because of internal errors in services or unidentified processing errors.

Query an IPv6 Ping Test

Operation

URI

Description

GET

/dgntl/ipv6/ipv6PingResults

Query all IPv6 ping results.

GET

/dgntl/ipv6/ipv6PingResults

Query an IPv6 ping result.

  • Request example

    Query all results

    <?xml version='1.0' encoding='UTF-8'?> 
    <ipv6PingResults>
        <ipv6PingResult>
           <testName></testName> 
           <packetRecv/> 
           <packetSend/> 
           <lossRatio/> 
           <rttMin/> 
           <rttMax/> 
           <averageRtt/> 
           <status/> 
           <errorType/> 
       </ipv6PingResult> 
    </ipv6PingResults> 
    
    Query a single result
    <?xml version='1.0' encoding='UTF-8'?> 
    <ipv6PingResults> 
        <ipv6PingResult> 
           <testName>testName</testName> 
           <packetRecv/> 
           <packetSend/> 
           <lossRatio/> 
           <rttMin/> 
           <rttMax/> 
           <averageRtt/> 
           <status/> 
           <errorType/> 
        </ipv6PingResult> 
    </ipv6PingResults>

    Table 22-19 describes elements in requests.

    Table 22-19 Elements

    Element

    Description

    testName

    Specifies a ping test name. This element is mandatory.

    packetRecv

    Specifies the number of packets received.

    packetSend

    Specifies the number of packets sent.

    lossRatio

    Specifies a packet loss rate.

    rttMin

    Specifies the minimum delay.

    rttMax

    Specifies the maximum delay.

    averageRtt

    Specifies the average delay.

    status

    Specifies the detection status.

    • finished
    • processing

    errorType

    Specifies a ping result.

    • success
    • failed

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
             <ipv6PingResults> 
               <ipv6PingResult> 
                 <testName>s1</testName> 
                 <packetRecv>2</packetRecv> 
                 <packetSend>2</packetSend> 
                 <lossRatio>0</lossRatio> 
                 <rttMin>1</rttMin> 
                 <rttMax>1</rttMax> 
                 <averageRtt>1</averageRtt> 
                 <status>finished</status> 
                 <errorType>success</errorType> 
               </ipv6PingResult> 
             </ipv6PingResults> 

    Table 22-20 describes elements in responses.

    Table 22-20 Elements

    Element

    Description

    testName

    Specifies a ping test name.

    packetRecv

    Specifies the number of packets received.

    packetSend

    Specifies the number of packets sent.

    lossRatio

    Specifies a packet loss rate.

    rttMin

    Specifies the minimum delay.

    rttMax

    Specifies the maximum delay.

    averageRtt

    Specifies the average delay.

    status

    Specifies the detection status.

    • finished
    • processing

    errorType

    Specifies a ping result.

    • success
    • failed

    Table 22-21 describes status codes in responses.

    Table 22-21 Status codes in responses

    Status Code

    Description

    200 OK

    The operation succeeded.

    400 Bad Request

    The request operation failed because the request is incorrect in syntax or the information attribute in the request is incorrect.

    500 Internal Server Error

    The request operation failed because of internal errors in services or unidentified processing errors.

Query the Detailed IPv6 Ping Result

Operation

URI

Description

GET

/dgntl/ipv6/ipv6PingResults/ipv6PingResult/pingResultDetails

Query the detailed IPv6 ping result.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
              <ipv6PingResults>
                <ipv6PingResult>
                  <testName>ipv6_ping</testName>
                  <pingResultDetails>
                    <pingResultDetail>
                      <index></index>
                      <destIpAddr></destIpAddr>
                      <packetSize></packetSize>
                    </pingResultDetail>
                  </pingResultDetails>
                </ipv6PingResult>
              </ipv6PingResults>    

    Table 22-22 describes elements in requests.

    Table 22-22 Elements

    Element

    Description

    testName

    Specifies a ping test name. This element is mandatory.

    index

    Specifies a packet index. This element is mandatory.

    destIpAddr

    Specifies the IP address of packets.

    packetSize

    Specifies the number of bytes of a packet.

    ttl

    Specifies the TTL of packets.

    rtt

    Specifies a delay.

    isDelete

    Indicates whether the ping test is deleted.

    resultType

    Specifies a ping result.

    • success
    • timeout
    • failed

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
            <ipv6PingResults>
              <ipv6PingResult>
                <testName>ipv6_ping</testName>
                <pingResultDetails>
                  <pingResultDetail>
                    <index>1</index>
                    <destIpAddr>2001:db8::2</destIpAddr>
                    <packetSize>56</packetSize>
                  </pingResultDetail>
                  <pingResultDetail>
                    <index>2</index>
                    <destIpAddr>2001:db8::2</destIpAddr>
                    <packetSize>56</packetSize>
                  </pingResultDetail>
                  <pingResultDetail>
                    <index>3</index>
                    <destIpAddr>2001:db8::2</destIpAddr>
                    <packetSize>56</packetSize>
                  </pingResultDetail>
                  <pingResultDetail>
                    <index>4</index>
                    <destIpAddr>2001:db8::2</destIpAddr>
                    <packetSize>56</packetSize>
                  </pingResultDetail>
                  <pingResultDetail>
                    <index>5</index>
                    <destIpAddr>2001:db8::2</destIpAddr>
                    <packetSize>56</packetSize>
                  </pingResultDetail>
                </pingResultDetails>
              </ipv6PingResult>
            </ipv6PingResults>

    Table 22-23 describes elements in responses.

    Table 22-23 Elements

    Element

    Description

    testName

    Specifies a ping test name.

    index

    Specifies a packet index.

    destIpAddr

    Specifies the IP address of packets.

    packetSize

    Specifies the number of bytes of a packet.

    ttl

    Specifies the TTL of packets.

    rtt

    Specifies a delay.

    isDelete

    Indicates whether the ping test is deleted.

    resultType

    Specifies a ping result.

    • success
    • timeout
    • failed

    Table 22-24 describes status codes in responses.

    Table 22-24 Status codes in responses

    Status Code

    Description

    200 OK

    The operation succeeded.

    400 Bad Request

    The request operation failed because the request is incorrect in syntax or the information attribute in the request is incorrect.

    500 Internal Server Error

    The request operation failed because of internal errors in services or unidentified processing errors.

Translation
Download
Updated: 2019-04-03

Document ID: EDOC1100075372

Views: 10759

Downloads: 16

Average rating:
This Document Applies to these Products
Related Documents
Related Version
Share
Previous Next