REST API for Oracle Cloud Native Session Border Controller, Release 1.25.1

Retrieve one config element: SD.local-policy

get

https://cloud-native-SBC-IP/config/v1/sd/local-policy/{ElementKey}

Retrieve one config element: SD.local-policy

Request

Path Parameters

ElementKey: string

Identifier for the element

Query Parameters

revision-id: string

Integer value of saved revision, or 'latest', 'active' to show the running config, or 'staging' to show complete configuration to be activated

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

return one config element: LocalPolicy

Root Schema : schema

Type: object

configure a session request routing policy

Show Source

_elementKey: string

Read Only: true

Identifier for the element or sub-element
activate-time: string

Pattern: ^(((19)?[7-9][0-9])|((20)?(([0-2][0-9])|(3[0-7]))))(-((0?[1-9])|(1[0-2]))(-(([0-2]?[0-9])|(3[0-1]))([\\s:-](([0-1]?[0-9])|(2[0-3]))([:-][0-5]?[0-9]([:-][0-5]?[0-9](\\.[0-9]{1,3})?)?)?)?)?)?$

format is: 'yyyy-mm-dd hh:mm:ss.zzz' or: yyyy-mm-dd-hh:mm:ss.zzz where y=years; m=month; d=day h=hour (24-hour clock) m=minutes; s=seconds; z=milliseconds
deactivate-time: string

Pattern: ^(((19)?[7-9][0-9])|((20)?(([0-2][0-9])|(3[0-7]))))(-((0?[1-9])|(1[0-2]))(-(([0-2]?[0-9])|(3[0-1]))([\\s:-](([0-1]?[0-9])|(2[0-3]))([:-][0-5]?[0-9]([:-][0-5]?[0-9](\\.[0-9]{1,3})?)?)?)?)?)?$

format is: 'yyyy-mm-dd hh:mm:ss.zzz' or: yyyy-mm-dd-hh:mm:ss.zzz where y=years; m=month; d=day h=hour (24-hour clock) m=minutes; s=seconds; z=milliseconds
description: string

local policy description
from-address(required): array from-address

Minimum Number of Items: 1

Unique Items Required: true

from address list
policy-attributes: array policy-attributes

list of policy attributes
policy-priority: string

Allowed Values: [ "none", "normal", "non-urgent", "urgent", "emergency" ]
source-realm: array source-realm

Unique Items Required: true

A '*' denotes route available from all realms
state: boolean

administrative state
to-address(required): array to-address

Minimum Number of Items: 1

Unique Items Required: true

to address list

