Skip to main content
All CollectionsDeveloper Documentation
API Endpoints for System status
API Endpoints for System status

API endpoints to fetch various Edge and Access Point status details like CPU, Memory or Uptime.

A
Written by Aparna Jaiswal
Updated over 2 months ago

Edge Node Details

This endpoint returns various Edge node details like Uptime, current status, associated customer, IP address and other network details.

Request :

curl 'https://cso.celona.io/v1/api/cfgm/pses/1000000031-0-1000000130-4196319310/nodes?customer_id=1000000031' \
-H 'X-API-Key: api-key-value'

Where "1000000031-0-1000000130-4196319310" is the Edge Cluster ID whcih can be obtained from the Celona Orchestrator.

Example Response:

{
"code": 200,
"data": [
{
"admin_state": true,
"connected": true,
"created_on": "2021-05-12 05:06:49",
"cust_company_name": "NTTGN",
"customer_id": 1000000031,
"first_used_on": "2022-12-28 03:09:32",
"home_cso_id": 1,
"id": 1000000115,
"invm_node_type": "Celona Edge Express",
"ip_address": "192.168.21.10",
"is_datapath_node": false,
"is_master": true,
"is_vm": false,
"mac_address": null,
"name": "PSE Node",
"network_interface_list": [
{
"interface_id": "eno4",
"is_default": true,
"name": "RJ45 Port 1"
},
{
"interface_id": "eno3",
"is_default": false,
"name": "RJ45 Port 2"
}
],
"node_context_description": null,
"node_context_id": null,
"node_context_label": null,
"node_context_updated_on": "2024-09-17 09:51:32",
"node_model": "SYS-6017B-MTLF",
"node_type": 1,
"pse_cluster_id": "1000000031-0-1000000130-4196319310",
"pse_node_id": "05df60a6-cda9-410f-9e54-90b93a79b992",
"public_ip": "4.14.126.23",
"serial_number": "S440665X1306865",
"stats": {
"cpu_capacity": 12000,
"cpuusage": 4080,
"cpuusage_units": "Mi",
"cpuutil": 34,
"created_on": "2021-05-19 21:54:53",
"mem_capacity": 67409,
"memusage": 61797,
"memusage_units": "MB",
"memutil": 91.67,
"nwkutil": 0,
"updated_on": "2024-09-17 09:51:32"
},
"status": 4,
"sw_version": "2308.edge.0.1-2",
"total_bootup_steps": 14,
"updated_on": "2024-09-17 09:51:32",
"uptime": "2023-11-01 21:52:49",
"uptime_epoch": 1698875569
}
],
"error": "",
"success": true
}

Note:

In above response uptime_epoch is epoch time in seconds since edge node is up.

For HA Cluster, seperate object in array will provide uptime for each edge node.

Access Point Details

This endpoint returns various Access Points details like Access Point status, uptime, network details and other RF configurations.

Request:

Example with customer ID: 1000000031

curl 'https://cso.celona.io/v1/api/cfgm/enodebs?customer_id=1000000031' \
-H 'X-API-Key: api-key-value'

Example Response:

