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).
BGP

BGP

Query BGP Peer Information

Query BGP Peer Information in a VPN Instance

Operation

URI

Description

GET

/bgp/bgpcomm/bgpVrfs/bgpVrf/

Query BGP peer information in a VPN instance.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?>
    <bgpVrf>
        <vrfName></vrfName>
        <bgpPeers>
            <bgpPeer>
                <peerAddr></peerAddr>
                <groupName></groupName>
                <remoteAs></remoteAs>
            </bgpPeer>
        </bgpPeers>
    </bgpVrf>

    Table 3-792 describes elements in requests.

    Table 3-792  Elements

    Element

    Description

    vrfName

    Specifies the name of a VPN instance. This parameter is optional.

    peerAddr

    Specifies the IP address of a BGP peer. This parameter is optional.

    groupName

    Specifies the name of a BGP peer group. This parameter is optional.

    remoteAs

    Specifies the AS number of a BGP peer. This parameter is optional.

  • Response example (XML format)
    <?xml version='1.0' encoding='UTF-8'?>
    <bgpVrf>
      <vrfName>_public_</vrfName>
      <bgpPeers>
        <bgpPeer>
          <peerAddr>1.1.1.1</peerAddr>
          <remoteAs>100</remoteAs>
          <groupName></groupName>
        </bgpPeer>
      </bgpPeers>
    </bgpVrf>

    Table 3-793 describes elements in responses.

    Table 3-793  Elements

    Element

    Description

    vrfName

    Specifies a VPN instance name.

    peerAddr

    Specifies the IP address of a BGP peer.

    remoteAs

    Specifies the AS number of a BGP peer.

    groupName

    Specifies the name of a BGP peer group.

    Table 3-794 describes status codes in responses.

    Table 3-794  Status codes in responses

    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 BGP Peer Information in a VPN Instance Address Family

Operation

URI

Description

GET

/bgp/bgpcomm/bgpVrfs/bgpVrf/

Query BGP peer information in a VPN instance address family.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?>
    <bgpVrf>
        <vrfName></vrfName>
        <bgpVrfAFs>
            <bgpVrfAF>
                <afType></afType>
                <peerAFs>
                    <peerAF>
                        <remoteAddress></remoteAddress>
                        <peerGroupName></peerGroupName>
                    </peerAF>
                </peerAFs>
            </bgpVrfAF>
        </bgpVrfAFs>
    </bgpVrf>

    Table 3-795 describes elements in requests.

    Table 3-795  Elements

    Element

    Description

    vrfName

    Specifies the name of a VPN instance. This parameter is optional.

    afType

    Specifies the name of a VPN instance address family, which can be ipv4uniipv4multiipv4vpnipv4labeluniipv6uniipv6vpnipv4flowl2vpnadevpn, or mvpn. The value range varies with the version.

    remoteAddress

    Specifies the IP address of a BGP peer. This parameter is optional.

    peerGroupName

    Specifies the name of a BGP peer group. This parameter is optional.

  • Response example (XML format)
    <?xml version='1.0' encoding='UTF-8'?>
    <bgpVrf>
      <vrfName>_public_</vrfName>
      <bgpVrfAFs>
        <bgpVrfAF>
          <afType>ipv4uni</afType>
          <peerAFs>
            <peerAF>
              <remoteAddress>1.1.1.1</remoteAddress>
              <peerGroupName></peerGroupName>
            </peerAF>
          </peerAFs>
        </bgpVrfAF>
      </bgpVrfAFs>
    </bgpVrf>

    Table 3-796 describes elements in responses.

    Table 3-796  Elements

    Element

    Description

    vrfName

    Specifies a VPN instance name.

    afType

    Specifies the VPN instance address family. The value can be ipv4uni, ipv4multi, ipv4vpn, ipv4labeluni, ipv6uni, ipv6vpn, ipv4flow, l2vpnad, evpn, or mvpn. The value range varies with the version.

    remoteAddress

    Specifies the IP address of a BGP peer.

    peerGroupName

    Specifies the name of a BGP peer group.

    Table 3-797 describes status codes in responses.

    Table 3-797  Status codes in responses

    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.

Enable BGP

Operation

URI

Description

POST

/bgp/bgpcomm

Enable BGP.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?>
    <bgpcomm>
        <bgpSite operation="merge">
            <asNumber>100</asNumber>
            <bgpEnable>true</bgpEnable>
        </bgpSite>
    </bgpcomm>

    Table 3-798 describes elements in requests.

    Table 3-798  Elements

    Element

    Description

    asNumber

    Specifies a local AS number. This parameter is mandatory.

    bgpEnable

    Enables or disables BGP. This parameter is mandatory.

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

    Table 3-799 describes status codes in responses.

    Table 3-799  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 a BGP Address Family

