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).
Proactive Registration

Proactive Registration

1.3.1 Create a Node That Proactively Registers

Operation

URI

Description

POST

/sshs/callHomes/callHome

Create a node that proactively registers.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <callHomes> 
        <callHomeName>callHomeName</callHomeName>
    </callHomes>

    Table 3-213 describes elements in requests.

    Table 3-213  Elements

    Element

    Description

    callHomeName

    Specifies the name of a host that proactively registers. The value is a string of 1 to 19 case-sensitive characters, spaces not supported. The string can contain spaces if it is enclosed in double quotation marks ("). This element is mandatory.

  • Response example (XML format)
    <?xml version="1.0" encoding="UTF-8"?> 
    <ok/>
    Table 4-53 describes status codes in responses.

    Table 3-214 describes elements in responses.

    Table 3-214  Status codes in responses

    Status Code

    Description

    200 OK

    The operation succeeded.

    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.

1.3.4 Query a Node That Proactively Registers

Operation

URI

Description

GET

/sshs/callHomes/callHome

Query a node that proactively registers.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <callHomes> 
        <callHomeName></callHomeName> 
    </callHomes>

    Table 3-215 describes elements in requests.

    Table 3-215  Elements

    Element

    Description

    callHomeName

    Specifies the name of a host that proactively registers. The value is a string of 1 to 19 case-sensitive characters, spaces not supported. The string can contain spaces if it is enclosed in double quotation marks ("). This element is mandatory.

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

Table 3-216 describes status codes in responses.

Table 3-216  Status codes in responses

Status Code

Description

200 OK

The operation succeeded.

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.

1.3.2 Modify a Node That Proactively Registers

Operation

URI

Description

PUT

/sshs/callHomes/callHome

Modify a node that proactively registers.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <callHomes> 
        <callHomeName>callHomeName</callHomeName> 
    </callHomes>

    Table 3-217 describes elements in requests.

    Table 3-217  Elements

    Element

    Description

    callHomeName

    Specifies the name of a host that proactively registers. The value is a string of 1 to 19 case-sensitive characters, spaces not supported. The string can contain spaces if it is enclosed in double quotation marks ("). This element is mandatory.

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

      Table 3-218 describes status codes in responses.

      Table 3-218  Status codes in responses

      Status Code

      Description

      200 OK

      The operation succeeded.

      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.

1.3.3 Delete a Node That Proactively Registers

Operation

URI

Description

DELETE

/sshs/callHomes/callHome

Delete a node that proactively registers.

  • Request example
    <?xml version="1.0" encoding="UTF-8"?> 
    <callHomes> 
        <callHomeName>callHomeName</callHomeName> 
    </callHomes>

    Table 3-219 describes elements in requests.

    Table 3-219  Elements

    Element

    Description

    callHomeName

    Specifies the name of a host that proactively registers. The value is a string of 1 to 19 case-sensitive characters, spaces not supported. The string can contain spaces if it is enclosed in double quotation marks ("). This element is mandatory.

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

    Table 3-220 describes status codes in responses.

    Table 3-220  Status codes in responses

    Status Code

    Description

    200 OK

    The operation succeeded.

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

Downloads: 127

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