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 8800, 7800, 6800, and 5800 V200R002C50

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).
Interface IPv4 Address

Interface IPv4 Address

Configure an IPv4 Address for an Interface

Operation

URI

Description

POST

/ifm/interfaces/interface/ifmAm4/am4CfgAddrs

Configure an IPv4 address for an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <interfaces>
          <interface operation="merge">
                <ifName>10GE1/0/1</ifName>
                <ifmAm4>
                  <am4CfgAddrs>
                    <am4CfgAddr operation="create">
                      <ifIpAddr>1.1.1.1</ifIpAddr>
                      <subnetMask>255.255.254.0</subnetMask>
                      <addrType>main</addrType>
                    </am4CfgAddr>
                  </am4CfgAddrs>
                </ifmAm4>
          </interface>
    </interfaces>

    Table 3-53 describes elements in requests.

    Table 3-53  Elements

    Element

    Description

    ifName

    Specifies an interface name.

    ifmAm4

    Specifies IPv4 configurations, including the configured IPv4 address, IPv4 address negotiation, and IPv4 address unnumbered.

    am4CfgAddrs

    Specifies an IPv4 address list.

    am4CfgAddr

    Specifies an IPv4 address configuration.

    ifIpAddr

    Specifies an IPv4 address. The value is a string of 0 to 255 characters in dotted decimal notation.

    subnetMask

    Specifies the mask of an IPv4 address. The value is a string of 0 to 255 characters in dotted decimal notation.

    addrType

    Specifies an IPv4 address type. The value is an enumerated type and case-sensitive:

    main: primary IP address.

    sub: secondary IP address.

    unnumber: borrowed IP address.

    The default value is main.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
     <rpc-reply> 
       <ok/> 
     </rpc-reply>

    Table 3-54 describes status codes in responses.

    Table 3-54  Status codes

    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 IPv4 Address of an Interface

Operation

URI

Description

GET

/ifm/interfaces/interface/ifmAm4

Query the IPv4 address of an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <interfaces>
        <interface>
            <ifName>10GE1/0/1</ifName>
            <ifmAm4/>
        </interface>
    </interfaces>

    Table 3-55 describes elements in requests.

    Table 3-55  Elements

    Element

    Description

    ifName

    Specifies an interface name.

    ifmAm4

    Specifies IPv4 configurations, including the configured IPv4 address, IPv4 address negotiation, and IPv4 address unnumbered.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <interfaces>
           <interface>
              <ifName>10GE1/0/1</ifName>
              <ifmAm4>
                <unNumIfName></unNumIfName>
                <addrCfgType>config</addrCfgType>
                <am4CfgAddrs>
                  <am4CfgAddr>
                    <ifIpAddr>10.137.209.251</ifIpAddr>
                    <subnetMask>255.255.0.0</subnetMask>
                    <addrType>main</addrType>
                  </am4CfgAddr>
                </am4CfgAddrs>
              </ifmAm4>
           </interface> 
    </interfaces>

    Table 3-56 describes elements in responses.

    Table 3-56  Elements

    Element

    Description

    ifName

    Specifies an interface name.The value is a string of 1 to 63 characters

    ifmAm4

    Specifies IPv4 configurations, including the configured IPv4 address, IPv4 address negotiation, and IPv4 address unnumbered.

    unNumIfName

    Specifies the name of a numbered interface. The value is a string of 1 to 63 characters.

    addrCfgType

    Specifies the IPv4 address assignment mode. The value is an enumerated type and case-sensitive:

    config: configured IP address.

    negotiation: negotiated IP address.

    unnumbered: borrowed IP address.

    am4CfgAddrs

    Specifies an IPv4 address list.

    am4CfgAddr

    Specifies an IPv4 address configuration.

    ifIpAddr

    Specifies an IPv4 address. The value is a string of 0 to 255 characters in dotted decimal notation.

    subnetMask

    Specifies the mask of an IPv4 address. The value is a string of 0 to 255 characters in dotted decimal notation.

    addrType

    Specifies an IPv4 address type. The value is an enumerated type and case-sensitive:

    main: primary IP address.

    sub: secondary IP address.

    unnumber: borrowed IP address.

    The default value is main.

    Table 3-57 describes status codes in responses.

    Table 3-57  Status codes

    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 Address from an Interface

Operation

URI

Description

DELETE

/ifm/interfaces/interface/ifmAm4/am4CfgAddrs

Delete an IPv4 address from an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <interfaces>
          <interface>
                <ifName>10GE1/0/1</ifName>
                <ifmAm4>
                  <am4CfgAddrs>
                    <am4CfgAddr operation="delete">
                      <ifIpAddr>1.1.1.1</ifIpAddr>
                    </am4CfgAddr>
                  </am4CfgAddrs>
                </ifmAm4>
          </interface>
    </interfaces>

    Table 3-58 describes elements in requests.

    Table 3-58  Elements

    Element

    Description

    ifName

    Specifies an interface name.

    ifmAm4

    Specifies IPv4 configurations, including the configured IPv4 address, IPv4 address negotiation, and IPv4 address unnumbered.

    am4CfgAddrs

    Specifies an IPv4 address list.

    am4CfgAddr

    Specifies an IPv4 address configuration.

    ifIpAddr

    Specifies an IPv4 address. The value is a string of 0 to 255 characters in dotted decimal notation.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
     <rpc-reply> 
       <ok/> 
     </rpc-reply>

    Table 3-59 describes status codes in responses.

    Table 3-59  Status codes

    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.

Configure an Interface to Borrow the IPv4 Address of Another Interface

Operation

URI

Description

PUT

/ifm/interfaces/interface/ifmAm4

