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).
Configure a VRRP Backup Group

Configure a VRRP Backup Group

Query a VRRP Backup Group

Operation

URI

Description

GET

/vrrp/vrrpGroups/vrrpGroup

Query information about a VRRP backup group, including the ID of the VRRP backup group and the name of the interface on which the VRRP backup group resides.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <vrrpId></vrrpId> 
          <ifName></ifName> 
          <vrrpType></vrrpType> 
          <adminIgnoreIfDown></adminIgnoreIfDown> 
          <unflowdown></unflowdown> 
          <adminVrrpId></adminVrrpId> 
          <adminIfName></adminIfName> 
          <lbrgVrrpId></lbrgVrrpId> 
          <state></state> 
          <priority></priority> 
          <runPriority></runPriority> 
          <masterPriority></masterPriority> 
          <masterIp></masterIp> 
          <createTime></createTime> 
          <lchangeTime></lchangeTime> 
          <advertiseInterval></advertiseInterval> 
          <runAdvertiseInterval></runAdvertiseInterval> 
          <preemptMode></preemptMode> 
          <delayTime></delayTime> 
          <remainTime></remainTime> 
          <authenticationMode></authenticationMode> 
          <isPlain></isPlain> 
          <authenticationKey></authenticationKey> 
          <linkBfdDownNum></linkBfdDownNum> 
          <virtualMac></virtualMac> 
          <fastResume></fastResume> 
          <v3SendMode></v3SendMode> 
    </vrrpGroup>

    Table 27-12 describes elements in requests.

    Table 27-12 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 resides.

    vrrpType

    Specifies the type of a VRRP backup group.

    adminIgnoreIfDown

    Specifies that an mVRRP backup group ignores an interface Down event.

    unflowdown

    Specifies that the Flowdown function is disabled for a service VRRP backup group.

    adminVrrpId

    Specifies the ID of a bound mVRRP backup group.

    adminIfName

    Specifies the name of the interface on which a bound mVRRP backup group resides.

    lbrgVrrpId

    Specifies the ID of an LBRG.

    state

    Specifies the status of a VRRP backup group. When a VRRP backup group works properly, it has the following values:

    • Master
    • Backup
    • Initialize

    priority

    Specifies the priority configured for the router in the VRRP backup group. The value is an integer ranging from 1 to 254. A larger value indicates a higher priority.

    runPriority

    Specifies the running priority (that is, the current priority) of the router in the VRRP backup group. If the router is an IP address owner, its running priority is displayed as 255.

    masterPriority

    Specifies the priority of the master router in the VRRP backup group.

    masterIp

    Specifies the IP address of the master router in the VRRP backup group.

    createTime

    Specifies the time when the VRRP backup group was created.

    lchangeTime

    Specifies the time when the status of the VRRP backup group last changed.

    advertiseInterval

    Specifies the configured interval at which VRRP packets are sent, in milliseconds.

    runAdvertiseInterval

    Specifies the running interval at which VRRP packets are sent, in milliseconds.

    preemptMode

    Specifies a preemption mode.

    delayTime

    Specifies a preemption delay, in seconds.

    remainTime

    Specifies the remaining preemption delay, in seconds.

    authenticationMode

    Specifies an authentication mode in which the master and backup routers in the VRRP backup group exchange VRRP packets.

    • Non-authentication
    • Simple authentication
    • MD5 authentication

    Default value: non-authentication

    isPlain

    Specifies whether the authentication key of the VRRP backup group is displayed as a plaintext. By default, the authentication key of the VRRP backup group is displayed as a ciphertext.

    authenticationKey

    Specifies the authentication key.

    linkBfdDownNum

    Specifies the maximum number of link BFD sessions that trigger VRRP backup group status changes.

    virtualMac

    Specifies the virtual MAC address of the VRRP backup group.

    fastResume

    Specifies the fast switching mode of an mVRRP backup group.

    v3SendMode

    Specifies the mode in which VRRP packets are sent.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpId>1</vrrpId> 
        <state>master</state> 
        <priority>100</priority> 
        <runPriority>100</runPriority> 
        <masterPriority>100</masterPriority> 
        <advertiseInterval>1000</advertiseInterval> 
        <runAdvertiseInterval>1000</runAdvertiseInterval> 
        <preemptMode>true</preemptMode> 
        <delayTime>0</delayTime> 
        <virtualMac>0000-5e00-0101</virtualMac> 
        <authenticationMode>none</authenticationMode> 
        <authenticationKey/> 
        <vrrpType>normal</vrrpType> 
        <adminVrrpId/> 
        <lbrgVrrpId/> 
        <adminIfName></adminIfName> 
        <adminIgnoreIfDown>false</adminIgnoreIfDown> 
        <linkBfdDownNum>0</linkBfdDownNum> 
        <isPlain>false</isPlain> 
        <unflowdown>false</unflowdown> 
        <masterIp>1.1.1.1</masterIp> 
        <remainTime>0</remainTime> 
        <createTime>2014-11-13T10:15:39</createTime> 
        <lchangeTime>2014-11-13T10:15:45</lchangeTime> 
        <fastResume>false</fastResume> 
        <v3SendMode>v2-only</v3SendMode> 
    </vrrpGroup>

    Table 27-13 describes elements in responses.

    Table 27-13 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 resides.

    vrrpType

    Specifies the type of a VRRP backup group.

    adminIgnoreIfDown

    Specifies that an mVRRP backup group ignores an interface Down event.

    unflowdown

    Specifies that the Flowdown function is disabled for a service VRRP backup group.

    adminVrrpId

    Specifies the ID of a bound mVRRP backup group.

    adminIfName

    Specifies the name of the interface on which a bound mVRRP backup group resides.

    lbrgVrrpId

    Specifies the ID of an LBRG.

    state

    Specifies the status of a VRRP backup group. When a VRRP backup group works properly, it has the following values:

    • Master
    • Backup
    • Initialize

    priority

    Specifies the priority configured for the router in the VRRP backup group. The value is an integer ranging from 1 to 254. A larger value indicates a higher priority.

    runPriority

    Specifies the running priority (that is, the current priority) of the router in the VRRP backup group. If the router is an IP address owner, its running priority is displayed as 255.

    masterPriority

    Specifies the priority of the master router in the VRRP backup group.

    masterIp

    Specifies the IP address of the master router in the VRRP backup group.

    createTime

    Specifies the time when the VRRP backup group was created.

    lchangeTime

    Specifies the time when the status of the VRRP backup group last changed.

    advertiseInterval

    Specifies the configured interval at which VRRP packets are sent, in milliseconds.

    runAdvertiseInterval

    Specifies the running interval at which VRRP packets are sent, in milliseconds.

    preemptMode

    Specifies a preemption mode.

    delayTime

    Specifies a preemption delay, in seconds.

    remainTime

    Specifies the remaining preemption delay, in seconds.

    authenticationMode

    Specifies an authentication mode in which the master and backup routers in the VRRP backup group exchange VRRP packets.

    • Non-authentication
    • Simple authentication
    • MD5 authentication

    Default value: non-authentication

    isPlain

    Specifies whether the authentication key of the VRRP backup group is displayed as a plaintext. By default, the authentication key of the VRRP backup group is displayed as a ciphertext.

    authenticationKey

    Specifies the authentication key.

    linkBfdDownNum

    Specifies the maximum number of link BFD sessions that trigger VRRP backup group status changes.

    virtualMac

    Specifies the virtual MAC address of the VRRP backup group.

    fastResume

    Specifies the fast switching mode of an mVRRP backup group.

    v3SendMode

    Specifies the mode in which VRRP packets are sent.

