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).
Query BGP Peer Information

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 28-17 describes elements in requests.

    Table 28-17 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 28-18 describes elements in responses.

    Table 28-18 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 28-19 describes status codes in responses.

    Table 28-19 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 28-20 describes elements in requests.

    Table 28-20 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 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. 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 28-21 describes elements in responses.

    Table 28-21 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 28-22 describes status codes in responses.

    Table 28-22 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.

Translation
Download
Updated: 2019-04-03

Document ID: EDOC1100075372

Views: 10378

Downloads: 16

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