概述

本章节详细的描述了ICS-Manager RESTful接口的相关说明。指导用户通过调用RESTful接口实现对MEF功能的使用。

每个HTTPS操作都以UTF-8编码的JSON的形式，提交或返回一个资源。就像Web应用程序向浏览器返回HTML一样，RESTful接口会通过同样的传输机制（HTTPS），以JSON的形式向客户端返回数据，本文档中通过JSON格式传入的参数名区分大小写。

ICS-Manager有连接数限制策略。当某一时间点，同一客户端的连接数或全局连接数超过阈值，会触发连接限制。连接限制触发时，服务端会拒绝请求，并向客户端返回相应的状态码，具体状态码含义请参见表1。API调用方需合理规划请求频率。

调用接口时，需要输入具体接口的URL。URL都需要传入以下参数，其他的URL参数请参见每个接口的URL参数说明。

表2 URL参数
参数名	是否必选	参数说明	取值要求
ip	必选	登录设备的IP地址。	IPv4地址。
port	必选	调用具体模块接口的端口号。	-

本文档涉及到的请求头参数说明如下。

表3 请求头
参数名	是否必选	参数说明	取值要求
Content-Type	必选	媒体类型。	字符串，取值为“application/json”，在请求头中携带。

父主题： API接口