JSON API for YateUCN Control

From YateBTS
Jump to: navigation, search

Request: query_stats

Retrieve node statistics for the equipment.
It is mandatory to provide the desired node type.

Request

{ "request":"query_stats", "node":"ucn" }

Example response

{"code":0,
 "stats":{
   "engine":{
     "version":"5.5.1","revision":1819,"nodename":"mobile-devel4","plugins":33,"inuse":1,"handlers":413,"hooks":5,
     "messages":0,"maxqueue":13,"messagerate":2,"maxmsgrate":386,"enqueued":179899,"dequeued":179899,"dispatched":212095,
     "supervised":false,"runattempt":0,"lastsignal":0,"threads":81,"workers":5,"mutexes":497,"semaphores":0,"acceptcalls":"accept","congestion":0
   },
   "ucn_pgw":{
     "apns":20,
     "sessions":0,
     "bearers":0,
     "reservations":0,
     "redirecting":0,
     "pdp_created":3
   },
   "ucn_gmsc":{
     "inbound":0,
     "routed":0,
     "diverted":0,
     "failed":0
   },
   "ucn_ati":{
     "sent":0,
     "recv":0,
     "errs":0,
     "fail":0
   },
   "ucn_gtt":{
     "local":48,
     "stp":31,
     "back":0,
     "fail":0,
     "stp_1":"up",
     "stp_101":"down"
   },
   "ucn_mme_sgsn":{
     "s1_setup":1,
     "ue_ctxt":12,
     "ue_auths":4,
     "ue_attach":4,
     "pdn_local":1,
     "pdn_remote":4,
     "ms_auths":2,
     "ms_attach":1
   }
 }
}

Request: query_data

Request information about a subscriber's data session.
Must provide one of the subscriber identities:

  • imsi
  • msisdn
  • address (End User Address, can be IPv4 or IPv4)

Example request:

{ "request":"query_data", "params":{ "imsi":"001010123456789" } }

Example response:

{ "code":0,
  "data_session":{
    "imsi":"001010123456789",
    "msisdn":"88270089",
    "apn":"internet",
    "plmn":"00101",
    "sgsn":"192.168.0.2",
    "ipv4":"10.225.0.82",
    "ipv6":"fd00:1:0:2::",
    "qci":9,
    "redirect":true
  }
}

If no session could be identified for the provided identity an error will be returned:

{ "code":"404", "message":"Entity not found." }

Request: re_authorize

Send a re-authorization request for the data sessions.
Must provide one of the subscriber identities:

  • imsi
  • msisdn
  • address (End User Address, can be IPv4 or IPv4)

This request can result in a session termination if the re-authorization is rejected.

Example request:

{ "request":"re_authorize", "params":{ "imsi":"001010123456789" } }

Example response:

{ "code":0,
  "data_session":{
    "component":"PGW",
    "apn":"internet",
    "redirect":false
  }
}

If no session could be identified for the provided identity an error will be returned:

{ "code":"404", "message":"Entity not found." }

Request: end_session

Immediately disconnect a data session.
Must provide one of the subscriber identities:

  • imsi
  • msisdn
  • address (End User Address, can be IPv4 or IPv4)

Optionally a session reactivation can be requested from the UE.

Example request:

{ "request":"end_session", "params":{ "imsi":"001010123456789", "reactivate":true } }

Example response:

{ "code":0,
  "data_session":{
    "component":"PGW"
  }
}

If no session could be identified for the provided identity an error will be returned:

{ "code":"404", "message":"Entity not found." }