配置管理接口

接口功能

查询配置文件变更信息。

URI路径

/rest/openapi/configfile/configchange

访问方法

GET

请求示例

GET https://10.120.70.220:32102/rest/openapi/configfile/configchange?changeTime=123456789&pageSize=20&pageNo=1
Headers: key = openid，value = d21ee8aae2f9c05b2098e82a33b3430b37e1c6980d26004f

参数说明

返回结果

data包含以下字段：

configChangeInfo包含以下字段：

响应示例

{
    "code": 0, 
    "data": {
        "configChangeInfo": [
            {
                "neDn": "NE=34622313", 
                "changeTime": 1479450011876, 
                "oldFile": "20161118141713R.cfg", 
                "newFile": "20161118141953R.cfg", 
                "fileType": "r", 
                "added": "ap-group name employee", 
                "modified": null, 
                "baseModified": null, 
                "deleted": null, 
                "addNum": 1, 
                "modifyNum": 0, 
                "deleteNum": 0
            }
        ], 
        "curPage": 1, 
        "totalPage": 1
    }, 
    "description": ""
}

注意事项

无。

使用示例

package com.huawei.oms.ros.test;

import org.apache.http.HttpResponse;
import org.apache.http.message.BasicNameValuePair;

public class QueryConfigChange {
    private static final String CONFIGCHANGEPATH = "/rest/openapi/configfile/configchange";
    
    public static void main(String[] args) throws Exception {
        Login.login();
        queryConfigChange();
    }
    
    public static void queryConfigChange() throws Exception 
    {
        //set the URL and method
        String openidURL = CONFIGCHANGEPATH;
        String method = "GET";
        
        //set headers
        BasicNameValuePair[] headers = NewRosSecurity.getRosHttpHeader(openidURL, method);
        //set parameters
        BasicNameValuePair[] parameters =
        {
                new BasicNameValuePair("changeTime", "123456789"),
                new BasicNameValuePair("pageSize", "20"),
                new BasicNameValuePair("pageNo", "1"),
        };
        
        HttpResponse response = NewHttpsAccess.access(GlobalVar.GLOBAL_IP, GlobalVar.GLOBAL_PORT, openidURL, method, 
                headers, parameters);
        
        String body = NewHttpsAccess.getResult(response);
        System.out.println(body);
    }
}

执行结果如下：

{
"code": 0,
"data": {
"configChangeInfo": [
{
"neDn": "NE=34622313",
"changeTime": 1479450011876,
"oldFile": "20161118141713R.cfg",
"newFile": "20161118141953R.cfg",
"fileType": "r",
"added": "ap-group name employee\n",
"modified": null,
"baseModified": null,
"deleted": null,
"addNum": 1,
"modifyNum": 0,
"deleteNum": 0
}],
"curPage": 1,
"totalPage": 1
},
"description": ""
}

接口功能

查询SSID模板和VAP模板信息。

URI路径

/rest/openapi/sct/ssid

访问方法

GET

请求示例

GET https://10.120.70.220:32102/rest/openapi/sct/ssid?nedn=NE=34603109&profileType=ssid&profileName=whtest002
Headers: key = openid，value = d21ee8aae2f9c05b2098e82a33b3430b37e1c6980d26004f

参数说明

返回结果

ProfileInfo包含以下字段：

VapProfileInfo包含以下字段：

SsidProfileInfo包含以下字段：

响应示例

{
"code":0,
"data":"{
	"nedn":"NE=34603809",
	"profileType":"ssid",
	"vapProfileList":null,
        "ssidProfileList":[
        {
	    "ssidProfileName":"whtest002",
            "ssidName":"HUAWEI-WLAN"
        }
        ]
    }",
"description":"query ssid profile success "
}

注意事项

1. 查询接口只适用于AC设备V2R8C10及以后版本。

使用示例1：查询SSID模板

package com.huawei.oms.ros.test;

import org.apache.http.HttpResponse;
import org.apache.http.message.BasicNameValuePair;

public class QuerySsidProfile {
    private static final String SSIDPROFILEPATH= "/rest/openapi/sct/ssid";
    
    public static void main(String[] args) throws Exception {
        Login.login();
       querySsidProfile();
    }
    
