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 V200R003C00

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).
DHCP Relay

DHCP Relay

Create DHCP Relay Configuration

Create DHCP Relay Configuration

Operation

URI

Description

PUT

/dhcp/relay/dhcpRelayIfCfgs/dhcpRelayIfCfg

Create a DHCP relay interface configuration.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?> 
        <dhcpRelayIfCfg operation="create"> 
            <interfaceName>Eth-Trunk1</interfaceName>   
            <isEnable>true</isEnable>        
            <isGateWayEnable>true</isGateWayEnable>     
        </dhcpRelayIfCfg>

    Table 3-295 describes elements in requests.

    Table 3-295  Elements

    Element

    Description

    interfaceName

    Specifies an interface name.

    isEnable

    Specifies whether to enable DHCP relay.

    isGateWayEnable

    Specifies whether to enable DHCP relay gateway switching.

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

    Table 3-296 describes status codes in responses.

    Table 3-296  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.

Create DHCP Relay Server Group

Operation

URI

Description

POST

/dhcp/relay/dhcpRelayServerGroups/dhcpRelayServerGroup

Create a DHCP relay server group.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?>    
       <dhcpRelayServerGroup operation="create">
          <serverGroupName>testgroup</serverGroupName> 
          <gateway>192.168.1.1</gateway> 
          <isUndoGateway>false</isUndoGateway>    
       </dhcpRelayServerGroup>

    Table 3-297 describes elements in requests.

    Table 3-297  Elements

    Element

    Description

    serverGroupName

    Specifies the name of a DHCP server group.

    gateway

    Specifies a gateway address.

    isUndoGateway

    Specifies whether to delete the gateway address configuration.

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

    Table 3-298 describes status codes in responses.

    Table 3-298  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 DHCP Relay Configurations

Query DHCP Relay Interface Configurations

Operation

URI

Description

GET

/dhcp/relay/dhcpRelayIfCfgs/dhcpRelayIfCfg

Query DHCP relay interface configurations.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?>  
       <dhcpRelayIfCfg>       
          <interfaceName></interfaceName>   
          <isEnable></isEnable>     
          <isGateWayEnable></isGateWayEnable> 
       </dhcpRelayIfCfg>

    Table 3-299 describes elements in requests.

    Table 3-299  Elements

    Element

    Description

    interfaceName

    Specifies an interface name.

    isEnable

    Specifies whether to enable DHCP relay.

    isGateWayEnable

    Specifies whether to enable DHCP relay gateway switching.

  • Response example (XML format)
    <?xml version='1.0' encoding='UTF-8'?>    
       <dhcpRelayIfCfg>         
          <interfaceName>Eth-Trunk1</interfaceName>
          <isEnable>true</isEnable>  
          <isGateWayEnable>true</isGateWayEnable>   
       </dhcpRelayIfCfg>

    Table 3-300 describes elements in requests.

    Table 3-300  Elements

    Element

    Description

    interfaceName

    Specifies an interface name.

    isEnable

    Specifies whether to enable DHCP relay.

    isGateWayEnable

    Specifies whether to enable DHCP relay gateway switching.

    Table 3-301 describes status codes in responses.

    Table 3-301  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 DHCP Relay Server Group

Operation

URI

Description

GET

/dhcp/relay/dhcpRelayServerGroups/dhcpRelayServerGroup

Query information about a DHCP relay server group.

Operation

URI

Description

GET

/dhcp/relay/dhcpRelayServerGroups/dhcpRelayServerGroup

Query information about a DHCP relay server group.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?> 
       <dhcpRelayServerGroup> 
          <serverGroupName></serverGroupName>
          <gateway></gateway>    
          <isUndoGateway></isUndoGateway> 
       </dhcpRelayServerGroup>

    Table 3-302 describes elements in requests.

    Table 3-302  Elements

    Element

    Description

    serverGroupName

    Specifies the name of a DHCP server group.

    gateway

    Specifies a gateway address.

    isUndoGateway

    Specifies whether to delete the gateway address configuration.

  • Response example (XML format)
    <?xml version='1.0' encoding='UTF-8'?>     
       <dhcpRelayServerGroup>    
          <serverGroupName>testgroup</serverGroupName> 
          <gateway>192.168.1.1</gateway> 
          <isUndoGateway>false</isUndoGateway>       
       </dhcpRelayServerGroup>

    Table 3-303 describes elements in requests.

    Table 3-303  Elements

    Element

    Description

    serverGroupName

    Specifies the name of a DHCP server group.

    gateway

    Specifies a gateway address.

    isUndoGateway

    Specifies whether to delete the gateway address configuration.

    Table 3-304 describes status codes in responses.

    Table 3-304  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 DHCP Relay Configurations