Operation

URI

Description

POST

/bgp/bgpcomm

Configure a BGP address family.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?>
    <bgpcomm>
        <bgpVrfs>
            <bgpVrf operation="merge">
                <vrfName>_public_</vrfName>
                <keepaliveTime>30</keepaliveTime>
                <holdTime>90</holdTime>
                <bgpVrfAFs>
                    <bgpVrfAF operation="merge">
                        <afType>ipv4uni</afType>
                        <maximumLoadBalance>32</maximumLoadBalance>
                        <asPathNeglect>true</asPathNeglect>
                        <loadBalancingAsPathIgnore>true</loadBalancingAsPathIgnore>
                        <importRoutes>
                            <importRoute operation="merge">
                                <importProtocol>direct</importProtocol>
                                <importProcessId>0</importProcessId>
                            </importRoute>
                        </importRoutes>
                    </bgpVrfAF>
                </bgpVrfAFs>
            </bgpVrf>
        </bgpVrfs>
    </bgpcomm>

    Table 3-800 describes elements in requests.

    Table 3-800  Elements

    Element

    Description

    vrfName

    Specifies the name of a VPN instance. This parameter is mandatory.

    keepaliveTime

    Specifies a timeout interval for the keepalive timer. This parameter is optional.

    holdTime

    Specifies a timeout interval for the holdTime timer. This parameter is optional.

    afType

    Specifies an address familiy type for an instance. This parameter is mandatory.

    maximumLoadBanlance

    Specifies the maximum number of load balancing routes for the instance address family. This parameter is optional.

    asPathNeglect

    Controls whether to ignore the AS_Path attribute in route selection. This parameter is optional.

    loadBanlancingAsPathIgnore

    Controls whether to ignore the AS_Path attribute in the selection of load balancing routes. This parameter is optional.

    importProtocol

    Specifies the name of a protocol whose routes are to be imported. This parameter is mandatory if the importRoute parameter is specified.

    importProcessId

    Specifies the process ID of a protocol whose routes are to be imported (this parameter is valid only for IGPs.) This parameter is mandatory if the importRoute parameter is specified.

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

    Table 3-801 describes status codes in responses.

    Table 3-801  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 a BGP Peer

Operation

URI

Description

POST

/bgp/bgpcomm

Configure a BGP peer.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?>
    <bgpcomm>
        <bgpVrfs>
            <bgpVrf operation="merge">
                <vrfName>_public_</vrfName>
                <bgpPeers>
                    <bgpPeer operation="merge">
                        <peerAddr>1.1.1.1</peerAddr>
                        <remoteAs>100</remoteAs>
                        <description>public</description>
                    </bgpPeer>
                </bgpPeers>
                <bgpVrfAFs>
                    <bgpVrfAF operation="merge">
                        <afType>ipv4uni</afType>
                        <peerAFs>
                            <peerAF operation="merge">
                                <remoteAddress>1.1.1.1</remoteAddress>
                                <keepAllRoutes>true</keepAllRoutes>
                                <allowAsLoopEnable>true</allowAsLoopEnable>
                                <importRtPolicyName>rtp1</importRtPolicyName>
                                <exportRtPolicyName>rtp1</exportRtPolicyName>
                            </peerAF>
                        </peerAFs>
                    </bgpVrfAF>
                </bgpVrfAFs>
            </bgpVrf>
        </bgpVrfs>
    </bgpcomm>

    Table 3-802 describes elements in requests.

    Table 3-802  Elements

    Element

    Description

    vrfName

    Specifies the name of a VPN instance. This parameter is mandatory.

    peerAddr

    Specifies the IP address of a BGP peer. This parameter is mandatory.

    remoteAs

    Specifies a remote AS number. This parameter is mandatory.

    description

    Specifies the description of a BGP peer. This parameter is optional.

    afType

    Specifies an address familiy for an instance. This parameter is mandatory.

    remoteAddress

    Specifies the IP address of a BGP peer. This parameter is mandatory.

    keepAllRoutes

    Enables or disables the keep-all-routes capability. This parameter is optional.

    allowAsLoopEnable

    Allows or disallows duplicated AS numbers. This parameter is optional.

    importRtPolicyName

    Specifies the import policy of the BGP peer. This parameter is optional.

    exportRtPolicyName

    Specifies the export policy of the BGP peer. This parameter is optional.

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

    Table 3-803 describes status codes in responses.

    Table 3-803  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: 30856

Downloads: 127

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