    public static void querySsidProfile() throws  Exception{  
 
        String openidURL = "/rest/openapi/sct/ssid";   
        String method = "GET";   
        JSONObject model = new JSONObject(); 
        model.put("nedn", "NE=34603809");  
        model.put("profileType", "ssid");  
        model.put("profileName", "whtest002"); 

        BasicNameValuePair[] parameters = convertJsonObj(model);  
       // set headers   
       BasicNameValuePair[] headers = NewRosSecurity.getRosHttpHeader(openidURL, method);  
       HttpResponse response = NewHttpsAccess.access(GlobalVar.GLOBAL_IP, GlobalVar.GLOBAL_PORT, openidURL, method, headers, parameters);  
      // get the result   
       String body = NewHttpsAccess.getResult(response);  
       System.out.println(body);
    }

}

{
"code":0,
"data":"{
	"nedn":"NE=34603809",
	"profileType":"ssid",
	"vapProfileList":null,
        "ssidProfileList":[
        {
	    "ssidProfileName":"whtest002",
            "ssidName":"HUAWEI-WLAN"
        }
        ]
    }",
"description":"query ssid profile success "
}

使用示例2：查询VAP模板

package com.huawei.oms.ros.test;

import org.apache.http.HttpResponse;
import org.apache.http.message.BasicNameValuePair;

public class QuerySsidProfile {
    private static final String SSIDPROFILEPATH= "/rest/openapi/sct/ssid";
    
    public static void main(String[] args) throws Exception {
        Login.login();
       querySsidProfile();
    }
    
    public static void querySsidProfile() throws  Exception{  
 
        String openidURL = "/rest/openapi/sct/ssid";   
        String method = "GET";   
        JSONObject model = new JSONObject(); 
        model.put("nedn", "NE=34603809");  
        model.put("profileType", "vap");  
        model.put("profileName", "whtest002"); 

        BasicNameValuePair[] parameters = convertJsonObj(model);  
       // set headers   
       BasicNameValuePair[] headers = NewRosSecurity.getRosHttpHeader(openidURL, method);  
       HttpResponse response = NewHttpsAccess.access(GlobalVar.GLOBAL_IP, GlobalVar.GLOBAL_PORT, openidURL, method, headers, parameters);  
      // get the result   
       String body = NewHttpsAccess.getResult(response);  
       System.out.println(body);
    }

}

执行结果如下：

{
"code":0,
"data":"{
	"nedn":"NE=34603809",
	"profileType":"vap",
	"vapProfileList":[
        {
            "vapProfileName":"whtest002",
            "referedSsidProfileName":"whtest002",
            "referedSsidName":"HUAWEI-WLAN"
        }]
        "ssidProfileList":null
    }",
"description":"query ssid profile success "
}

接口功能

创建SSID和VAP模板。

URI路径

/rest/openapi/sct/ssid

访问方法

POST

请求示例

POST https://10.120.70.220:32102/rest/openapi/sct/ssid?nedn=NE=34603109&ssidProfileName=default&vapProfileName=default$apMacList=22-22-22-22-22-22,22-22-22-22-22-23&apGroupList=eSight,eSight001&wlanId=2&radioId=1
Headers: key = openid，value = d21ee8aae2f9c05b2098e82a33b3430b37e1c6980d26004f

参数说明

返回结果

响应示例

{
"code":0,
"data":null,
"description":"deploy success"
}

注意事项

无。

使用示例

package com.huawei.oms.ros.test;

import org.apache.http.HttpResponse;
import org.apache.http.message.BasicNameValuePair;

public class DeploySsidProfile {
    private static final String SSIDPROFILEPATH= "/rest/openapi/sct/ssid";
    
    public static void main(String[] args) throws Exception {
        Login.login();
       deploySsidProfile();
    }
   
    public static void deploySsidProfile() throws  Exception {  
        String openidURL = "/rest/openapi/sct/ssid";   
        String method = "POST";   
        JSONObject model = new JSONObject();   
        model.put("nedn", "NE=34603809");  
        model.put("ssidProfileName", "whtest002");  
        model.put("vapProfileName", "whtest002");  
        BasicNameValuePair[] parameters = convertJsonObj(model);  
      
        // set headers   
        BasicNameValuePair[] headers = NewRosSecurity.getRosHttpHeader(openidURL, method);  
        HttpResponse response = NewHttpsAccess.access(GlobalVar.GLOBAL_IP,GlobalVar.GLOBAL_PORT, openidURL, method, headers, parameters);   
        // get the result  
        String body = NewHttpsAccess.getResult(response);   
        System.out.println(body);
    }

}

执行结果如下：

{
"code":0,
"data":null,
"description":"deploy success"
}