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).
IPv4 Trace

IPv4 Trace

Start an IPv4 Trace Test

Operation

URI

Description

POST

/dgntl/ipv4/startIpTrace

Start an IPv4 trace test.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>              
              <startIpTrace>  
                <testName>trace</testName> 
                <destAddr>192.168.1.2</destAddr>
                <sourceAddr>192.168.1.1</sourceAddr> 
              </startIpTrace> 

    Table 23-1 describes elements in requests.

    Table 23-1 Elements

    Element

    Description

    destIpAddr

    Specifies the destination IP address of trace test packets. This element is mandatory.

    sourceAddress

    Specifies the source IP address of trace test packets.

    ifName

    Specifies the name of an interface for sending test packets.

    packetSize

    Specifies the number of bytes in sent test packets.

    probePktsNum

    Specifies the number of sent test packets.

    udpPortNum

    Specifies a destination port number.

    timeout

    Specifies a timeout period for test packets.

    firstTtl

    Specifies the TTL of the first packet sent during the test.

    maxTtl

    Specifies the maximum TTL of test packets.

    vrfName

    Specifies a VPN instance name.

    testName

    Specifies a trace test name. This element is mandatory.

    showMplsLabelFlag

    Specifies whether to display label information.

    showHostNameFlag

    Specifies whether to perform reverse domain name parsing.

  • 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 23-2 describes status codes in responses.

    Table 23-2 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 IPv4 Trace Test

Operation

URI

Description

POST

/dgntl/ipv4/stopIpTrace

Stop an IPv4 trace test.

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

    Table 23-3 describes elements in requests.

    Table 23-3 Elements

    Element

    Description

    testName

    Specifies a trace 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 23-4 describes status codes in responses.

    Table 23-4 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 IPv4 Trace Test

Operation

URI

Description

Delete

/dgntl/ipv4/deleteIpTrace

Delete an IPv4 trace test.

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

    Table 23-5 describes elements in requests.

    Table 23-5 Elements

    Element

    Description

    testName

    Specifies a trace 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 23-6 describes status codes in responses.

    Table 23-6 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 IPv4 Trace Test

Operation

URI

Description

GET

/dgntl/ipv4/ipv4TraceResults

Query all IPv4 trace results.

GET

/dgntl/ipv4/ipv4TraceResults

Query a single IPv4 trace result.

  • Request example

    Query all results.

     <?xml version="1.0" encoding="UTF-8"?>
              <ipv4TraceResults> 
              </ipv4TraceResults>
    Query a single result.
    <?xml version="1.0" encoding="UTF-8"?>
              <ipv4TraceResults>               
              <ipv4TraceResult> 
                <testName>trace</testName> 
                  <status/>
                  <errorType/>
                </ipv4TraceResult> 
              </ipv4TraceResults>

    Table 23-7 describes elements in requests.

    Table 23-7 Elements

    Element

    Description

    testName

    Specifies a trace test name.

    status

    Specifies the test status.

    • finished
    • processing

    errorType

    Specifies a test result.

    • success
    • failed
  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>   
            <ipv4TraceResults>             
              <ipv4TraceResult>
                <testName>trace</testName>
                <status>finished</status>
                <errorType>success</errorType>
              </ipv4TraceResult>
            </ipv4TraceResults>

    Table 23-8 describes elements in responses.

    Table 23-8 Elements

    Element

    Description

    testName

    Specifies a test name.

    status

    Specifies the test status.

    • finished
    • processing

    errorType

    Specifies a test result.

    • success
    • failed

    Table 23-9 describes status codes in responses.

    Table 23-9 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 Detailed IPv4 Trace Test Results

Operation

URI

Description

GET

/dgntl/ipv4/ipv4TraceResults/ipv4TraceResult/traceResultDetails

Query detailed IPv4 trace test results.

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

    Table 23-10 describes elements in requests.

    Table 23-10 Elements

    Element

    Description

    testName

    Specifies a trace test name. This element is mandatory.

    status

    Specifies the test status.

    • finished
    • processing

    errorType

    Specifies a test result.

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

    Table 23-11 describes elements in responses.

    Table 23-11 Elements

    Element

    Description

    testName

    Specifies a test name.

    status

    Specifies the test status.

    errorType

    Specifies a test result.

    hopIndex

    Specifies the serial number of a hop on the test path.

    ttl

    Specifies the TTL of the received response.

    type

    Specifies the type of a node.

    rtt

    Specifies the round trip time of test packets, in milliseconds.

    dsIpAddr

    Specifies the destination address corresponding to a specified hop.

    isDelete

    Indicates whether query results are deleted.

    hostName

    Specifies a domain name.

    mplsLabelInfo

    Specifies MPLS label information.

    labelCountIndex

    Specifies an MPLS label index.

    mplsLabel

    Specifies an MPLS label.

    mplsExp

    Specifies an MPLS priority.

    mplsStackBottom

    Specifies the MPLS stack bottom.

    mplsTtl

    Specifies an MPLS TTL.

    Table 23-12 describes status codes in responses.

    Table 23-12 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: 10153

Downloads: 16

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