Configure an interface to borrow the IPv4 address of another interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <interfaces> 
     <interface> 
          <ifName>Tunnel1</ifName> 
          <ifmAm4 operation="merge"> 
             <addrCfgType>unnumbered</addrCfgType> 
             <unNumIfName>10GE1/0/1</unNumIfName> 
          </ifmAm4> 
     </interface> 
    </interfaces>

    Table 3-60 describes elements in requests.

Table 3-60  Elements in requests

Element

Description

ifName

Specifies an interface name. The value is a string of 1 to 63 characters.

ifmAm4

Specifies the IPv4 address configuration, including whether to use a configured, negotiated, or borrowed IPv4 address.

addrCfgType

Specifies the type of IPv4 address to be used. The value is an enumerated type and case-sensitive.

config: configured IPv4 address

negotiation: negotiated IPv4 address

unnumbered: borrowed IPv4 address

unNumIfName

Specifies the name of the interface whose IPv4 address needs to be borrowed. The value is a string of 1 to 63 characters.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>  
    <ok/> 

    Table 3-61 describes status codes in responses.

Table 3-61  Description of status codes in responses

Status Code

Description

200 OK

The operation succeeds.

400 Bad Request

The request cannot be implemented because the request is incorrect in syntax or the information attribute in the request is incorrect.

500 Internal Server Error

Internal errors in services cause a request failure or an unidentified request.

Query an Interface's IPv4 Address Borrowed from Another Interface

Operation

URI

Description

GET

/ifm/interfaces/interface/ifmAm4

Query an interface's IPv4 address borrowed from another interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <interfaces> 
        <interface> 
            <ifName>Tunnel1</ifName> 
            <ifmAm4/> 
        </interface> 
    </interfaces>

    Table 3-62 describes elements in requests.

Table 3-62  Elements in requests

Element

Description

ifName

Specifies an interface name.

ifmAm4

Specifies the IPv4 address configuration, including whether to use a configured, negotiated, or borrowed IPv4 address.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <interfaces> 
        <interface> 
           <ifName>Tunnel1</ifName> 
           <ifmAm4> 
             <unNumIfName>10GE1/0/1</unNumIfName> 
             <addrCfgType>unnumbered</addrCfgType> 
             <am4CfgAddrs> 
                <am4CfgAddr> 
                    <ifIpAddr>1.1.1.1</ifIpAddr> 
                    <subnetMask>255.255.254.0</subnetMask> 
                    <addrType>unnumber</addrType> 
                </am4CfgAddr> 
             </am4CfgAddrs> 
           </ifmAm4> 
        </interface> 
    </interfaces>

    Table 2 describes elements in responses.

Table 3-63  Elements in responses

Element

Description

ifName

Specifies an interface name. The value is a string of 1 to 63 characters.

ifmAm4

Specifies the IPv4 address configuration, including whether to use a configured, negotiated, or borrowed IPv4 address.

unNumIfName

Specifies the name of the interface whose IPv4 address is borrowed. The value is a string of 1 to 63 characters.

addrCfgType

Specifies the IPv4 address assignment mode. The value is an enumerated type and case-sensitive.

config: configured IPv4 address

negotiation: negotiated IPv4 address

unnumbered: borrowed IPv4 address

am4CfgAddrs

Specifies an IPv4 address list.

am4CfgAddr

Specifies IPv4 address configurations.

ifIpAddr

Specifies an IPv4 address. The value is a string of 0 to 255 characters, in dotted decimal notation.

subnetMask

Specifies an IPv4 address mask. The value is a string of 0 to 255 characters, in dotted decimal notation.

addrType

Specifies an IPv4 address type. The value is an enumerated type and case-sensitive.

main: primary IP address

sub: secondary IP address

unnumbered: borrowed IP address

The default value is main.

Table 3 describes status codes in responses.

Table 3-64  Description of status codes in responses

Status Code

Description

200 OK

The operation succeeds.

400 Bad Request

The request cannot be implemented because the request is incorrect in syntax or the information attribute in the request is incorrect.

500 Internal Server Error

Internal errors in services cause a request failure or an unidentified request.

Delete an Interface's IPv4 Address Borrowed from Another Interface

Operation

URI

Description

PUT

/ifm/interfaces/interface/ifmAm4

Delete an interface's IPv4 address borrowed from another interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <interfaces> 
     <interface> 
          <ifName>Tunnel1</ifName> 
          <ifmAm4 operation="merge"> 
             <addrCfgType>unnumbered</addrCfgType> 
             <unNumIfName></unNumIfName> 
          </ifmAm4> 
     </interface> 
    </interfaces>

    Table 3-65 describes elements in requests.

Table 3-65  Elements in requests

Element

Description

ifName

Specifies an interface name. The value is a string of 1 to 63 characters.

ifmAm4

Specifies the IPv4 address configuration, including whether to use a configured, negotiated, or borrowed IPv4 address.

addrCfgType

Specifies the IPv4 address assignment mode. The value is an enumerated type and case-sensitive.

config: configured IPv4 address

negotiation: negotiated IPv4 address

unnumbered: borrowed IPv4 address

unNumIfName

Specifies the name of the interface whose IPv4 address is borrowed. The value is a string of 1 to 63 characters.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>  
    <ok/> 

    Table 3-66 describes status codes in responses.

Table 3-66  Description of status codes in responses

Status Code

Description

200 OK

The operation succeeds.

400 Bad Request

The request cannot be implemented because the request is incorrect in syntax or the information attribute in the request is incorrect.

500 Internal Server Error

Internal errors in services cause a request failure or an unidentified request.

Translation
Download
Updated: 2019-03-21

Document ID: EDOC1000166567

Views: 17339

Downloads: 116

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