CT#109 (84420356) · Commits · All Groups / 5G APIs

TS29570_Nscp_EventExposure.yaml

+463 −417

Original line number	Diff line number	Diff line
		@@ -7,7 +7,7 @@ info:
		© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 29.570 V1.0.0; Service Communication Proxy Services.
		description: 3GPP TS 29.570 V1.1.0; Service Communication Proxy Services.
		url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.570/
		servers:
		- url: '{apiRoot}/nscp-ee/v1'
		@@ -278,6 +278,8 @@ components:
		description: Describes an SCP event filters
		type: object
		properties:
		nfType:
		$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType'
		targetNfSetId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
		targetNfIdList:
		@@ -303,14 +305,6 @@ components:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'


		ScpEventType:
		description: Describes the supported event types of Nscp_EventExposure Service
		anyOf:
		- type: string
		enum:
		- SERVICE_SIGNALLING_CHARACTERISTICS
		- type: string


		ScpEventExposureNotification:
		description: Represents an event notification
		@@ -342,34 +336,10 @@ components:
		$ref: '#/components/schemas/ScpEventType'
		timeStamp:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
		nfId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
		nfSetId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
		aveIngress:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
		aveEgress:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
		egressSuccessRate:
		type: integer
		egressFailRate:
		type: integer
		failureCauseStat:
		scpSignallingInfoList:
		type: array
		items:
		$ref: '#/components/schemas/FailureCauseOccurrence'
		priority:
		type: integer
		capacity:
		type: integer
		load:
		type: integer
		signalingStat:
		type: array
		items:
		$ref: '#/components/schemas/ScpSigTypeStat'
		# ueId attribute data type is FFS and depends on the clarification from SA2.
		# heartBeatInfo attribute data type is FFS and depends on the clarification from SA2.
		$ref: '#/components/schemas/ScpSignallingInfo'
		required:
		- eventType
		- timeStamp
		@@ -381,24 +351,70 @@ components:
		properties:
		cause:
		$ref: '#/components/schemas/FailureCause'
		number:
		type: integer
		count:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		required:
		- cause
		- number
		- count


		ScpSigTypeStat:
		description: The number a types of signalling received or sent by SCP
		ScpSignallingInfo:
		description:
		Per service instance statistics including SCP and NF statistics behavior and overload.
		type: object
		properties:
		signalType:
		serviceInstanceId:
		type: string
		number:
		type: integer
		nfInstanceId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
		serviceName:
		$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName'
		nfType:
		$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType'
		nfSetId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
		requestCount:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' successfulResponseCount:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		failureResponseCount:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		failureCauseStats:
		type: array
		items:
		$ref: '#/components/schemas/FailureCauseOccurrence'
		minItems: 1
		scpFailureCount:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		scpFailureCauseStats:
		type: array
		items:
		$ref: '#/components/schemas/FailureCauseOccurrence'
		minItems: 1
		reselectionStatList:
		type: array
		items:
		$ref: '#/components/schemas/ReselectionStat'
		minItems: 1
		connectionStatus:
		$ref: '#/components/schemas/ConnectionStatus'
		avgResponseTimeToNF:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		overloadControlInfo:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/OverloadControlInfo'


		ReselectionStat:
		description: The number of times that a reselection happened due to a particular reason
		type: object
		properties:
		reselectionReason:
		$ref: '#/components/schemas/ReselectionReason'
		count:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		required:
		- signalType
		- number
		- reselectionReason
		- count


		#
		# ENUMERATIONS
		@@ -412,6 +428,36 @@ components:
		enum:
		- TIME_OUT
		- SERVER_ERROR
		- CONSUMER_ERROR
		- CLIENT_ERROR
		- OTHER_FAILURE_REASONS
		- type: string


		ScpEventType:
		description: Describes the supported event types of Nscp_EventExposure Service
		anyOf:
		- type: string
		enum:
		- SERVICE_SIGNALLING_CHARACTERISTICS
		- type: string


		ReselectionReason:
		description: Describes the reasons for SCP reselection
		anyOf:
		- type: string
		enum:
		- TARGET_NF_UNREACHABLE
		- LOAD_BASED_RESELECTION
		- SERVICE_INSTANCE_FAILURE
		- UNSPECIFIED
		- type: string

		ConnectionStatus:
		description: Describes the connection status
		anyOf:
		- type: string
		enum:
		- ACTIVE
		- INACTIVE
		- type: string