Create a VRRP Backup Group

Operation

URI

Description

POST

/vrrp/vrrpGroups/vrrpGroup

Create a VRRP backup group, including the ID of the VRRP backup group and the name of the interface on which the VRRP backup group resides.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="create" > 
    <vrrpId>2</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpType>normal</vrrpType> 
        <priority>100</priority> 
        <advertiseInterval>1000</advertiseInterval> 
        <preemptMode>true</preemptMode> 
        <delayTime>0</delayTime> 
        <authenticationMode>none</authenticationMode> 
    <linkBfdDownNum>1</linkBfdDownNum>
        <v3SendMode>v2v3-both</v3SendMode> 
        <virtualIps> 
             <virtualIp operation="merge" > 
                  <virtualIpAddress>2.2.2.100</virtualIpAddress> 
            </virtualIp> 
        </virtualIps> 
    </vrrpGroup>

    Table 27-14 describes elements in requests.

    Table 27-14 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 resides.

    vrrpType

    Specifies the type of a VRRP backup group.

    priority

    Specifies a priority for a router in a VRRP backup group. The value is an integer ranging from 1 to 254. A larger value indicates a higher priority.

    advertiseInterval

    Specifies an interval at which VRRP packets are sent, in milliseconds.

    preemptMode

    Specifies a preemption mode.

    delayTime

    Specifies a preemption delay, in seconds.

    authenticationMode

    Specifies an authentication mode in which the master and backup routers in the VRRP backup group exchange VRRP packets.

    • Non-authentication
    • Simple authentication
    • MD5 authentication

    Default value: non-authentication

    linkBfdDownNum

    Specifies the maximum number of link BFD sessions that trigger VRRP backup group status changes.

    v3SendMode

    Specifies the mode in which VRRP packets are sent.

    virtualIpAddress

    Specifies a virtual IP address.

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

    Table 27-15 describes status codes in responses.

    Table 27-15 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.

