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

Protocol VLAN

Create a Protocol VLAN

Operation

URI

Description

POST

/vlan/vlans/vlan

Create a protocol VLAN.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
        <vlan operation="merge">
            <vlanId>1</vlanId>
            <protocolVlans>
                <protocolVlan operation="create">
                    <protocolIndex>2</protocolIndex>
                    <protocolType>at</protocolType>
                </protocolVlan>
            </protocolVlans>
        </vlan>

    Table 3-452 describes elements in requests.

    Table 3-452  Elements

    Element

    Description

    vlanId

    Specifies a VLAN ID.

    protocolIndex

    Specifies a protocol index.

    protocolType

    Specifies a protocol template.

    • Mode: user-defined template.
    • ipv4: IPv4 template.
    • ipv6: IPv6 template.
    • at: AT template.
    • ipx_ethernetii: IPX_Ethernet II template.
    • ipx_llc: IPX_LLC template.
    • ipx_raw: IPX_RAW template.
    • ipx_snap: IPX_SNAP template.

    snapProtocolValue

    Specifies an SNAP protocol type.

    ethiiProtocolValue

    Specifies an Ethernet II protocol type.

    dsap

    Specifies a DSAP type.

    ssap

    Specifies an SSAP type.

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

    Table 3-453 describes status codes in responses.

    Table 3-453  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 Protocol VLAN Information

Operation

URI

Description

GET

/vlan/vlans/vlan

Query protocol VLAN information.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
        <vlan>
            <vlanId>1</vlanId>
            <protocolVlans>
                <protocolVlan>
                    <protocolIndex>2</protocolIndex>
                    <protocolType>at</protocolType>
                    <encapType></encapType>
                    <snapProtocolValue></snapProtocolValue>
                    <ethiiProtocolValue></ethiiProtocolValue>
                    <dsap></dsap>
                    <ssap></ssap>
                </protocolVlan>
            </protocolVlans>
        </vlan>

    Table 3-454 describes elements in requests.

    Table 3-454  Elements

    Element

    Description

    vlanId

    Specifies a VLAN ID.

    protocolIndex

    Specifies a protocol index.

    protocolType

    Specifies a protocol template.

    • Mode: user-defined template.
    • ipv4: IPv4 template.
    • ipv6: IPv6 template.
    • at: AT template.
    • ipx_ethernetii: IPX_Ethernet II template.
    • ipx_llc: IPX_LLC template.
    • ipx_raw: IPX_RAW template.
    • ipx_snap: IPX_SNAP template.

    snapProtocolValue

    Specifies an SNAP protocol type.

    ethiiProtocolValue

    Specifies an Ethernet II protocol type.

    dsap

    Specifies a DSAP type.

    ssap

    Specifies an SSAP type.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
        <vlan>
            <vlanId>1</vlanId>
            <protocolVlans>
                <protocolVlan>
                    <protocolType>at</protocolType>
                    <protocolIndex>2</protocolIndex>
                    <encapType/>
                    <snapProtocolValue/>
                    <ethiiProtocolValue/>
                    <dsap/>
                    <ssap/>
                </protocolVlan>
            </protocolVlans>
        </vlan>

    Table 3-455 describes elements in responses.

    Table 3-455  Elements

    Element

    Description

    vlanId

    Specifies a VLAN ID.

    protocolIndex

    Specifies a protocol index.

    protocolType

    Specifies a protocol template.

    • Mode: user-defined template.
    • ipv4: IPv4 template.
    • ipv6: IPv6 template.
    • at: AT template.
    • ipx_ethernetii: IPX_Ethernet II template.
    • ipx_llc: IPX_LLC template.
    • ipx_raw: IPX_RAW template.
    • ipx_snap: IPX_SNAP template.

    snapProtocolValue

    Specifies an SNAP protocol type.

    ethiiProtocolValue

    Specifies an Ethernet II protocol type.

    dsap

    Specifies a DSAP type.

    ssap

    Specifies an SSAP type.

    Table 3-456 describes status codes in responses.

    Table 3-456  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 a Protocol VLAN

Operation

URI

Description

POST

/vlan/vlans/vlan

Delete a protocol VLAN.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
        <vlan>
            <vlanId>1</vlanId>
            <protocolVlans>
                <protocolVlan operation="merge">
                    <protocolIndex>2</protocolIndex>
                    <protocolType>at</protocolType>
                </protocolVlan>
            </protocolVlans>
        </vlan>

    Table 3-457 describes elements in requests.

    Table 3-457  Elements

    Element

    Description

    vlanId

    Specifies a VLAN ID.

    protocolIndex

    Specifies a protocol index.

    protocolType

    Specifies a protocol template.

    • Mode: user-defined template.
    • ipv4: IPv4 template.
    • ipv6: IPv6 template.
    • at: AT template.
    • ipx_ethernetii: IPX_Ethernet II template.
    • ipx_llc: IPX_LLC template.
    • ipx_raw: IPX_RAW template.
    • ipx_snap: IPX_SNAP template.

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

    Table 3-458 describes status codes in responses.

    Table 3-458  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: 30948

Downloads: 127

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