Jump to

• Request
• Response

Retrieve the config element: SD.session-router

get

https://cloud-native-SBC-IP/config/v1/sd/session-router

Retrieve the config element: SD.session-router

Request

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

return config element: SessionRouter

Body ()

Root Schema : schema

Type: object

configure session router

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• additional-lp-lookups: integer (int64)
  Minimum Value: 0

  Maximum Value: 5

  Number of additional LP lookup stages
• force-report-trunk-info: boolean
  enable forcible reporting of trunk info
• holidays: array holidays
  list of holidays
• match-lp-src-parent-realm: boolean
  match LP Src Parent Realm to account for Child Realms
• max-routes-per-lookup: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  Max number of routes allowed for each stage of a multi-stage lookup
• multi-stage-src-realm-override: boolean
  enable use of local policy next-hop realm for multi stage LP
• nested-realm-stats: boolean
  increment and check stats for each parent realm
• reject-message-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  minimum number of rejected messages within a window to trigger trap
• reject-message-window: integer (int64)
  Minimum Value: 1

  Maximum Value: 999999999

  number of seconds for the reject message window
• state: boolean
  administrative state
• system-number-type: string
  Allowed Values: [ "Pots", "Routing", "E164" ]
• total-lp-routes: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  Total number of routes allowed per request for a multi-stage lookup

{
    "properties":{
        "state":{
            "description":"administrative state",
            "type":"boolean"
        },
        "system-number-type":{
            "$ref":"#/components/schemas/AddressNumberEnum"
        },
        "match-lp-src-parent-realm":{
            "description":"match LP Src Parent Realm to account for Child Realms",
            "type":"boolean"
        },
        "nested-realm-stats":{
            "description":"increment and check stats for each parent realm",
            "type":"boolean"
        },
        "reject-message-threshold":{
            "description":"minimum number of rejected messages within a window to trigger trap",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "reject-message-window":{
            "description":"number of seconds for the reject message window",
            "format":"int64",
            "maximum":999999999,
            "minimum":1,
            "type":"integer"
        },
        "holidays":{
            "description":"list of holidays",
            "items":{
                "$ref":"#/components/schemas/Holiday"
            },
            "type":"array"
        },
        "force-report-trunk-info":{
            "description":"enable forcible reporting of trunk info",
            "type":"boolean"
        },
        "additional-lp-lookups":{
            "description":"Number of additional LP lookup stages",
            "format":"int64",
            "maximum":5,
            "minimum":0,
            "type":"integer"
        },
        "max-routes-per-lookup":{
            "description":"Max number of routes allowed for each stage of a multi-stage lookup",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "total-lp-routes":{
            "description":"Total number of routes allowed per request for a multi-stage lookup",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "multi-stage-src-realm-override":{
            "description":"enable use of local policy next-hop realm for multi stage LP",
            "type":"boolean"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure session router",
    "type":"object"
}

Nested Schema : holidays

Type: array

list of holidays

Show Source

• Array of: object Holiday
  list of holidays

{
    "description":"list of holidays",
    "items":{
        "$ref":"#/components/schemas/Holiday"
    },
    "type":"array"
}

Nested Schema : Holiday

Type: object

list of holidays

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• date(required): string
  Minimum Length: 1

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

  yyyy-mm-dd
• description: string
  description

{
    "required":[
        "date"
    ],
    "properties":{
        "date":{
            "description":"yyyy-mm-dd",
            "minLength":1,
            "pattern":"^((19)|(2[0-9]))[0-9][0-9]-((0?[1-9])|(1[0-2]))-((0?[1-9])|([1-2][0-9])|(3[0-1]))$",
            "type":"string"
        },
        "description":{
            "description":"description",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of holidays",
    "type":"object"
}

404 Response

Not Found

Body ()

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"
}

Back to Top