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 Protocol VLAN

Interface Protocol VLAN

Add an Interface to a Protocol VLAN

Operation

URI

Description

PUT

/ethernet/ethernetIfs/ethernetIf

Add an interface to a protocol VLAN.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
        <ethernetIf operation="merge">
            <ifName>10GE1/0/1</ifName>
            <l2Attribute>
                <ifProtocolVlans>
                    <ifProtocolVlan operation="create">
                        <vlan>2</vlan>
                        <protocolIndex>1</protocolIndex>
                        <priority>5</priority>
                    </ifProtocolVlan>
                </ifProtocolVlans>
            </l2Attribute>
        </ethernetIf>

    Table 3-503 describes elements in requests.

    Table 3-503  Elements

    Element

    Description

    vlan

    Specifies the ID of the VLAN to which an interface is added.

    protocolIndex

    Specifies a protocol index.

    priority

    Specifies a priority.

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

    Table 3-504 describes status codes in responses.

    Table 3-504  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.

Remove an Interface from a Protocol VLAN

Operation

URI

Description

DELETE

//ethernet/ethernetIfs/ethernetIf

Remove an interface from a protocol VLAN.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
        <ethernetIf>
            <ifName>10GE1/0/1</ifName>
            <l2Attribute>
                <ifProtocolVlans>
                    <ifProtocolVlan operation="merge">
                        <vlan>3</vlan>
                        <protocolIndex>1</protocolIndex>
                     </ifProtocolVlan>
                </ifProtocolVlans>
            </l2Attribute>
        </ethernetIf>

    Table 3-505 describes elements in requests.

    Table 3-505  Elements

    Element

    Description

    vlan

    Specifies the ID of the VLAN to which an interface is added.

    protocolIndex

    Specifies a protocol index.

    priority

    Specifies a priority.

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

    Table 3-506 describes status codes in responses.

    Table 3-506  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 Protocol VLAN of an Interface

Operation

URI

Description

GET

/ethernet/ethernetIfs/ethernetIf

Query the protocol VLAN of an interface.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
        <ethernetIf>
            <ifName>10GE1/0/1</ifName>
            <l2Attribute>
                <ifProtocolVlans>
                    <ifProtocolVlan>
                        <vlan></vlan>
                        <protocolIndex></protocolIndex>
                        <priority></priority>
                    </ifProtocolVlan>
                </ifProtocolVlans>
            </l2Attribute>
        </ethernetIf>

    Table 3-507 describes elements in requests.

    Table 3-507  Elements

    Element

    Description

    vlan

    Specifies the ID of the VLAN to which an interface is added.

    protocolIndex

    Specifies a protocol index.

    priority

    Specifies a priority.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
        <ethernetIf>
            <ifName>10GE1/0/1</ifName>
            <l2Attribute>
                <ifIndex>8</ifIndex>
                <ifProtocolVlans>
                    <ifProtocolVlan>
                        <vlan>3</vlan>
                        <protocolIndex>2</protocolIndex>
                        <priority>0</priority>
                     </ifProtocolVlan>
                </ifProtocolVlans>
            </l2Attribute>
        </ethernetIf>

    Table 3-508 describes elements in responses.

    Table 3-508  Elements

    Element

    Description

    vlan

    Specifies the ID of the VLAN to which an interface is added.

    protocolIndex

    Specifies a protocol index.

    priority

    Specifies a priority.

    Table 3-509 describes status codes in responses.

    Table 3-509  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.

Translation
Download
Updated: 2019-03-21

Document ID: EDOC1000166567

Views: 30662

Downloads: 127

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