{
"code": 200,
"data": [
{
"acs_ip_address": "192.168.21.161",
"active_devices_count": 0,
"active_neighbors": [
"3600_720",
"3650_720",
"3670_540"
],
"active_plmns": "",
"admin_state": false,
"antenna_gain": null,
"category": "A",
"cfg_status": 6,
"configured_max_transmit_power": null,
"connected": false,
"cpi_antenna_sector_in_use": "Complete",
"created_on": "2020-06-09 04:32:08",
"current_deployment_category": "A",
"current_radio_technology": "1",
"current_radio_technology_label": "4G",
"customer_id": 1000000031,
"default_max_transmit_power": 21,
"devices_count": 0,
"displayStatus": "Successful",
"down_context": 2,
"down_context_reason": "Received keepalive with IP 192.168.21.161 and Control UP",
"down_context_text": "Pending Edge contact",
"down_context_updated_on": "2024-09-12 21:30:29",
"enodeb_id": 1007,
"ethernet_properties": {
"ap_temp": 0,
"duplex_mode": 0,
"interface_type": 0,
"link_speed": 0
},
"explicitEnablePtp21": false,
"fccid": "P27-SCE4255W",
"first_used_on": "2022-12-28 03:09:32",
"geolocation": {
"is_indoor": true,
"location": null,
"map_lat": 39.612278,
"map_long": -104.898987
},
"home_cso_id": null,
"id": 1000000041,
"ip_address": "192.168.21.161",
"ipsec_enabled": false,
"ipsec_gateway": "4.14.126.23",
"is_arch_type_split": false,
"last_upgraded": "2024-04-04 09:01:55",
"mac_address": "60CE86FF51EF",
"map_lat": 39.61227798461914,
"map_long": -104.89898681640625,
"model": "SCE4255W",
"model_prefix": "Celona AP10",
"name": "CCOELB5-CELONA-CAP-2",
"neutral_host_enabled": false,
"nh_ipsec_gw_ep": null,
"nh_ipsec_ip_address": "",
"op_status": 5,
"op_status_updated_on": "2024-09-12 21:30:29",
"pending_cpi_antenna_sector": "None",
"permissible_channel_width": "10,20",
"plmn_id": "315010",
"plmn_id_list": [
{
"mno_id": null,
"mno_operator_name": "Celona",
"plmn_id": "315010",
"plmn_network_name": "Celona"
}
],
"plmn_name": "Celona",
"primary_external_ptp_server": "192.168.21.20",
"private_network_enabled": true,
"protocol_5g": null,
"protocol_lte": "TR069",
"pse_cluster_id": "1000000031-0-1000013556-3401174481",
"pse_cluster_op_status": 4,
"ptp_auto_discovery_mode": true,
"ptp_leaders_followers_with_status": [
{
"followers": null,
"is_active_leader": true,
"is_primary_leader": true,
"leader": {
"followers": null,
"ip_address": "192.168.21.20",
"name": "TRIMBLE-PTP-PRIMARY-ETH0",
"ptp_leader_type": "EXTERNAL_PTP"
},
"serial_number": "2001CW5000046",
"time_source_type": "EXTERNAL_PTP"
}
],
"ptp_sync_state": "TOD_WAIT",
"radios": [
{
"admin_state": false,
"cell_id": 1,
"channel_bandwidth": 100,
"configured_max_transmit_power": null,
"created_on": "2023-08-23 23:17:16",
"default_max_transmit_power": 21,
"earfcndl": 55540,
"earfcnul": 55540,
"enodeb_id": 1007,
"enodeb_serial_number": "2001CW5000046",
"first_used_on": "2023-08-23 23:17:16",
"frequency_dl": 3580,
"frequency_ul": 3580,
"id": 615305040,
"name": "Sector1",
"op_status": 5,
"optimal_power": 21,
"pci": 7,
"radio_serial_number": null,
"rf_state": false,
"rf_state_change_pending": false,
"sas_grant_status": "Authorized",
"signal_power": 0,
"signal_power_dbm": 0,
"sw_version": "2206.ap.0.0-5",
"timestamp": "08/25/2024 00:03:53 GMT",
"updated_on": "2024-09-12 21:31:53"
},
{
"admin_state": false,
"cell_id": 2,
"channel_bandwidth": 100,
"configured_max_transmit_power": null,
"created_on": "2023-08-23 23:17:16",
"default_max_transmit_power": 21,
"earfcndl": 55340,
"earfcnul": 55340,
"enodeb_id": 1007,
"enodeb_serial_number": "2001CW5000046",
"first_used_on": "2023-08-23 23:17:16",
"frequency_dl": 3560,
"frequency_ul": 3560,
"id": 615305041,
"name": "Sector2",
"op_status": 5,
"optimal_power": 21,
"pci": 8,
"radio_serial_number": null,
"rf_state": false,
"rf_state_change_pending": false,
"sas_grant_status": "Authorized",
"signal_power": 0,
"signal_power_dbm": 0,
"sw_version": "2206.ap.0.0-5",
"timestamp": "08/25/2024 00:03:53 GMT",
"updated_on": "2024-09-12 21:31:53"
}
],
"ran_config_error": null,
"ran_config_status": null,
"recommended_operational_power": null,
"requested_version": "2305.ap.0.0-13",
"sas_reset_required": false,
"sasready_updated_on": "2024-05-17 17:09:55",
"serial_number": "2001CW5000046",
"site_id": 1000011602,
"site_name": "CCOELB5 - Celona - 4G - 5G",
"spectrum_band": "48",
"spectrum_range_end": 3700,
"spectrum_range_start": 3550,
"status": 5,
"statusDescription": "",
"statusEnum": null,
"supported_radio_technology": "1",
"supported_radio_technology_label": "4G",
"sw_version": "2206.ap.0.0-5",
"time_source_id": 2,
"time_source_label": "PTP",
"type": "LTE",
"updated_on": "2024-09-17 09:54:53",
"upgrade_status": "UPGRADE_SUCCESS",
"uptime": "2024-09-12 21:25:59",
"uptime_epoch": 1726176359,
"use_internal_antenna": true,
"using_sas": true
},
...,
...
],
"error": "",
"success": true
}

Note:

In above response uptime_epoch is epoch time in seconds since access point is up.

To get status details of a particular access point :

curl 'https://cso.celona.io/v1/api/cfgm/enodebs/AP21RBAAN0300013?customer_id=1000000031' \
-H 'X-API-Key: api-key-value'

Note:- in above AP21RBAAN0300013 is access point serial number.

Edge Node CPU & Memory Utilization

Request:

curl 'https://cso.celona.io/v1/api/stats/nodeStats?startTime=1726480728459&endTime=1726567128459&customerId=<customer_id>&clusterId=<Edge_cluster_id>&nodeId=<edge_node_serialnumber>' \
-H 'X-API-Key: api-key-value'

Example Response:

[
{
"__time": 1726480851140,
"clusterId": "1000000031-0-1000013556-3401174481",
"customerId": "1000000031",
"nodeCPUCapacity": "32000",
"nodeCPUUsage": "3840",
"nodeCpuUsageUnits": "Mi",
"nodeId": "a03eabda-24bb-4b9e-b7b1-9bf6517c42c9",
"nodeMemCapacity": "269902",
"nodeMemUsage": "33785",
"nodeMemUsageUnits": "MB",
"nodeName": "pse2",
"nodeCPUPercent": "12",
"nodeMemPercent": "12.517506",
"message": null,
"eventType": null,
"timestamp": 1726480851140
},
...,
...
]
Did this answer your question?