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 on a TRILL Multi-Topology

Configurations on a TRILL Multi-Topology

Query the TRILL Routing Information

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillSiteMTs/trillSiteMT/trillRouteInfos/trillRouteInfo

Query the TRILL routing information.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
        <trillSite>
            <instanceId>0</instanceId>
            <trillSiteMTs>
                <trillSiteMT>
                    <mtId>0</mtId>
                    <trillRouteInfos>
                        <trillRouteInfo>
                            <nickName></nickName>
                            <cost></cost>
                            <outInterface></outInterface>
                            <outVlan></outVlan>
                            <nextHopName></nextHopName>
                            <hopCount></hopCount>
                            <flag></flag>
                            <age></age>
                        </trillRouteInfo>
                    </trillRouteInfos>
                </trillSiteMT>
            </trillSiteMTs>
        </trillSite>

Elements

Element

Description

Value Range

Mandatory/Optional

mtId

TRILL multi-topology ID.

The value is an integer.

Mandatory

nickName

Nickname prefix of a route.

The value is an integer.

Mandatory

cost

Cost value of a route.

The value is an integer.

Optional

outInterface

Outbound interface name of a route.

The value is a string.

Optional

outVlan

Outer VLAN ID of a route.

The value is an integer.

Optional

nextHopName

Next-hop address of a route.

The value is a string.

Optional

hopCount

Hop count of a route.

The value is an integer.

Optional

flag

Route Information Flag.

The value is a string.

Optional

age

Route Time.

The value is a string.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?>      
       <trillSite>
          <instanceId>0</instanceId>
          <trillSiteMTs>
            <trillSiteMT>
              <mtId>0</mtId>
              <trillRouteInfos>
                <trillRouteInfo>
                  <nickName>10</nickName>
                  <cost>200000</cost>
                  <outInterface>Eth3/0/0</outInterface>
                  <outVlan>100</outVlan>
                  <nextHopName>10/380e-a811-1200</nextHopName>
                  <hopCount>1</hopCount>
                  <flag>D/R</flag>
                  <age>15m33s</age>
                </trillRouteInfo>
              </trillRouteInfos>
            </trillSiteMT>
          </trillSiteMTs>
        </trillSite>  

Elements

Element

Description

Value Range

Mandatory/Optional

mtId

TRILL multi-topology ID.

The value is an integer.

Mandatory

nickName

Nickname prefix of a route.

The value is an integer.

Mandatory

cost

Cost value of a route.

The value is an integer.

Optional

outInterface

Outbound interface name of a route.

The value is an ENUM type.

Optional

outVlan

Outer VLAN ID of a route.

The value is an integer.

Optional

nextHopName

Next-hop address of a route.

The value is a string.

Optional

hopCount

Hop count of a route.

The value is an integer.

Optional

flag

Route Information Flag.

The value is a string.

Optional

age

Route Time.

The value is a string.

Optional

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 TRILL Multicast Routes

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillSiteMTs/trillSiteMT/trillMRouteInfos/trillMRouteInfo

Query TRILL multicast routes.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
        <trillSite>
            <instanceId>0</instanceId>
            <trillSiteMTs>
                <trillSiteMT>
                    <mtId>0</mtId>
                    <trillMRouteInfos>
                        <trillMRouteInfo>
                            <vlan></vlan>
                            <rootNickname></rootNickname>
                            <hopCount></hopCount>
                        </trillMRouteInfo>
                    </trillMRouteInfos>
                </trillSiteMT>
            </trillSiteMTs>
        </trillSite>

Elements

Element

Description

Value Range

Mandatory/Optional

mtId

Multi-topology ID

The value is an integer.

Mandatory

vlan

Multicast VLAN

The value is an integer.

Mandatory

rootNickname

Multicast root nickname

The value is an integer.

Mandatory

hopCount

Hop count

