Cloud monitoring card dynamic ring and SNMP data, cloud card API
Last updated 2026-09-28
CLOUD cloud intelligent management card dynamic ring API interface
For the dynamic environmental system, the intelligent management card not only provides a Modbus interface (see “CLOUD – MODBUS Protocol.pdf”), but also offers two communication API interfaces in pure IP mode: Http and TCP/IP.
- Http mode setting:
Without any setup, the CLOUD intelligent management card provides communication functionality in HTTP mode. The CLOUD management card and the dynamic environment system can act as server and client for each other, exchanging data using the POST method.
- TCP/IP mode settings:
The CLOUD management card serves as the server.
Open a browser (such as IE) and enter the IP address of the management card in the address bar. (For instructions on how to set and obtain the IP address of the management card, please refer to the document “CLOUD – Setting IP Address”.).
Simply set the TCP port to 2390.
- TCP/IP should maintain a persistent connection mode.
Both of the above API interface modes (Http, TCP/IP) do not affect the remote control and management functions of the intelligent management card.
- Communication protocol:
a. Send instructions and data:
Send instructions and data to the CLOUD intelligent management card in standard JSON format.
For example: {
“session”:”1234″,
“pass”:”123456″,
“new_pass”:”AYI9 123456″,
“host”:”http://192.168.0.100:9000/post”,
“cmd”:”QAD”,
}
among which
(1) sessoin: It is the instruction sequence number, used to distinguish whether the returned result belongs to this instruction;
(2) pass: This is the password for the management card, and the initial password is empty. If the password is empty, this field is optional;
(3) new_pass: Sets a new password for the management card. If the field content is “clear”, it indicates that the password should be cleared. Otherwise, the field content cannot be empty.
(3) host: The target address for the returned result; if using TCP/IP, this field can be omitted;
(4) cmd: Send the command (in uppercase) to the CLOUD management card.
Including but not limited to the following instructions: RTD, QAD, SON, SOFF, BZON, BZOFF, T
b. Returned data format:
The returned data format is also in standard JSON format:
(1) For incorrect results or unexecutable instructions, the return format is:
{
“result”:”xxx”,
The original instruction, excluding the {} symbols
}
Or
{
“result”:”xxx”,
“uid”:”201701013805″,
“session”:”1234″,
“cmd”:”QAD”,
}
Where xxx represents the error code:
101 — JSON_FORMAT, JSON format error;
102 — SESSION_LOSS, no session field;
103 — PASSWORD_ERROR, password error;
104 — HOST_NO, no host field;
105 — COMMAND_NO, no command field;
106 — PASSTOOLENGTH, the password is too long, exceeding 15 characters.
201 — BUSY, the system is busy.
(2) The correct return format for the result:
{
“uid”:”201701013805″,
“session”:”1234″,
“cmd”:”QAD”,
“value”:”xxxxxxxxxxxxxxxxxxxxxxxxx”,
}Value return result: All return values start with a “(“.
(1) RTD command, querying the rated information of the UPS (power supply) device, return format:
(Factory name, Hardware version, Model, Rated input voltage, Rated output voltage, Rated current, Output frequency, Rated battery voltage, Input and output phase count, Rated power),
For example:
(Sunshine V1.0 C10KS 220 220 20 50.0 192 1/1 10000
The return format starts with a “(“, and each field is separated by a space. The unit for voltage is V, current is A, frequency is Hz, and power is VA. If a field has no value, it is replaced with —. There are a total of 10 fields.
(2) QAD command, querying real-time data of UPS (power supply) equipment, return format:
Input voltage (R, S, T), input frequency, input current (R, S, T), fault voltage, output voltage (R, S, T), output frequency, output current (R, S, T), load percentage (R, S, T), battery voltage, battery remaining time, battery capacity percentage, internal temperature, operating status
For example:
(220.1 220.2 220.3 50.1 —. – —. – —. – 149.5 221 222 223 50 5 6 7 20 30 25 216.5 31687 90 37.5 0000100000000011
The return format starts with a “(“, and each field is separated by a space. The unit for voltage is V, current is A, frequency is Hz, and power is VA. If a field has no value, it is replaced with —. There are a total of 23 fields.
The working states b15 (first) ~ b0 (last) are as follows:
b15: UPS type: 0=ONLINE, 1=BACKUP;
b14~b12: reserved for future use;
b10~b11: Battery self-test discharge result: 00==Unknown, 1==Failed, 2==Successful;
b9: reserved for future use;
b8: 0==no overload, 1==overload;
b7: mains power normal == 0, abnormal == 1;
b6: Battery voltage: 0=not low, 1=low;
b5: 0== running state, 1== shutting down or shutdown state;
b4: 0==open state, 1==buzzer mute state;
b0~b3: UPS status:
0=POWE ON: Power-on state
1=STANDBY – Standby state
2=BYPASS: Bypass status
3=LINE: Commercial power working status
4=BAT Battery Power Supply Status
5=TEST Self-checking discharge status
6=FAULT (Fault status)
7=CONVERTER
8=HE economic status, essentially equivalent to BYPASS
9=SHUTDOWN: Shutdown state
(3) The SON(), SOFF(), BZON(), BZOFF(), and T() commands control the status of the UPS, with the following return results:
a. Execution successful, return: (OK
b. Unable to execute or execution failed: (FAILED
(4) For other queries related to the device, return results based on the protocol within the device;
The control command was successfully executed. Response: (OK, failure response: (FAILED