Delete DHCP Relay Interface Configurations

Operation

URI

Description

DELETE

/dhcp/relay/dhcpRelayIfCfgs/dhcpRelayIfCfg

Delete DHCP relay interface configurations.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?>
       <dhcpRelayIfCfg operation="delete">           
          <interfaceName>Eth-Trunk1</interfaceName>           
          <isEnable>true</isEnable>           
          <isGateWayEnable>true</isGateWayEnable>
       </dhcpRelayIfCfg>

    Table 3-305 describes elements in requests.

    Table 3-305  Elements

    Element

    Description

    interfaceName

    Specifies an interface name.

    isEnable

    Specifies whether to enable DHCP relay.

    isGateWayEnable

    Specifies whether to enable DHCP relay gateway switching.

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

    Table 3-306 describes status codes in responses.

    Table 3-306  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 DHCP Relay Server Group

Operation

URI

Description

DELETE

/dhcp/relay/dhcpRelayServerGroups/dhcpRelayServerGroup

Delete a DHCP relay server group.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?>  
       <dhcpRelayServerGroup operation="delete">           
          <serverGroupName>testgroup</serverGroupName>           
          <gateway>192.168.1.1</gateway>           
          <isUndoGateway>false</isUndoGateway>       
       </dhcpRelayServerGroup>

    Table 3-307 describes elements in requests.

    Table 3-307  Elements

    Element

    Description

    serverGroupName

    Specifies the name of a DHCP server group.

    gateway

    Specifies a gateway address.

    isUndoGateway

    Specifies whether to delete the gateway address configuration.

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

    Table 3-308 describes status codes in responses.

    Table 3-308  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 DHCP Relay Configurations

Modify DHCP Relay Interface Configurations

Operation

URI

Description

PUT↵

/dhcp/relay/dhcpRelayIfCfgs/dhcpRelayIfCfg↵

Modify DHCP relay interface configurations.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?>      
       <dhcpRelayIfCfg operation="merge">     
          <interfaceName>Eth-Trunk1</interfaceName>        
          <isEnable>true</isEnable>    
          <isGateWayEnable>false</isGateWayEnable> 
       </dhcpRelayIfCfg>

    Table 3-309 describes elements in requests.

    Table 3-309  Elements

    Element

    Description

    interfaceName

    Specifies an interface name.

    isEnable

    Specifies whether to enable DHCP relay.

    isGateWayEnable

    Specifies whether to enable DHCP relay gateway switching.

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

    Table 3-310 describes status codes in responses.

    Table 3-310  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 DHCP Relay Server Group

Operation

URI

Description

PUT

/dhcp/relay/dhcpRelayServerGroups/dhcpRelayServerGroup

Modify a DHCP relay server group.

Operation

URI

Description

PUT

/dhcp/relay/dhcpRelayServerGroups/dhcpRelayServerGroup

Modify a DHCP relay server group.

  • Request example
    <?xml version='1.0' encoding='UTF-8'?>  
       <dhcpRelayServerGroup operation="merge"> 
          <serverGroupName>testgroup</serverGroupName>   
          <gateway>192.168.1.2</gateway>  
          <isUndoGateway>false</isUndoGateway> 
       </dhcpRelayServerGroup>

    Table 3-311 describes elements in requests.

    Table 3-311  Elements

    Element

    Description

    serverGroupName

    Specifies the name of a DHCP server group.

    gateway

    Specifies a gateway address.

    isUndoGateway

    Specifies whether to delete the gateway address configuration.

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

    Table 3-312 describes status codes in responses.

    Table 3-312  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-05-05

Document ID: EDOC1100004147

Views: 60685

Downloads: 28

Average rating:
This Document Applies to these Products

Related Version

Related Documents

Share
Previous Next