The value is an integer.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?>       
       <trillSite>
          <instanceId>0</instanceId>
          <trillSiteMTs>
            <trillSiteMT>
              <mtId>0</mtId>
              <trillMRouteInfos>
                <trillMRouteInfo>
                  <vlan>19</vlan>
                  <rootNickname>10</rootNickname>
                  <hopCount>2</hopCount>
                </trillMRouteInfo>
              </trillMRouteInfos>
            </trillSiteMT>
          </trillSiteMTs>
        </trillSite>  

Elements

Element

Description

Value Range

Mandatory/Optional

mtId

Multi-topology ID

The value is an integer.

Mandatory

vlan

Multicast VLAN

The value is an integer.

Mandatory

rootNickname

Multicast root nickname

The value is an integer.

Mandatory

hopCount

Hop count

The value is an integer.

Optional

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 the TRILL Multicast Routing Downstream Interface Information

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillSiteMTs/trillSiteMT/trillMRouteInfos/trillMRouteInfo/trillMRouteOutInterfaceInfos/trillMRouteOutInterfaceInfo

Query the TRILL multicast routing downstream interface information.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
        <trillSite>
            <instanceId>0</instanceId>
            <trillSiteMTs>
                <trillSiteMT>
                    <mtId>0</mtId>
                    <trillMRouteInfos>
                        <trillMRouteInfo>
                            <vlan>19</vlan>
                            <rootNickname>10</rootNickname>
                            <trillMRouteOutInterfaceInfos>
                                <trillMRouteOutInterfaceInfo>
                                    <outInterface></outInterface>
                                    <outVlan></outVlan>
                                    <flag></flag>
                                    <age></age>
                                    <nexpSystemId></nexpSystemId>
                                </trillMRouteOutInterfaceInfo>
                            </trillMRouteOutInterfaceInfos>
                        </trillMRouteInfo>
                    </trillMRouteInfos>
                </trillSiteMT>
            </trillSiteMTs>
        </trillSite>

Elements

Element

Description

Value Range

Mandatory/Optional

mtId

TRILL multi-topology ID.

The value is an integer.

Mandatory

vlan

VLAN ID of a multicast route.

The value is an integer.

Optional

rootNickname

Root nickname of a multicast route.

The value is an integer.

Optional

outInterface

Outbound interface name of a route.

The value is an ENUM type.

Optional

outVlan

Outer VLAN ID of a out interface.

The value is an integer.

Optional

flag

Route Information Flag.

The value is a string.

Optional

age

Route Time.

The value is a string.

Optional

nexpSystemId

Root System ID.

The value is a string.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?>       
       <trillSite>
          <instanceId>0</instanceId>
          <trillSiteMTs>
            <trillSiteMT>
              <mtId>0</mtId>
              <trillMRouteInfos>
                <trillMRouteInfo>
                  <vlan>19</vlan>
                  <rootNickname>10</rootNickname>
                  <trillMRouteOutInterfaceInfos>
                    <trillMRouteOutInterfaceInfo>
                      <outInterface>Eth3/0/0</outInterface>
                      <outVlan>100</outVlan>
                      <flag>-/-/T/D</flag>
                      <age>55m33s</age>
                      <nexpSystemId>0000.0000.0001</nexpSystemId>
                    </trillMRouteOutInterfaceInfo>
                  </trillMRouteOutInterfaceInfos>
                </trillMRouteInfo>
              </trillMRouteInfos>
            </trillSiteMT>
          </trillSiteMTs>
        </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

mtId

TRILL multi-topology ID.

The value is an integer.

Mandatory

vlan

VLAN ID of a multicast route.

The value is an integer.

Optional

rootNickname

Root nickname of a multicast route.

The value is an integer.

Optional

outInterface

Outbound interface name of a route.

The value is an ENUM type.

Optional

outVlan

Outer VLAN ID of a out interface.

The value is an integer.

Optional

flag

Route Information Flag.

The value is a string.

Optional

age

Route Time.

The value is a string.

Optional

nexpSystemId

Root System ID.

The value is a string.

Optional

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 Information About Pruned Routes in a TRILL Multicast Group

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillSiteMTs/trillSiteMT/trillMRouteGroupInfos/trillMRouteGroupInfo

