系统下电消息通知

接口功能

根据第三方系统 ID、第三方系统消息接收接口凭证 openID、第三方系统消息接收接口 URL 和订阅操作描述，订阅系统下电消息通知。

URI路径

/rest/openapi/notification/common/systemStatus

访问方法

PUT

参数说明

返回结果

注意事项

订阅成功后，在 eSight 正常下电情况下，eSight 尽可能努力发送下电消息。eSight 断电等异常下电情况则不保证发送该消息。

调用示例

使用示例

package com.huawei.nms.openapi.demo.notification;

import java.util.ArrayList;
import java.util.List;

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

import com.huawei.nms.openapi.demo.global.GlobalVar;
import com.huawei.nms.openapi.demo.global.NewHttpsAccess;
import com.huawei.nms.openapi.demo.sm.Login;

public class PutSystemStatusTest {

  public static void main(String[] args) throws Exception {
    Login.login();
    put();
  }

  public static void put() throws Exception {
        //set the URL and method
        final String openidURL = "/rest/openapi/notification/common/systemStatus";
        final String method = "PUT";
        
        List<BasicNameValuePair> headers = new ArrayList<BasicNameValuePair>();
        headers.add(new BasicNameValuePair("openid",GlobalVar.globalOpenid));

        //set parameters
        final List<BasicNameValuePair> bodys = new ArrayList<BasicNameValuePair>();
        bodys.add(new BasicNameValuePair("systemID","NMSinfo1"));
        bodys.add(new BasicNameValuePair("openID","127.0.0.1"));
        bodys.add(new BasicNameValuePair("url","http://127.0.0.2:8080/device"));
        bodys.add(new BasicNameValuePair("dataType","JSON"));
        bodys.add(new BasicNameValuePair("desc",""));
        
        //send the request
        final HttpResponse response = NewHttpsAccess.access(GlobalVar.GLOBAL_IP,
                GlobalVar.GLOBAL_PORT,
                openidURL,
                method,
                headers,
                bodys);

        //get the result
        final String ret = NewHttpsAccess.getResult(response);
        System.out.println(ret);
 }
}

执行结果如下：

{
    "code": 0, 
    "data": null, 
    "description": "Operation success."
}

接口功能

根据第三方系统 ID退订操作描述，退订系统下电消息通知。

URI路径

/rest/openapi/notification/common/systemStatus

访问方法

DELETE

参数说明

返回结果

注意事项

MIME type 为 application/x-www-form-urlencoded 的请求中，空格将会编码为加号，加号则编码为%2B。

调用示例

使用示例

package com.huawei.nms.openapi.demo.notification;

import java.util.ArrayList;
import java.util.List;

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

import com.huawei.nms.openapi.demo.global.GlobalVar;
import com.huawei.nms.openapi.demo.global.NewHttpsAccess;
import com.huawei.nms.openapi.demo.sm.Login;

public class DeleteSystemStatusTest {

  public static void main(String[] args) throws Exception {
     Login.login();
     delete();
}

  public static void delete() throws Exception {
        //set the URL and method
        final String openidURL = "/rest/openapi/notification/common/systemStatus";
        final String method = "DELETE";
        
        List<BasicNameValuePair> headers = new ArrayList<BasicNameValuePair>();
        headers.add(new BasicNameValuePair("openid",GlobalVar.globalOpenid));

        //set parameters
        final List<BasicNameValuePair> parameters = new ArrayList<BasicNameValuePair>();
        parameters.add(new BasicNameValuePair("systemID","NMSinfo1"));
        parameters.add(new BasicNameValuePair("desc",""));
        
        //send the request
        final HttpResponse response = NewHttpsAccess.access(GlobalVar.GLOBAL_IP,
                GlobalVar.GLOBAL_PORT,
                openidURL,
                method,
                headers,
                parameters);

        //get the result
        final String ret = NewHttpsAccess.getResult(response);
        System.out.println(ret);
 }
}

执行结果如下：

{
    "code": 0, 
    "data": null, 
    "description": "Operation success."
}

消息数据

eSight具有关闭功能时的超时保护机制，全组件安装时，可能因该保护机制而无法及时发送系统下电消息。第三方系统可以通过系统保活消息和上电消息来判断 eSight 的在线状态。

data 数据结构：

解密示例

private static String decrypt(String data){
  String result = "";

  // 注：以下两个密钥串参考etc/oms.ros/ros.web.notification.xml自行添加，需要明文。
  String decryptedKey = "E5DF96DE53ED56CBAE25368624DC25Ef";
  String decryptedIv = "E2CDBCA5693654EF2E6F38693653564E";
  // 获取结果，KEY和IV值
  final byte[] key = strToBytes( decryptedKey.toUpperCase() );
  final byte[] iv = strToBytes( decryptedIv.toUpperCase() );
  try {
   // 获取key生成器
   KeyGenerator kgen = KeyGenerator.getInstance("AES", "SunJCE");

   SecureRandom secureRandom = SecureRandom.getInstance("SHA1PRNG", "SUN");
   secureRandom.setSeed( key );
   // 初始化
   kgen.init( 128, secureRandom );
   // 算法参数
   AlgorithmParameterSpec paramSpec = new IvParameterSpec(iv);
   // 生成加密key
   SecretKey secretKey = kgen.generateKey();
   // 加密器
   Cipher cipher = Cipher.getInstance("AES/CBC/PKCS5Padding", "SunJCE");
   // 初始化加密器
   cipher.init( Cipher.DECRYPT_MODE, secretKey, paramSpec);
   // 获取解密结果
   byte[] res = cipher.doFinal(strToBytes(data));
   try {
    result = new String( res,"UTF-8" );
   } catch (UnsupportedEncodingException e) {
    // TODO Auto-generated catch block
    e.printStackTrace();
   }
  } catch( final GeneralSecurityException e ) {
   e.printStackTrace();
   result = null;
  }
  return result;
 }

 public static byte[] strToBytes(final String str)
    {
        // 参数校验
        if (null == str || str.isEmpty() || !str.matches("[0-9a-zA-Z]{1,}"))
        {
            return null;
        }

        // 转换成大写
        final String upperCaseString = str.toUpperCase(Locale.US);

        // 字符串长度
        final int strLen = upperCaseString.length();

        // 被加密数组
        final byte[] bytes = new byte[16];

        // 循环计算加密值
        for (int i = 0; i < (strLen / 2); i++)
        {
            // 高低位
            int high = charToHex(upperCaseString.charAt(i * 2));
            int low = charToHex(upperCaseString.charAt(i * 2 + 1));
            // 获得结果
            bytes[i] = (byte) ((high << 4) | low);
        }

        return bytes;
    }

通知示例

{
    "timestamp":"2014-12-19 11:11:27",
    "extendedData":{},
    "resourceURI":"/rest/openapi/notification/common/systemStatus",
    "description":"System shutdown.",
    "data":
    [
        {
        "systemEscapedTime":"0 Day 00 Hour 02 Min 35 Sec 675 MilliSec            ",
        "vendor":"Huawei",
        "systemName":"HuaweiPlatform",
        "systemID":"HuaweiPlatform",
        "version":"V300R003C00"
        }
    ],
    "msgType":97
}