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


To have a better experience, please upgrade your IE browser.

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


The Open ProgramActivate a License File (OPS) provides application programming interfaces (APIs) based on the Representational State Transfer (REST) standards. REST defines a series of architecture principles, which provides a basis for system-resource-based Web services. The client can develop programs using any programming language that supports HTTP.

The OPS provides management objects for users to manage the device. The management objects are identified using the Uniform Resource Identifier (URI). For example, /system/systemInfo is used to identify the system information object.

You can use a standard HTTP method (Get, Put, Post, or Delete) to access managed objects.

The OPS uses the Get, Create, Set, and Delete methods to perform secondary encapsulation on standard HTTP methods. Table 1-1 lists the mappings between the OPS methods and HTTP methods.

Table 1-1  The operations standard HTTP and OPS supported

HTTP Operation

OPS Operation




A query operation. Users can query management objects using the GET operation.



A modify operation. Users can modify management objects using the PUT operation.



A create operation. Users can create management objects using the POST operation.



A delete operation. Users can delete management objects using the DELETE operation.

Currently the API uses the XML format to transmit data. In a later version, the API can use the JavaScript Object Notation (JSON) format to transmit data.

Currently the API can be used only in the Embedded Running Environment (ERE).


This document uses the HTTP methods as examples to describe how they are applied to services. If you want to use an OPS method, change the corresponding HTTP method to the OPS method according to the mappings listed in Table 1-1.

Updated: 2019-05-05

Document ID: EDOC1100004147

Views: 59943

Downloads: 28

Average rating:
This Document Applies to these Products

Related Version

Related Documents

Previous Next