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

OPS

Create/Delete a Channel That Executes Commands

Operation

URI

Description

PUT

/cli/cliTerminal

Create/delete a channel that executes commands.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?>
    <cli>
    <cliTerminal>
    <channelId>13180</channelId>
    <opType>2</opType>
    <idle>10</idle>
    <extendAAAAttr>43850</extendAAAAttr>
    </cliTerminal>
    </cli>

    Table 3-295 describes elements in a request.

    Table 3-295  Elements

    Element

    Description

    channelId

    Specifies a channel ID.

    opType

    • 1. Closes a channel.
    • 2: Creates a channel.

    idle

    Specifies an idle-cut timeout period.

    extendAAAAttr

    Specifies the ID of a session that the AAA server allocates.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?>
    <ok/>
  • Table 3-296 describes status codes in a response.
    Table 3-296  Description of status codes in a response

    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 Command Execution Result

Operation

URI

Description

GET

/cli/cliTermResult

Query the command execution result.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <cliTermResult> 
    <status/> 
    <result/> 
    <output/> 
    </cliTermResult>

    Table 1 describes elements in requests.

Table 3-297  Elements in requests

Element

Description

status

Specifies the command execution status.

  • processing: The command is being executed.
  • finished: The command execution is complete.

result

Specifies the command execution result.

output

Specifies the command execution output.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <cli> 
    <cliTermResult> 
    <status>finished</status> 
    <result>0</result> 
    <output></output> 
    </cliTermResult> 
    </cli>

Table 2 describes status codes in responses.

Table 3-298  Description of status codes in responses

Status Code

Description

200 OK

The operation succeeds.

400 Bad Request

The request cannot be implemented because the request is incorrect in syntax or the information attribute in the request is incorrect.

500 Internal Server Error

Internal errors in services cause a request failure or an unidentified request.

Execute a CLI Command

Operation

URI

Description

PUT

/cli/cliTermExecute

Execute a CLI command.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <cli> 
    <cliTermExecute> 
    <channelId>13180</channelId> 
    <command>reboot</command> 
    <prompt1>Warning: Current configuration will be saved to the next startup saved-configuration file! Continue? [Y/N]:</prompt1> 
    <answer1>n</answer1> 
    <prompt2>System will reboot! Continue? [Y/N]:</prompt2> 
    <answer2>y</answer2> 
    </cliTermExecute> 
    </cli>

    Table 3-299 describes elements in requests.

Table 3-299  Elements in requests

Element

Description

channelId

Specifies the channel ID of the command to be executed.

command

Specifies the command to be executed.

prompt1

Specifies the string of a read interaction prompt for command execution.

answer1

Specifies the automatically responded string when prompt 1 is read.

prompt2

Specifies the string of a read interaction prompt for command execution.

answer2

Specifies the automatically responded string when prompt 2 is read.

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

Table 3-300 describes status codes in responses.

Table 3-300  Description of status codes in responses

Status Code

Description

200 OK

The operation succeeds.

400 Bad Request

The request cannot be implemented because the request is incorrect in syntax or the information attribute in the request is incorrect.

500 Internal Server Error

Internal errors in services cause a request failure or an unidentified request.

Translation
Download
Updated: 2019-03-21

Document ID: EDOC1000166567

Views: 17705

Downloads: 116

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