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).
Configurations for a VRRP Backup Group to Track a BFD Session

Configurations for a VRRP Backup Group to Track a BFD Session

Query Information About a VRRP Backup Group Tracking a BFD Session

Operation

URI

Description

GET

/vrrp/vrrpGroups/vrrpGroup

Query information about a VRRP backup group tracking a BFD session.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackBfds> 
            <vrrpTrackBfd> 
                <bfdSessionName>trackbfd</bfdSessionName> 
                <bfdSessionId></bfdSessionId> 
                <bfdType>normal</bfdType> 
                <trackMode></trackMode> 
                <priorityChange></priorityChange> 
            </vrrpTrackBfd> 
        </vrrpTrackBfds> 
    </vrrpGroup>

    Table 1 describes elements in requests.

    Table 27-66 Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group is configured.

    bfdSessionName

    Specifies the name of a tracked BFD session.

    bfdSessionId

    Specifies the ID of a tracked BFD session.

    bfdType

    Specifies the type of a tracked BFD session..

    trackMode

    Specifies a mode in which a BFD session is tracked.

    priorityChange

    Specifies a value by which the priority is increased or decreased.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId>1</vrrpId> 
        <vrrpTrackBfds> 
            <vrrpTrackBfd> 
                <bfdSessionId>1</bfdSessionId> 
                <trackMode>reduce</trackMode> 
                <priorityChange>10</priorityChange> 
                <bfdType>normal</bfdType> 
                <bfdSessionName>trackbfd</bfdSessionName> 
            </vrrpTrackBfd> 
        </vrrpTrackBfds> 
    </vrrpGroup>

    Table 2 describes elements in responses.

    Table 27-67 Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group is configured.

    bfdSessionName

    Specifies the name of a tracked BFD session.

    bfdSessionId

    Specifies the ID of a tracked BFD session.

    bfdType

    Specifies the type of a tracked BFD session.

    trackMode

    Specifies a mode in which a BFD session is tracked.

    priorityChange

    Specifies a value by which the priority is increased or decreased.

Configure a VRRP Backup Group to Track a BFD Session

Operation

URI

Description

POST

/vrrp/vrrpGroups/vrrpGroup

Configure a VRRP backup group to track a BFD session.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="merge"> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackBfds> 
            <vrrpTrackBfd operation="create"> 
                <bfdSessionName>trackbfd</bfdSessionName> 
                <bfdType>normal</bfdType> 
                <trackMode>reduce</trackMode> 
                <priorityChange>10</priorityChange> 
            </vrrpTrackBfd> 
        </vrrpTrackBfds> 
    </vrrpGroup>

    Table 3 describes elements in requests.

    Table 27-68 Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group is configured.

    bfdSessionName

    Specifies the name of a tracked BFD session.

    bfdType

    Specifies the type of a tracked BFD session.

    trackMode

    Specifies a mode in which a BFD session is tracked.

    priorityChange

    Specifies a value by which the priority is increased or decreased.

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

    Table 4 describes status codes in responses.

    Table 27-69 Status codes

    Status Code

    Description

    200 OK

    The operation is successful.

    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.

Modify Information About a VRRP Backup Group Tracking a BFD Session

Operation

URI

Description

PUT

/vrrp/vrrpGroups/vrrpGroup

Modify information about a VRRP backup group tracking a BFD session.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="merge"> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackBfds> 
            <vrrpTrackBfd operation="merge"> 
                <bfdSessionName>trackbfd</bfdSessionName> 
                <bfdType>normal</bfdType> 
                <trackMode>increase</trackMode> 
                <priorityChange>20</priorityChange> 
            </vrrpTrackBfd> 
        </vrrpTrackBfds> 
    </vrrpGroup>

    Table 5 describes elements in requests.

    Table 27-70 Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group is configured.

    bfdSessionName

    Specifies the name of a tracked BFD session.

    bfdType

    Specifies the type of a tracked BFD session.

    trackMode

    Specifies a mode in which a BFD session is tracked.

    priorityChange

    Specifies a value by which the priority is increased or decreased.

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

    Table 6 describes status codes in responses.

    Table 27-71 Status codes

    Status Code

    Description

    200 OK

    The operation is successful.

    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 Information About a VRRP Backup Group Tracking a BFD Session

Operation

URI

Description

PUT

/vrrp/vrrpGroups/vrrpGroup

Delete information about a VRRP backup group tracking a BFD session.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="merge"> 
        <vrrpId>1</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpTrackBfds> 
            <vrrpTrackBfd operation="delete"> 
                <bfdSessionName>trackbfd</bfdSessionName> 
                <bfdType>normal</bfdType> 
            </vrrpTrackBfd> 
        </vrrpTrackBfds> 
    </vrrpGroup>

    Table 7 describes elements in requests.

    Table 27-72 Elements

    Element

    Description

    vrrpId

    Specifies the ID of a VRRP backup group.

    ifName

    Specifies the name of the interface on which a VRRP backup group is configured.

    bfdSessionName

    Specifies the name of a tracked BFD session.

    bfdType

    Specifies the type of a tracked BFD session.

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

    Table 8 describes status codes in responses.

    Table 27-73 Status codes

    Status Code

    Description

    200 OK

    The operation is successful.

    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: 10369

Downloads: 16

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