RniAPI.proto.txt 10.9 KB
Newer Older
1 2
/*
info:
3
  description: 'The ETSI MEC ISG MEC012 RNI API described using Protocol Buffer'
4
  version: '1.1.1'
5
  title: 'RNI API, Protobuf'
6
externalDocs: 
7
  description: ETSI GS MEC012 Radio Network Information API, V1.1.1
8
  url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/01.01.01_60/gs_mec012v010101p.pdf'
ETSI CTI's avatar
ETSI CTI committed
9 10 11
license:
  name: BSD-3-Clause
  url: 'https://forge.etsi.org/legal-matters'
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
*/

/* START PROTO DEFINITION*/
syntax = "proto3";

message LinkType
{
	string href = 1;
}
message TimeStamp
{
	uint32 seconds = 1;
	uint32 nanoSeconds = 2;
}
message AssociateId
{
	enum Type
	{
		RESERVED = 0;
		UE_IPV4_ADDRESS = 1;
		UE_IPV6_ADDRESS = 2;
		NATED_IP_ADDRESS = 3;
		GTP_TEID = 4;
	}
	Type type = 1;
	string value = 2;
}
message PlmnInfo
{
	message Ecgi
	{
		string mcc = 1;
		string mnc = 2;
		string cellId = 3;
	}
	TimeStamp timeStamp = 1;
	string appInsId = 2;
	repeated Ecgi ecgi =3;
}
message RabInfo
{
	message CellUserInfo
	{
		Ecgi ecgi = 1;
		repeated UeInfo ueInfo = 2;
	}
	message Ecgi
	{
		string mcc = 1;
		string mnc = 2;
		string cellId = 3;
	}
	message UeInfo
	{
		repeated AssociateId associatedId = 1;
		repeated ErabInfo erabInfo = 2;
	}
	message ErabInfo
	{
		uint32 erabId = 1;
		ErabQosParameters erabQosParameters = 2;
	}
	message ErabQosParameters
	{
		uint32 qci = 1;
		QosInformation qosInfo = 2;
	}
	message QosInformation
	{
		uint32 erabMbrDl = 1;
		uint32 erabMbrUl = 2;
		uint32 erabGbrDl = 3;
		uint32 erabGbrUl = 4;
	}
	TimeStamp timeStamp = 1;
	string appInsId = 2;
	string requestId =3;
	repeated CellUserInfo cellUsers = 4;
}
message S1BearerInfo
{
	message TempUeId
	{
		string mmec = 1;
		string mtmsi = 2;
	}
	message Ecgi
	{
		string mcc = 1;
		string mnc = 2;
		string cellId = 3;
	}
	message EnbInfo
	{
		string ipAddress = 1;
		string tunnelId = 2;
	}
	message SGwInfo
	{
		string ipAddress = 1;
		string tunnelId = 2;
	}
	message S1BearerInfoDetailed
	{
		uint32 erabId = 1;
		EnbInfo enbInfo = 2;
		SGwInfo sGwInfo = 3;
	}
	message S1UeInfo
	{
		TempUeId tempUeId = 1;
		repeated AssociateId associateId = 2;
		repeated Ecgi ecgi = 3; 
		repeated S1BearerInfoDetailed s1BearerInfoDetailed = 4;
	}
	TimeStamp timeStamp = 1;
	repeated S1UeInfo s1UeInfo = 2;
}
message CellChangeSubscription
{
	message Plmn
	{
		string mcc = 1;
		string mnc = 2;
	}
	message FilterCriteriaAssocHo
	{
		enum HoStatus
		{
			RESERVED = 0;
			IN_PREPARATION = 1;
			IN_EXECUTION = 2;
			COMPLETED = 3;
			REJECTED = 4;
			CANCELLED = 5;
		}
		string appInsId = 1;
		repeated AssociateId associateId = 2;
		Plmn plmn = 3;
		repeated string cellId = 4;
		repeated HoStatus hoStatus = 5;
	}
	message ExpiryDeadline
	{
		uint32 seconds = 1;
		uint32	nanoSeconds = 2;
	}
	string subscriptionType = 1;
	string callbackUri = 2;
	
	FilterCriteriaAssocHo filterCriteriaAssocHo = 3;
	TimeStamp expiryDeadline = 4;
}
message RabEstSubscription
{
	message Plmn
	{
		string mcc = 1;
		string mnc = 2;
	}
	message FilterCriteriaQci
	{
		string appInsId = 1;
		Plmn plmn = 2;
		repeated string cellId = 3;
		uint32 qci = 4;
	}
	message ExpiryDeadline
	{
		uint32 seconds = 1;
		uint32	nanoSeconds = 2;
	}
	string subscriptionType = 1;
	string callbackUri = 2;
	
	FilterCriteriaQci filterCriteriaQci = 3;
	TimeStamp expiryDeadline = 4;
}
message RabModSubscription
{
	message Plmn
	{
		string mcc = 1;
		string mnc = 2;
	}
	message FilterCriteriaQci
	{
		string appInsId = 1;
		Plmn plmn = 2;
		repeated string cellId = 3;
		uint32 qci = 4;
	}
	message ExpiryDeadline
	{
		uint32 seconds = 1;
		uint32	nanoSeconds = 2;
	}
	string subscriptionType = 1;
	string callbackUri = 2;
	FilterCriteriaQci filterCriteriaQci = 3;
	TimeStamp expiryDeadline = 4;
}
message RabRelSubscription
{
	message Plmn
	{
		string mcc = 1;
		string mnc = 2;
	}
	message FilterCriteriaQci
	{
		string appInsId = 1;
		Plmn plmn = 2;
		repeated string cellId = 3;
		uint32 qci = 4;
	}
	message ExpiryDeadline
	{
		uint32 seconds = 1;
		uint32 nanoSeconds = 2;
	}
	string subscriptionType = 1;
	string callbackUri = 2;
	
	FilterCriteriaQci filterCriteriaQci = 3;
	TimeStamp expiryDeadline = 4;
}
message MeasRepUeSubscription
{
	message Plmn
	{
		string mcc = 1;
		string mnc = 2;
	}
	message FilterCriteriaAssocTri
	{
		enum Trigger 
		{
			RESERVED = 0;
			PERIODICAL_REPORT_STRONGEST_CELLS = 1;
			PERIODICAL_REPORT_STRONGEST_CELLS_FOR_SON = 2;
			PERIODICAL_REPORT_CGI = 3;
			EVENT_A1 = 10;
			EVENT_A2 = 11;
			EVENT_A3 = 12;
			EVENT_A4 = 13;
			EVENT_A5 = 14;
			EVENT_A6 = 15;
			EVENT_B1 = 20;
			EVENT_B2 = 21;
			EVENT_C1 = 30;
			EVENT_C2 = 31;
			EVENT_W1 = 40;
			EVENT_W2 = 41;
			EVENT_W3 = 42;
		}
		string appInsId = 1;
		repeated AssociateId associateId = 2;
		Plmn plmn = 3;
		repeated string cellId = 4;
		repeated Trigger trigger = 5;
	}
	string subscriptionType = 1;
	string callbackUri = 2;
	FilterCriteriaAssocTri filterCriteriaAssocTri = 3;
	TimeStamp expiryDeadline = 4;
}
message MeasTaSubscription
{
	message Plmn
	{
		string mcc = 1;
		string mnc = 2;
	}
	message FilterCriteriaAssoc
	{
		string appInsId = 1;
		repeated AssociateId associateId = 2;
		Plmn plmn = 3;
		repeated string cellId = 4;
	}
	string subscriptionType = 1;
	string callbackUri = 2;
	
	FilterCriteriaAssoc filterCriteriaAssoc = 3;
	TimeStamp expiryDeadline = 4;
}
message CaReconfSubscription
{
	message Plmn
	{
		string mcc = 1;
		string mnc = 2;
	}
	message FilterCriteriaAssoc
	{
		string appInsId = 1;
		repeated AssociateId associateId = 2;
		Plmn plmn = 3;
		repeated string cellId = 4;
	}
	string subscriptionType = 1;
	string callbackUri = 2;
	
	FilterCriteriaAssoc filterCriteriaAssoc = 3;
	TimeStamp expiryDeadline = 4;
}
message S1BearerSubscription
{
	enum EventType 
	{
		RESERVED = 0;
		S1_BEARER_ESTABLISH = 1;
		S1_BEARER_MODIFY = 2;
		S1_BEARER_RELEASE = 3;
	}
	message Plmn
	{
		string mcc = 1;
		string mnc = 2;
	}
	message S1BearerSubscriptionCriteria
	{
		repeated AssociateId associateId = 1;
		Plmn plmn = 2;
		repeated string cellId = 3;
		repeated uint32 erabId = 4;
	}
	string subscriptionType = 1;
	string callbackUri = 2;
	repeated EventType eventType = 3; 
	S1BearerSubscriptionCriteria s1BearerSubscriptionCriteria = 4;
	TimeStamp expiryDeadline = 5;
}
message SubscriptionLinkList
{
	enum SubscriptionType
		{
			RESERVED = 0;
			CELL_CHANGE = 1;
			RAB_ESTABLISHMENT = 2;
			RAB_MODIFICATION = 3;
			RAB_RELEASE = 4;
			MEAS_REPORT_UE = 5;
			MEAS_TIMING_ADVANCE = 6;
			CA_RECONF = 7;
			S1_BEARER = 8;
		}
	message Subscription
	{
		string href = 1;
		SubscriptionType subscriptionType = 2;
	}
	message Links
	{
		LinkType self = 1;
		repeated Subscription subscription = 2;
	}
	Links _links = 1;
}
message CellChangeNotification
{
	enum HoStatus
	{
		RESERVED = 0;
		IN_PREPARATION = 1;
		IN_EXECUTION = 2;
		COMPLETED = 3;
		REJECTED = 4;
		CANCELLED = 5;
	}
	message Ecgi
	{
		string mcc = 1;
		string mnc = 2;
		string cellId = 3;
	}
	message TempUeId
	{
		string mmec = 1;
		string mtmsi = 2;
	}
	TimeStamp timeStamp = 1;
	repeated AssociateId associateId = 2;
	Ecgi srcEcgi = 3;
	Ecgi trgEcgi = 4;
	HoStatus hoStatus = 5;
	TempUeId tempUeId = 6;
} 
message RabEstNotification
{
	message Ecgi
	{
		string mcc = 1;
		string mnc = 2;
		string cellId =3;
	}
	message QosInformation
	{
		uint32 erabMbrDl = 1;
		uint32 erabMbrUl = 2;
		uint32 erabGbrDl = 3;
		uint32 erabGbrUl = 4;
	}
	message ErabQosParameters
	{
		uint32 qci= 1;
		QosInformation qosInformation = 2;
	}
	message TempUeId
	{
		string mmec = 1;
		string mtmsi = 2;
	}
	TimeStamp timeStamp = 1;
	Ecgi ecgi = 2;
	repeated AssociateId associateId = 3;
	uint32 erabId = 4;
	ErabQosParameters erabQosParameters = 5;
	TempUeId tempUeId = 6;
} 
message RabModNotification
{
	message Ecgi
	{
		string mcc = 1;
		string mnc = 2;
		string cellId =3;
	}
	message QosInformation
	{
		uint32 erabMbrDl = 1;
		uint32 erabMbrUl = 2;
		uint32 erabGbrDl = 3;
		uint32 erabGbrUl = 4;
	}
	message ErabQosParameters
	{
		uint32 qci= 1;
		QosInformation qosInformation = 2;
	}
	TimeStamp timeStamp = 1;
	Ecgi ecgi = 2;
	repeated AssociateId associateId = 3;
	uint32 erabId = 4;
	ErabQosParameters erabQosParameters = 5;
} 
message RabRelNotification
{
	message Ecgi
	{
		string mcc = 1;
		string mnc = 2;
		string cellId =3;
	}
	message ErabReleaseInfo
	{
		uint32 erabId = 1;
	}
	TimeStamp timeStamp = 1;
	Ecgi ecgi = 2;
	repeated AssociateId associateId = 3;
	ErabReleaseInfo erabReleaseInfo = 4;
} 
message MeasRepUeNotification
{
	enum Trigger 
	{
		NOT_AVAILABLE = 0;
		PERIODICAL_REPORT_STRONGEST_CELLS = 1;
		PERIODICAL_REPORT_STRONGEST_CELLS_FOR_SON = 2;
		PERIODICAL_REPORT_CGI = 3;
		EVENT_A1 = 10;
		EVENT_A2 = 11;
		EVENT_A3 = 12;
		EVENT_A4 = 13;
		EVENT_A5 = 14;
		EVENT_A6 = 15;
		EVENT_B1 = 20;
		EVENT_B2 = 21;
		EVENT_C1 = 30;
		EVENT_C2 = 31;
		EVENT_W1 = 40;
		EVENT_W2 = 41;
		EVENT_W3 = 42;
	}
	message Ecgi
	{
		string mcc = 1;
		string mnc = 2;
		string cellId =3;
	}
	message EutranNeighborCellMeasInfo
	{
		Ecgi ecgi = 1;
		uint32 rsrp = 2;
		uint32 rsrq = 3;	
	}
	message CarrierAggregationMeasInfo
	{
		string cellIdSrv = 1;
		uint32 rsrpSrv = 2;
		uint32 rsrqSrv = 3;
		string cellIdNei = 4;
		uint32 rsrpNei = 5;
		uint32 rsrqNei = 6;
	}
	TimeStamp timeStamp = 1;
	Ecgi ecgi = 2;
	repeated AssociateId associateId = 3;
	uint32 rsrp = 4;
	uint32 rsrq = 5;
	Trigger trigger = 6;
	repeated EutranNeighborCellMeasInfo eutranNeighborCellMeasInfo = 7;
	repeated CarrierAggregationMeasInfo carrierAggrMeasInfo = 8;
} 
message MeasTaNotification
{
	message Ecgi
	{
		string mcc = 1;
		string mnc = 2;
		string cellId =3;
	}
	TimeStamp timeStamp = 1;
	Ecgi ecgi = 2;
	repeated AssociateId associateId = 3;
	uint32	timingAdvance = 4;
}
message CaReConfNotification
{
	message Ecgi
	{
		string mcc = 1;
		string mnc = 2;
		string cellId =3;
	}
	message SecondaryCellAdd
	{
		Ecgi ecgi = 1;
	}
	message SecondaryCellRemove
	{
		Ecgi ecgi = 1;
	}
	message CarrierAggregationMeasInfo
	{
		string cellIdSrv = 1;
		uint32 rsrpSrv = 2;
		uint32 rsrqSrv = 3;
		string cellIdNei = 4;
		uint32 rsrpNei = 5;
		uint32 rsrqNei = 6;
	}
	TimeStamp timeStamp = 1;
	Ecgi ecgi = 2;
	repeated AssociateId associateId = 3;
	repeated SecondaryCellAdd secCellAdd = 4;
	repeated SecondaryCellRemove secCellRem = 5;
	repeated CarrierAggregationMeasInfo carrAggrMeasInfo = 6;
} 
message ExpiryNotification
{
	message Links
	{
		string self = 1;
	}
	TimeStamp timeStamp = 1;
	Links _links = 2;
	TimeStamp expiryDeadline = 3;
}
message S1BearerNotification
{
	enum S1EventType 
	{
		RESERVED = 0;
		S1_BEARER_ESTABLISH = 1;
		S1_BEARER_MODIFY = 2;
		S1_BEARER_RELEASE = 3;
	}
	message TempUeId
	{
		string mmec = 1;
		string mtmsi = 2;
	}
	message Ecgi
	{
		string mcc = 1;
		string mnc = 2;
		string cellId = 3;
	}
	message EnbInfo
	{
		string ipAddress = 1;
		string tunnelId = 2;
	}
	message SGwInfo
	{
		string ipAddress = 1;
		string tunnelId = 2;
	}
	message S1BearerInfo
	{
		uint32 erabId = 1;
		EnbInfo enbInfo = 2;
		SGwInfo sGwInfo = 3;
	}
	message S1UeInfo
	{
		TempUeId tempUeId = 1;
		AssociateId associateId = 2;
		repeated Ecgi ecgi = 3;
		repeated S1BearerInfo s1BearerInfo = 4;
	}
	TimeStamp timeStamp = 1;
	S1EventType s1Event = 2;
	S1UeInfo s1UeInfo = 3;
ETSI CTI's avatar
ETSI CTI committed
629
}