Query information about pruned routes in a TRILL multicast group.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
        <trillSite>
            <instanceId>0</instanceId>
            <trillSiteMTs>
                <trillSiteMT>
                    <mtId>0</mtId>
                    <trillMRouteGroupInfos>
                        <trillMRouteGroupInfo>
                            <vlan></vlan>
                            <groupIp></groupIp>
                            <rootNickname></rootNickname>
                            <hopCount></hopCount>
                        </trillMRouteGroupInfo>
                    </trillMRouteGroupInfos>
                </trillSiteMT>
            </trillSiteMTs>
        </trillSite>

Elements

Element

Description

Value Range

Mandatory/Optional

mtId

Specifies a multi-topology ID.

The value is an integer.

Mandatory

vlan

Specifies a multicast VLAN.

The value is an integer.

Optional

rootNickname

Specifies a multicast root nickname.

The value is an integer.

Mandatory

hopCount

Specifies the number of hops.

The value is an integer.

Optional

groupIp

Specifies a multicast IP address.

The value is a string.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?>       
       <trillSite>
          <instanceId>0</instanceId>
          <trillSiteMTs>
            <trillSiteMT>
              <mtId>0</mtId>
              <trillMRouteInfos>
                <trillMRouteInfo>
                  <vlan>19</vlan>
                  <rootNickname>10</rootNickname>
                  <hopCount>2</hopCount>
                </trillMRouteInfo>
              </trillMRouteInfos>
            </trillSiteMT>
          </trillSiteMTs>
        </trillSite>  

Elements

Element

Description

Value Range

Mandatory/Optional

mtId

Specifies a multi-topology ID.

The value is an integer.

Mandatory

vlan

Specifies a multicast VLAN.

The value is an integer.

Optional

rootNickname

Specifies a multicast root nickname.

The value is an integer.

Mandatory

hopCount

Specifies the number of hops.

The value is an integer.

Optional

groupIp

Specifies a multicast IP address.

The value is a string.

Optional

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 Information About the Next Hop of a Pruned Route in a TRILL Multicast Group

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillSiteMTs/trillSiteMT/trillMRouteGroupInfos/trillMRouteGroupInfo/trillMRouteGroupOutIntInfos/trillMRouteGroupOutIntInfo

Query information about the next hop of a pruned route in a TRILL multicast group.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
        <trillSite>
            <instanceId>0</instanceId>
            <trillSiteMTs>
                <trillSiteMT>
                    <mtId>0</mtId>
                    <trillMRouteGroupInfos>
                        <trillMRouteGroupInfo>
                            <vlan>19</vlan>
                            <groupIp>225.0.1.1</groupIp>
                            <rootNickname>10</rootNickname>
                            <trillMRouteGroupOutIntInfos>
                                <trillMRouteGroupOutIntInfo>
                                    <outInterface></outInterface>
                                    <outVlan></outVlan>
                                    <flag></flag>
                                </trillMRouteGroupOutIntInfo>
                            </trillMRouteGroupOutIntInfos>
                        </trillMRouteGroupInfo>
                    </trillMRouteGroupInfos>
                </trillSiteMT>
            </trillSiteMTs>
        </trillSite>

Elements

Element

Description

Value Range

Mandatory/Optional

mtId

Specifies a multi-topology ID.

The value is an integer.

Mandatory

vlan

Specifies a multicast VLAN.

The value is an integer.

Optional

rootNickname

Specifies a multicast root nickname.

The value is an integer.

Optional

groupIp

Specifies a multicast IP address.

The value is an integer.

Optional

outInterface

Specifies an outbound interface.

The value is an integer.

Optional

outVlan

Specifies an outer VLAN ID.

The value is an integer.

Optional

flag

Specifies a route flag.