{
    "required":[
        "from-address",
        "to-address"
    ],
    "properties":{
        "from-address":{
            "description":"from address list",
            "items":{
                "$ref":"#/components/schemas/FromTo"
            },
            "minItems":1,
            "type":"array",
            "uniqueItems":true
        },
        "to-address":{
            "description":"to address list",
            "items":{
                "$ref":"#/components/schemas/FromTo"
            },
            "minItems":1,
            "type":"array",
            "uniqueItems":true
        },
        "source-realm":{
            "description":"A &#39;*&#39; denotes route available from all realms",
            "items":{
                "type":"string"
            },
            "type":"array",
            "uniqueItems":true
        },
        "description":{
            "description":"local policy description",
            "type":"string"
        },
        "activate-time":{
            "description":"format is: &#39;yyyy-mm-dd hh:mm:ss.zzz&#39; or: yyyy-mm-dd-hh:mm:ss.zzz where y&#x3D;years; m&#x3D;month; d&#x3D;day h&#x3D;hour (24-hour clock) m&#x3D;minutes; s&#x3D;seconds; z&#x3D;milliseconds",
            "pattern":"^(((19)?[7-9][0-9])|((20)?(([0-2][0-9])|(3[0-7]))))(-((0?[1-9])|(1[0-2]))(-(([0-2]?[0-9])|(3[0-1]))([\\\\s:-](([0-1]?[0-9])|(2[0-3]))([:-][0-5]?[0-9]([:-][0-5]?[0-9](\\\\.[0-9]{1,3})?)?)?)?)?)?$",
            "type":"string"
        },
        "deactivate-time":{
            "description":"format is: &#39;yyyy-mm-dd hh:mm:ss.zzz&#39; or: yyyy-mm-dd-hh:mm:ss.zzz where y&#x3D;years; m&#x3D;month; d&#x3D;day h&#x3D;hour (24-hour clock) m&#x3D;minutes; s&#x3D;seconds; z&#x3D;milliseconds",
            "pattern":"^(((19)?[7-9][0-9])|((20)?(([0-2][0-9])|(3[0-7]))))(-((0?[1-9])|(1[0-2]))(-(([0-2]?[0-9])|(3[0-1]))([\\\\s:-](([0-1]?[0-9])|(2[0-3]))([:-][0-5]?[0-9]([:-][0-5]?[0-9](\\\\.[0-9]{1,3})?)?)?)?)?)?$",
            "type":"string"
        },
        "state":{
            "description":"administrative state",
            "type":"boolean"
        },
        "policy-priority":{
            "$ref":"#/components/schemas/AnonymousPriorityEnum"
        },
        "policy-attributes":{
            "description":"list of policy attributes",
            "items":{
                "$ref":"#/components/schemas/LocalPolicyAttribute"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure a session request routing policy",
    "type":"object"
}

Nested Schema : from-address

Type: array

Minimum Number of Items: 1

Unique Items Required: true

from address list

Show Source

Array of: object FromTo

{
    "description":"from address list",
    "items":{
        "$ref":"#/components/schemas/FromTo"
    },
    "minItems":1,
    "type":"array",
    "uniqueItems":true
}

Nested Schema : policy-attributes

Type: array

list of policy attributes

Show Source

Array of: object LocalPolicyAttribute

list of policy attributes

{
    "description":"list of policy attributes",
    "items":{
        "$ref":"#/components/schemas/LocalPolicyAttribute"
    },
    "type":"array"
}

Nested Schema : source-realm

Type: array

Unique Items Required: true

A '*' denotes route available from all realms

Show Source

Array of: string

{
    "description":"A &#39;*&#39; denotes route available from all realms",
    "items":{
        "type":"string"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : to-address

Type: array

Minimum Number of Items: 1

Unique Items Required: true

to address list

Show Source

Array of: object FromTo

{
    "description":"to address list",
    "items":{
        "$ref":"#/components/schemas/FromTo"
    },
    "minItems":1,
    "type":"array",
    "uniqueItems":true
}

Nested Schema : FromTo

Type: object

Show Source

_elementKey: string

Read Only: true

Identifier for the element or sub-element
addr-type-prefix: string
name: string
type: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "addr-type-prefix":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : LocalPolicyAttribute

Type: object

list of policy attributes

Show Source

_elementKey: string

Read Only: true

Identifier for the element or sub-element
action: string

Allowed Values: [ "none", "replace-uri", "redirect" ]
app-protocol: string

Allowed Values: [ "SIP" ]
carrier: string

Pattern: ^[A-Za-z0-9\!"#\$%&'\*\+-\./:;<=>\?@\[\]\^_\{\|\}~]{0,24}$|^[A-Za-z0-9\!"#\$%&'\*\+-\./:;<=>\?@\[\]\^_\{\|\}~]{1,24}$

carrier identifier
cost: integer (int64)

Minimum Value: 0

Maximum Value: 999999999

cost (unitless)
days-of-week: string

Pattern: ^[MTWRFSUH,-]+$

days of week policy is in effect day characters may be separated by ','s or a '-'\n M=Monday T=Tuesday W=Wednesday R=Thursday F=Friday S=Saturday U=Sunday H=Holidays\n H=holidays as defined in session router config. e.g. U-S,H meaning Saturday through Sunday and holidays
eloc-str-lkup: boolean

enable emergency location string lookup
eloc-str-match: string

Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$

string used as key for emergency LRT lookup
end-time: string

Pattern: ^(([0-9])|([0-5][0-9])|([0-1]?[0-9][0-5][0-9])|(2[0-3][0-5][0-9])|(2400))$

daily time policy is no longer in effect <0000..2400>
lookup: string

Allowed Values: [ "single", "multi" ]
media-profiles: array media-profiles

list of media profiles
methods: array methods

Unique Items Required: true

list of SIP methods for matching with a SIP request method
next-hop(required): string

Minimum Length: 1

Pattern: ^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^(([Ee][Nn][Uu][Mm])|([Ll][Dd][Aa][Pp])):[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}(;key=[A-Za-z$@&][A-Za-z._\-]{0,24})?$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^(\*)$|^[Ll][Rr][Tt]:[A-Za-z_][A-Za-z0-9._\-]{0,23}(;key=[A-Za-z$@&][A-Za-z._\-]{0,24}(,[A-Za-z$@&][A-Za-z._\-]{0,24})?)?$|^[Ss][Aa][Gg]:[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

next signaling host address
next-key: string

next stage key for Multi-Stage Local Policy lookups
realm: string

Pattern: ^([A-Za-z0-9_][A-Za-z0-9._\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

realm of next signaling. NOTE: does NOT need to be configure if matches the realm of Session Agent configured as next hop.
start-time: string

Pattern: ^(([0-9])|([0-5][0-9])|([0-1]?[0-9][0-5][0-9])|(2[0-3][0-5][0-9])|(2400))$

daily time policy goes into effect <0000..2400>
state: boolean

administrative state
terminate-recursion: boolean

terminate route recursion with this next hop

{
    "required":[
        "next-hop"
    ],
    "properties":{
        "next-hop":{
            "description":"next signaling host address",
            "minLength":1,
            "pattern":"^((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])$|^((([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){6}((:[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){5}:((([0-9a-fA-F]{1,4}:)?[0-9a-fA-F]{1,4})|(((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){4}:((([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:)?((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){3}:((([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,2}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){2}:((([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,3}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|([0-9a-fA-F]{1,4}::((([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,4}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(::((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4})|(([0-9a-fA-F]{1,4}:){0,5}((([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5])[.]){3}(([0-1]{0,1}[0-9]{0,1}|2[0-4])[0-9]|25[0-5]))))|(([0-9a-fA-F]{1,4}:){1,7}:)|(::))$|^(([Ee][Nn][Uu][Mm])|([Ll][Dd][Aa][Pp])):[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}(;key=[A-Za-z$@&][A-Za-z._\\-]{0,24})?$|^([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9]){0,1}[.])*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9]){0,1})[.]{0,1}$|^(\\*)$|^[Ll][Rr][Tt]:[A-Za-z_][A-Za-z0-9._\\-]{0,23}(;key=[A-Za-z$@&][A-Za-z._\\-]{0,24}(,[A-Za-z$@&][A-Za-z._\\-]{0,24})?)?$|^[Ss][Aa][Gg]:[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "realm":{
            "description":"realm of next signaling. NOTE: does NOT need to be configure if matches the realm of Session Agent configured as next hop.",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$|^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "action":{
            "$ref":"#/components/schemas/LocalPolAttrActionEnum"
        },
        "terminate-recursion":{
            "description":"terminate route recursion with this next hop",
            "type":"boolean"
        },
        "carrier":{
            "description":"carrier identifier",
            "pattern":"^[A-Za-z0-9\\!\"#\\$%&'\\(\\)\\*\\+-\\./:;<=>\\?@\\[\\]\\^_\\{\\|\\}~]{0,24}$|^[A-Za-z0-9\\!\"#\\$%&'\\(\\)\\*\\+-\\./:;<=>\\?@\\[\\]\\^_\\{\\|\\}~]{1,24}$",
            "type":"string"
        },
        "start-time":{
            "description":"daily time policy goes into effect &lt;0000..2400&gt;",
            "pattern":"^(([0-9])|([0-5][0-9])|([0-1]?[0-9][0-5][0-9])|(2[0-3][0-5][0-9])|(2400))$",
            "type":"string"
        },
        "end-time":{
            "description":"daily time policy is no longer in effect &lt;0000..2400&gt;",
            "pattern":"^(([0-9])|([0-5][0-9])|([0-1]?[0-9][0-5][0-9])|(2[0-3][0-5][0-9])|(2400))$",
            "type":"string"
        },
        "days-of-week":{
            "description":"days of week policy is in effect day characters may be separated by &#39;,&#39;s or a &#39;-&#39;\\n M&#x3D;Monday T&#x3D;Tuesday W&#x3D;Wednesday R&#x3D;Thursday F&#x3D;Friday S&#x3D;Saturday U&#x3D;Sunday H&#x3D;Holidays\\n H&#x3D;holidays as defined in session router config. e.g. U-S,H meaning Saturday through Sunday and holidays",
            "pattern":"^[MTWRFSUH,-]+$",
            "type":"string"
        },
        "cost":{
            "description":"cost (unitless)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "state":{
            "description":"administrative state",
            "type":"boolean"
        },
        "app-protocol":{
            "$ref":"#/components/schemas/LPApplicationProtocolConstraintEnum"
        },
        "methods":{
            "description":"list of SIP methods for matching with a SIP request method",
            "items":{
                "$ref":"#/components/schemas/LPAttrMethodConstraintEnum"
            },
            "type":"array",
            "uniqueItems":true
        },
        "media-profiles":{
            "description":"list of media profiles",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "lookup":{
            "$ref":"#/components/schemas/LocalPolAttrLookupEnum"
        },
        "next-key":{
            "description":"next stage key for Multi-Stage Local Policy lookups",
            "type":"string"
        },
        "eloc-str-lkup":{
            "description":"enable emergency location string lookup",
            "type":"boolean"
        },
        "eloc-str-match":{
            "description":"string used as key for emergency LRT lookup",
            "pattern":"^([A-Za-z0-9_][A-Za-z0-9._\\-]{0,127})?$",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of policy attributes",
    "type":"object"
}

Nested Schema : media-profiles

Type: array

list of media profiles

Show Source

Array of: string

{
    "description":"list of media profiles",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : methods

Type: array

Unique Items Required: true

list of SIP methods for matching with a SIP request method

Show Source

Array of: string

Allowed Values: [ "INVITE", "REGISTER", "PRACK", "OPTIONS", "INFO", "SUBSCRIBE", "NOTIFY", "REFER", "UPDATE", "MESSAGE", "PUBLISH" ]

{
    "description":"list of SIP methods for matching with a SIP request method",
    "items":{
        "$ref":"#/components/schemas/LPAttrMethodConstraintEnum"
    },
    "type":"array",
    "uniqueItems":true
}

404 Response

Not Found

Root Schema : ApiValidationError

Type: object

Show Source

_elementKey: string

Read Only: true

Identifier for the element or sub-element
code: string
errors: array errors
message: string
timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

Array of: object Errors

{
    "items":{
        "$ref":"#/components/schemas/Errors"
    },
    "type":"array"
}

Nested Schema : Errors

Type: object

Show Source

_elementKey: string

Read Only: true

Identifier for the element or sub-element
attribute: string
code: string
message: string
type: string

Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}