Download OpenAPI specification:
Binding Support Management Service API.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
supi | string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows
|
gpsi | string (Gpsi) ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ String identifying a Gpsi shall contain either an External Id or an MSISDN. It shall be formatted as follows -External Identifier= "extid-'extid', where 'extid' shall be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an External Identifier. |
ipv4Addr | string (Ipv4Addr) ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2... String identifying a IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166. |
ipv6Prefix | string (Ipv6Prefix) ^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((... String identifying an IPv6 address prefix formatted according to clause 4 of RFC 5952. IPv6Prefix data type may contain an individual /128 IPv6 address. |
addIpv6Prefixes | Array of strings (Ipv6Prefix) non-empty [ items^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((... ] The additional IPv6 Address Prefixes of the served UE. |
ipDomain | string |
macAddr48 | string (MacAddr48) ^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$ String identifying a MAC address formatted in the hexadecimal notation according to clause 1.1 and clause 2.1 of RFC 7042. |
addMacAddrs | Array of strings (MacAddr48) non-empty [ items^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$ ] The additional MAC Addresses of the served UE. |
dnn required | string (Dnn) String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3"). |
pcfFqdn | string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... Fully Qualified Domain Name |
Array of objects (IpEndPoint) non-empty IP end points of the PCF hosting the Npcf_PolicyAuthorization service | |
pcfDiamHost | string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... Fully Qualified Domain Name |
pcfDiamRealm | string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... Fully Qualified Domain Name |
pcfSmFqdn | string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... Fully Qualified Domain Name |
Array of objects (IpEndPoint) non-empty IP end points of the PCF hosting the Npcf_SMPolicyControl service. | |
required | object (Snssai) When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd". |
suppFeat | string (SupportedFeatures) ^[A-Fa-f0-9]*$ A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. |
pcfId | string <uuid> (NfInstanceId) String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122. |
pcfSetId | string (NfSetId) NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set |
recoveryTime | string <date-time> (DateTime) string with format 'date-time' as defined in OpenAPI. |
object (ParameterCombination) Represents the combination used by the BSF to check whether there is an existing PCF binding information. | |
string or string (BindingLevel) Represents the binding level.
| |
ipv4FrameRouteList | Array of strings (Ipv4AddrMask) non-empty [ items^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2... ] |
ipv6FrameRouteList | Array of strings (Ipv6Prefix) non-empty [ items^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((... ] |
{- "supi": "string",
- "gpsi": "string",
- "ipv4Addr": "198.51.100.1",
- "ipv6Prefix": "2001:db8:abcd:12::0/64",
- "addIpv6Prefixes": [
- "2001:db8:abcd:12::0/64"
], - "ipDomain": "string",
- "macAddr48": "string",
- "addMacAddrs": [
- "string"
], - "dnn": "string",
- "pcfFqdn": "string",
- "pcfIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfDiamHost": "string",
- "pcfDiamRealm": "string",
- "pcfSmFqdn": "string",
- "pcfSmIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "snssai": {
- "sst": 255,
- "sd": "string"
}, - "suppFeat": "string",
- "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
- "pcfSetId": "string",
- "recoveryTime": "2019-08-24T14:15:22Z",
- "paraCom": {
- "supi": "string",
- "dnn": "string",
- "snssai": {
- "sst": 255,
- "sd": "string"
}
}, - "bindLevel": "NF_SET",
- "ipv4FrameRouteList": [
- "198.51.0.0/16"
], - "ipv6FrameRouteList": [
- "2001:db8:abcd:12::0/64"
]
}
{- "supi": "string",
- "gpsi": "string",
- "ipv4Addr": "198.51.100.1",
- "ipv6Prefix": "2001:db8:abcd:12::0/64",
- "addIpv6Prefixes": [
- "2001:db8:abcd:12::0/64"
], - "ipDomain": "string",
- "macAddr48": "string",
- "addMacAddrs": [
- "string"
], - "dnn": "string",
- "pcfFqdn": "string",
- "pcfIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfDiamHost": "string",
- "pcfDiamRealm": "string",
- "pcfSmFqdn": "string",
- "pcfSmIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "snssai": {
- "sst": 255,
- "sd": "string"
}, - "suppFeat": "string",
- "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
- "pcfSetId": "string",
- "recoveryTime": "2019-08-24T14:15:22Z",
- "paraCom": {
- "supi": "string",
- "dnn": "string",
- "snssai": {
- "sst": 255,
- "sd": "string"
}
}, - "bindLevel": "NF_SET",
- "ipv4FrameRouteList": [
- "198.51.0.0/16"
], - "ipv6FrameRouteList": [
- "2001:db8:abcd:12::0/64"
]
}
ipv4Addr | string (Ipv4Addr) ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2... Example: ipv4Addr=198.51.100.1 The IPv4 Address of the served UE. |
ipv6Prefix | string (Ipv6Prefix) ^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((... Example: ipv6Prefix=2001:db8:abcd:12::0/64 The IPv6 Address of the served UE. The NF service consumer shall append '/128' to the IPv6 address in the attribute value. E.g. '2001:db8:85a3::8a2e:370:7334/128'. |
macAddr48 | string (MacAddr48) ^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$ The MAC Address of the served UE. |
dnn | string (Dnn) DNN. |
supi | string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ Subscription Permanent Identifier. |
gpsi | string (Gpsi) ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ Generic Public Subscription Identifier |
object (Snssai) The identification of slice. | |
ipDomain | string The IPv4 address domain identifier. |
supp-feat | string (SupportedFeatures) ^[A-Fa-f0-9]*$ To filter irrelevant responses related to unsupported features. |
{- "supi": "string",
- "gpsi": "string",
- "ipv4Addr": "198.51.100.1",
- "ipv6Prefix": "2001:db8:abcd:12::0/64",
- "addIpv6Prefixes": [
- "2001:db8:abcd:12::0/64"
], - "ipDomain": "string",
- "macAddr48": "string",
- "addMacAddrs": [
- "string"
], - "dnn": "string",
- "pcfFqdn": "string",
- "pcfIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfDiamHost": "string",
- "pcfDiamRealm": "string",
- "pcfSmFqdn": "string",
- "pcfSmIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "snssai": {
- "sst": 255,
- "sd": "string"
}, - "suppFeat": "string",
- "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
- "pcfSetId": "string",
- "recoveryTime": "2019-08-24T14:15:22Z",
- "paraCom": {
- "supi": "string",
- "dnn": "string",
- "snssai": {
- "sst": 255,
- "sd": "string"
}
}, - "bindLevel": "NF_SET",
- "ipv4FrameRouteList": [
- "198.51.0.0/16"
], - "ipv6FrameRouteList": [
- "2001:db8:abcd:12::0/64"
]
}
bindingId required | string Represents the individual PCF for a PDU Session Binding. |
{- "cause": "string",
- "targetScp": "string",
- "targetSepp": "string"
}
bindingId required | string Represents the individual PCF for a PDU Session Binding. |
Parameters to update the existing PCF for a PDU Session binding.
ipv4Addr | string or null (Ipv4AddrRm) ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2... String identifying a IPv4 address formatted in the 'dotted decimal' notation as defined in RFC 1166 with the OpenAPI defined 'nullable: true' property. |
ipDomain | string or null |
ipv6Prefix | string or null (Ipv6PrefixRm) ^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((... String identifying an IPv6 address prefix formatted according to clause 4 of RFC 5952 with the OpenAPI 'nullable: true' property. IPv6Prefix data type may contain an individual /128 IPv6 address. |
addIpv6Prefixes | Array of strings or null (Ipv6Prefix) non-empty [ items^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((... ] The additional IPv6 Address Prefixes of the served UE. |
macAddr48 | string or null (MacAddr48Rm) ^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$ "String identifying a MAC address formatted in the hexadecimal notation according to clause 1.1 and clause 2.1 of RFC 7042 with the OpenAPI 'nullable: true' property." |
addMacAddrs | Array of strings or null (MacAddr48) non-empty [ items^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$ ] The additional MAC Addresses of the served UE. |
pcfId | string <uuid> (NfInstanceId) String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122. |
pcfFqdn | string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... Fully Qualified Domain Name |
Array of objects (IpEndPoint) non-empty IP end points of the PCF hosting the Npcf_PolicyAuthorization service. | |
pcfDiamHost | string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... Fully Qualified Domain Name |
pcfDiamRealm | string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... Fully Qualified Domain Name |
{- "ipv4Addr": "198.51.100.1",
- "ipDomain": "string",
- "ipv6Prefix": "string",
- "addIpv6Prefixes": [
- "2001:db8:abcd:12::0/64"
], - "macAddr48": "string",
- "addMacAddrs": [
- "string"
], - "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
- "pcfFqdn": "string",
- "pcfIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfDiamHost": "string",
- "pcfDiamRealm": "string"
}
{- "supi": "string",
- "gpsi": "string",
- "ipv4Addr": "198.51.100.1",
- "ipv6Prefix": "2001:db8:abcd:12::0/64",
- "addIpv6Prefixes": [
- "2001:db8:abcd:12::0/64"
], - "ipDomain": "string",
- "macAddr48": "string",
- "addMacAddrs": [
- "string"
], - "dnn": "string",
- "pcfFqdn": "string",
- "pcfIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfDiamHost": "string",
- "pcfDiamRealm": "string",
- "pcfSmFqdn": "string",
- "pcfSmIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "snssai": {
- "sst": 255,
- "sd": "string"
}, - "suppFeat": "string",
- "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
- "pcfSetId": "string",
- "recoveryTime": "2019-08-24T14:15:22Z",
- "paraCom": {
- "supi": "string",
- "dnn": "string",
- "snssai": {
- "sst": 255,
- "sd": "string"
}
}, - "bindLevel": "NF_SET",
- "ipv4FrameRouteList": [
- "198.51.0.0/16"
], - "ipv6FrameRouteList": [
- "2001:db8:abcd:12::0/64"
]
}
required | Array of strings or strings (BsfEvent) non-empty Contain te subscribed events. |
notifUri required | string (Uri) String providing an URI formatted according to RFC 3986. |
notifCorreId required | string Notification Correlation ID assigned by the NF service consumer. |
supi required | string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows
|
gpsi | string (Gpsi) ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ String identifying a Gpsi shall contain either an External Id or an MSISDN. It shall be formatted as follows -External Identifier= "extid-'extid', where 'extid' shall be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an External Identifier. |
object (SnssaiDnnPair) Contains a S-NSSAI and DNN combination. | |
Array of objects (SnssaiDnnPair) non-empty Represents the additional S-NSSAI and DNN pair(s) for which the binding event report(s) shall apply. | |
suppFeat | string (SupportedFeatures) ^[A-Fa-f0-9]*$ A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. |
{- "events": [
- "PCF_PDU_SESSION_BINDING_REGISTRATION"
], - "notifUri": "string",
- "notifCorreId": "string",
- "supi": "string",
- "gpsi": "string",
- "snssaiDnnPairs": {
- "dnn": "string",
- "snssai": {
- "sst": 255,
- "sd": "string"
}
}, - "addSnssaiDnnPairs": [
- {
- "dnn": "string",
- "snssai": {
- "sst": 255,
- "sd": "string"
}
}
], - "suppFeat": "string"
}
{- "events": [
- "PCF_PDU_SESSION_BINDING_REGISTRATION"
], - "notifUri": "string",
- "notifCorreId": "string",
- "supi": "string",
- "gpsi": "string",
- "snssaiDnnPairs": {
- "dnn": "string",
- "snssai": {
- "sst": 255,
- "sd": "string"
}
}, - "addSnssaiDnnPairs": [
- {
- "dnn": "string",
- "snssai": {
- "sst": 255,
- "sd": "string"
}
}
], - "suppFeat": "string"
}
{- "notifCorreId": "string",
- "eventNotifs": [
- {
- "event": "PCF_PDU_SESSION_BINDING_REGISTRATION",
- "pcfForUeInfo": {
- "pcfFqdn": "string",
- "pcfIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
- "pcfSetId": "string",
- "bindLevel": "NF_SET"
}, - "pcfForPduSessInfos": [
- {
- "dnn": "string",
- "snssai": {
- "sst": 255,
- "sd": "string"
}, - "pcfFqdn": "string",
- "pcfIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "ipv4Addr": "198.51.100.1",
- "ipDomain": "string",
- "ipv6Prefixes": [
- "2001:db8:abcd:12::0/64"
], - "macAddrs": [
- "string"
], - "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
- "pcfSetId": "string",
- "bindLevel": "NF_SET"
}
], - "matchSnssaiDnns": [
- {
- "dnn": "string",
- "snssai": {
- "sst": 255,
- "sd": "string"
}
}
]
}
]
}
subId required | string Subscription correlation ID |
required | Array of strings or strings (BsfEvent) non-empty Contain te subscribed events. |
notifUri required | string (Uri) String providing an URI formatted according to RFC 3986. |
notifCorreId required | string Notification Correlation ID assigned by the NF service consumer. |
supi required | string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows
|
gpsi | string (Gpsi) ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ String identifying a Gpsi shall contain either an External Id or an MSISDN. It shall be formatted as follows -External Identifier= "extid-'extid', where 'extid' shall be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an External Identifier. |
object (SnssaiDnnPair) Contains a S-NSSAI and DNN combination. | |
Array of objects (SnssaiDnnPair) non-empty Represents the additional S-NSSAI and DNN pair(s) for which the binding event report(s) shall apply. | |
suppFeat | string (SupportedFeatures) ^[A-Fa-f0-9]*$ A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. |
{- "events": [
- "PCF_PDU_SESSION_BINDING_REGISTRATION"
], - "notifUri": "string",
- "notifCorreId": "string",
- "supi": "string",
- "gpsi": "string",
- "snssaiDnnPairs": {
- "dnn": "string",
- "snssai": {
- "sst": 255,
- "sd": "string"
}
}, - "addSnssaiDnnPairs": [
- {
- "dnn": "string",
- "snssai": {
- "sst": 255,
- "sd": "string"
}
}
], - "suppFeat": "string"
}
{- "events": [
- "PCF_PDU_SESSION_BINDING_REGISTRATION"
], - "notifUri": "string",
- "notifCorreId": "string",
- "supi": "string",
- "gpsi": "string",
- "snssaiDnnPairs": {
- "dnn": "string",
- "snssai": {
- "sst": 255,
- "sd": "string"
}
}, - "addSnssaiDnnPairs": [
- {
- "dnn": "string",
- "snssai": {
- "sst": 255,
- "sd": "string"
}
}
], - "suppFeat": "string"
}
subId required | string Subscription correlation ID |
{- "cause": "string",
- "targetScp": "string",
- "targetSepp": "string"
}
supi required | string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows
|
gpsi | string (Gpsi) ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ String identifying a Gpsi shall contain either an External Id or an MSISDN. It shall be formatted as follows -External Identifier= "extid-'extid', where 'extid' shall be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an External Identifier. |
pcfForUeFqdn required | string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... Fully Qualified Domain Name |
Array of objects (IpEndPoint) non-empty IP end points of the PCF hosting the Npcf_AmPolicyAuthorization service. | |
pcfId | string <uuid> (NfInstanceId) String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122. |
pcfSetId | string (NfSetId) NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set |
string or string (BindingLevel) Represents the binding level.
| |
suppFeat | string (SupportedFeatures) ^[A-Fa-f0-9]*$ A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. |
{- "supi": "string",
- "gpsi": "string",
- "pcfForUeFqdn": "string",
- "pcfForUeIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
- "pcfSetId": "string",
- "bindLevel": "NF_SET",
- "suppFeat": "string"
}
{- "supi": "string",
- "gpsi": "string",
- "pcfForUeFqdn": "string",
- "pcfForUeIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
- "pcfSetId": "string",
- "bindLevel": "NF_SET",
- "suppFeat": "string"
}
supi | string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$ Subscription Permanent Identifier. |
gpsi | string (Gpsi) ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$ Generic Public Subscription Identifier |
supp-feat | string (SupportedFeatures) ^[A-Fa-f0-9]*$ To filter irrelevant responses related to unsupported features. |
[- {
- "supi": "string",
- "gpsi": "string",
- "pcfForUeFqdn": "string",
- "pcfForUeIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
- "pcfSetId": "string",
- "bindLevel": "NF_SET",
- "suppFeat": "string"
}
]
bindingId required | string Represents the individual PCF for a UE Binding. |
{- "cause": "string",
- "targetScp": "string",
- "targetSepp": "string"
}
bindingId required | string Represents the individual PCF for a UE Binding. |
Parameters to update the existing PCF for a UE binding.
pcfForUeFqdn | string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... Fully Qualified Domain Name |
Array of objects (IpEndPoint) non-empty IP end points of the PCF hosting the Npcf_AmPolicyAuthorization service. | |
pcfId | string <uuid> (NfInstanceId) String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122. |
{- "pcfForUeFqdn": "string",
- "pcfForUeIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5"
}
{- "supi": "string",
- "gpsi": "string",
- "pcfForUeFqdn": "string",
- "pcfForUeIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
- "pcfSetId": "string",
- "bindLevel": "NF_SET",
- "suppFeat": "string"
}
required | object or object (MbsSessionId) MBS Session Identifier |
pcfFqdn required | string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... Fully Qualified Domain Name |
Array of objects (IpEndPoint) non-empty | |
pcfId | string <uuid> (NfInstanceId) String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122. |
pcfSetId | string (NfSetId) NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set |
string or string (BindingLevel) Represents the binding level.
| |
recoveryTime | string <date-time> (DateTime) string with format 'date-time' as defined in OpenAPI. |
suppFeat | string (SupportedFeatures) ^[A-Fa-f0-9]*$ A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. |
{- "mbsSessionId": {
- "tmgi": {
- "mbsServiceId": "string",
- "plmnId": {
- "mcc": "string",
- "mnc": "string"
}
}, - "ssm": {
- "sourceIpAddr": {
- "ipv4Addr": "198.51.100.1",
- "ipv6Addr": "2001:db8:85a3::8a2e:370:7334",
- "ipv6Prefix": "2001:db8:abcd:12::0/64"
}, - "destIpAddr": {
- "ipv4Addr": "198.51.100.1",
- "ipv6Addr": "2001:db8:85a3::8a2e:370:7334",
- "ipv6Prefix": "2001:db8:abcd:12::0/64"
}
}, - "nid": "string"
}, - "pcfFqdn": "string",
- "pcfIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
- "pcfSetId": "string",
- "bindLevel": "NF_SET",
- "recoveryTime": "2019-08-24T14:15:22Z",
- "suppFeat": "string"
}
{- "mbsSessionId": {
- "tmgi": {
- "mbsServiceId": "string",
- "plmnId": {
- "mcc": "string",
- "mnc": "string"
}
}, - "ssm": {
- "sourceIpAddr": {
- "ipv4Addr": "198.51.100.1",
- "ipv6Addr": "2001:db8:85a3::8a2e:370:7334",
- "ipv6Prefix": "2001:db8:abcd:12::0/64"
}, - "destIpAddr": {
- "ipv4Addr": "198.51.100.1",
- "ipv6Addr": "2001:db8:85a3::8a2e:370:7334",
- "ipv6Prefix": "2001:db8:abcd:12::0/64"
}
}, - "nid": "string"
}, - "pcfFqdn": "string",
- "pcfIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
- "pcfSetId": "string",
- "bindLevel": "NF_SET",
- "recoveryTime": "2019-08-24T14:15:22Z",
- "suppFeat": "string"
}
required | object or object (MbsSessionId) Contains the identifier of the MBS Session to which the requested MBS Session binding is related. |
supp-feat | string (SupportedFeatures) ^[A-Fa-f0-9]*$ Contains the list of features supported by the NF service consumer and used to filter irrelevant responses related to unsupported features. |
[- {
- "mbsSessionId": {
- "tmgi": {
- "mbsServiceId": "string",
- "plmnId": {
- "mcc": "string",
- "mnc": "string"
}
}, - "ssm": {
- "sourceIpAddr": {
- "ipv4Addr": "198.51.100.1",
- "ipv6Addr": "2001:db8:85a3::8a2e:370:7334",
- "ipv6Prefix": "2001:db8:abcd:12::0/64"
}, - "destIpAddr": {
- "ipv4Addr": "198.51.100.1",
- "ipv6Addr": "2001:db8:85a3::8a2e:370:7334",
- "ipv6Prefix": "2001:db8:abcd:12::0/64"
}
}, - "nid": "string"
}, - "pcfFqdn": "string",
- "pcfIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
- "pcfSetId": "string",
- "bindLevel": "NF_SET",
- "recoveryTime": "2019-08-24T14:15:22Z",
- "suppFeat": "string"
}
]
bindingId required | string Represents the identifier of the Individual PCF for an MBS Session Binding resource. |
Parameters to request the modification of the PCF for an MBS Session Binding.
pcfFqdn | string (Fqdn) [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... Fully Qualified Domain Name |
Array of objects (IpEndPoint) non-empty | |
pcfId | string <uuid> (NfInstanceId) String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122. |
{- "pcfFqdn": "string",
- "pcfIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5"
}
{- "mbsSessionId": {
- "tmgi": {
- "mbsServiceId": "string",
- "plmnId": {
- "mcc": "string",
- "mnc": "string"
}
}, - "ssm": {
- "sourceIpAddr": {
- "ipv4Addr": "198.51.100.1",
- "ipv6Addr": "2001:db8:85a3::8a2e:370:7334",
- "ipv6Prefix": "2001:db8:abcd:12::0/64"
}, - "destIpAddr": {
- "ipv4Addr": "198.51.100.1",
- "ipv6Addr": "2001:db8:85a3::8a2e:370:7334",
- "ipv6Prefix": "2001:db8:abcd:12::0/64"
}
}, - "nid": "string"
}, - "pcfFqdn": "string",
- "pcfIpEndPoints": [
- {
- "ipv4Address": "198.51.100.1",
- "ipv6Address": "2001:db8:85a3::8a2e:370:7334",
- "transport": "TCP",
- "port": 65535
}
], - "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
- "pcfSetId": "string",
- "bindLevel": "NF_SET",
- "recoveryTime": "2019-08-24T14:15:22Z",
- "suppFeat": "string"
}
bindingId required | string Represents the identifier of the Individual PCF for an MBS Session Binding resource. |
{- "cause": "string",
- "targetScp": "string",
- "targetSepp": "string"
}