The value is a string.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?>     
       <trillSite>
            <instanceId>0</instanceId>
            <trillSiteMTs>
                <trillSiteMT>
                    <mtId>0</mtId>
                    <trillMRouteGroupInfos>
                        <trillMRouteGroupInfo>
                            <vlan>19</vlan>
                            <groupIp>225.0.1.1</groupIp>
                            <rootNickname>10</rootNickname>
                            <trillMRouteGroupOutIntInfos>
                                <trillMRouteGroupOutIntInfo>
                                    <outInterface>Eth3/0/0</outInterface>
                                     <outVlan>100</outVlan>
                                      <flag>-/-/T/D</flag>
                                </trillMRouteGroupOutIntInfo>
                            </trillMRouteGroupOutIntInfos>
                        </trillMRouteGroupInfo>
                    </trillMRouteGroupInfos>
                </trillSiteMT>
            </trillSiteMTs>
        </trillSite>

Elements

Element

Description

Value Range

Mandatory/Optional

mtId

Specifies a multi-topology ID.

The value is an integer.

Mandatory

vlan

Specifies a multicast VLAN.

The value is an integer.

Optional

rootNickname

Specifies a multicast root nickname.

The value is an integer.

Optional

outInterface

Specifies an outbound interface.

The value is an integer.

Optional

outVlan

Specifies an outer VLAN ID.

The value is an integer.

Optional

flag

Specifies a route flag.

The value is an integer.

Optional

age

Specifies a route time.

The value is a string.

Optional

nexpSystemId

Specifies the system ID of the next hop.

The value is a string.

Optional

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 TRILL Multicast RPF Check Information

Operation

URI

Description

GET

/trill/trillSites/trillSite/trillSiteMTs/trillSiteMT/trillRpfCheckInfos/trillRpfCheckInfo

Query TRILL multicast RPF check information.

  • Request example
<?xml version="1.0" encoding="UTF-8"?>
        <trillSite>
            <instanceId>0</instanceId>
            <trillSiteMTs>
                <trillSiteMT>
                    <mtId>0</mtId>
                    <trillRpfCheckInfos>
                        <trillRpfCheckInfo>
                            <ingressNickname></ingressNickname>
                            <treeNickname></treeNickname>
                            <interfaceName></interfaceName>
                            <neighborMac></neighborMac>
                            <outVlan></outVlan>
                        </trillRpfCheckInfo>
                    </trillRpfCheckInfos>
                </trillSiteMT>
            </trillSiteMTs>
        </trillSite>

Elements

Element

Description

Value Range

Mandatory/Optional

mtId

Specifies a multi-topology ID.

The value is an integer.

Mandatory

ingressNickname

Specifies an ingress nickname.

The value is an integer.

Mandatory

treeNickname

Specifies a multicast root nickname.

The value is an integer.

Mandatory

interfaceName

Specifies an interface name.

The value is a string.

Optional

neighborMac

Specifies the MAC address of a neighbor.

The value is a string.

Optional

outVlan

Specifies an outer VLAN ID.

The value is an integer.

Optional

  • Response example (XML format)
<?xml version="1.0" encoding="UTF-8"?>     
       <trillSite>
          <instanceId>0</instanceId>
          <trillSiteMTs>
            <trillSiteMT>
              <mtId>0</mtId>
              <trillRpfCheckInfos>
                <trillRpfCheckInfo>
                  <ingressNickname>10</ingressNickname>
                  <treeNickname>10</treeNickname>
                  <interfaceName>Eth3/0/0</interfaceName>
                  <neighborMac>380e-a811-1200</neighborMac>
                  <outVlan>100</outVlan>
                </trillRpfCheckInfo>
              </trillRpfCheckInfos>
            </trillSiteMT>
          </trillSiteMTs>
        </trillSite> 

Elements

Element

Description

Value Range

Mandatory/Optional

mtId

Specifies a multi-topology ID.

The value is an integer.

Mandatory

ingressNickname

Specifies an ingress nickname.

The value is an integer.

Mandatory

treeNickname

Specifies a multicast root nickname.

The value is an integer.

Mandatory

interfaceName

Specifies an interface name.

The value is a string.

Optional

neighborMac

Specifies the MAC address of a neighbor.

The value is a string.

Optional

outVlan

Specifies an outer VLAN ID.

The value is an integer.

Optional

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

Downloads: 16

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