Modify a VRRP Backup Group

Operation

URI

Description

PUT

/vrrp/vrrpGroups/vrrpGroup

Modify information about a VRRP backup group, including the type of the VRRP backup group and configured priority.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="merge" > 
        <vrrpId>2</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
        <vrrpType>admin</vrrpType> 
        <adminIgnoreIfDown>true</adminIgnoreIfDown> 
        <priority>130</priority> 
        <advertiseInterval>3000</advertiseInterval> 
        <delayTime>3</delayTime> 
        <linkBfdDownNum>1</linkBfdDownNum> 
        <v3SendMode>v3-only</v3SendMode> 
    </vrrpGroup>

    Table 27-16 describes elements in requests.

    Table 27-16 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 resides.

    vrrpType

    Specifies the type of a VRRP backup group.

    adminIgnoreIfDown

    Specifies that an mVRRP backup group ignores an interface Down event.

    priority

    Specifies a priority for a router in a VRRP backup group. The value is an integer ranging from 1 to 254. A larger value indicates a higher priority.

    advertiseInterval

    Specifies an interval at which VRRP packets are sent, in milliseconds.

    delayTime

    Specifies a preemption delay, in seconds.

    linkBfdDownNum

    Specifies the maximum number of link BFD sessions that trigger VRRP backup group status changes.

    v3SendMode

    Specifies the mode in which VRRP packets are sent.

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

    Table 27-17 describes status codes in responses.

    Table 27-17 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 VRRP Backup Group

Operation

URI

Description

DELETE

/vrrp/vrrpGroups/vrrpGroup

Delete a VRRP backup group.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <vrrpGroup operation="delete"> 
        <vrrpId>2</vrrpId> 
        <ifName>10GE1/0/1</ifName> 
    </vrrpGroup>

    Table 27-18 describes elements in requests.

    Table 27-18 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 resides.

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

    Table 27-19 describes status codes in responses.

    Table 27-19 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-04-03

Document ID: EDOC1100075372

Views: 12823

Downloads: 18

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