Jump to

• Request
• Response

Replace a config element: SD.session-constraints

put

https://cloud-native-SBC-IP/config/v1/sd/session-constraints/{ElementKey}

Replace a config element: SD.session-constraints

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

configure session constraints

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• burst-rate-window: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  burst rate window (seconds) <0-999999999>
• cac-alarm-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 99

  CAC utilization threshold (percent). An alarm will be generated when session utilization or burst-rate utilization exceeds this value.
• in-service-period: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  in service period <0-999999999>
• max-burst-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max burst rate (invites per second) <0-999999999>
• max-inbound-burst-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max inbound burst rate (invites per second) <0-999999999>
• max-inbound-sessions: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max inbound sessions allowed <0-999999999>
• max-inbound-sustain-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max inbound sustained rate (invites per second) <0-999999999>
• max-outbound-burst-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max outbound burst rate (invites per second) <0-999999999>
• max-outbound-sessions: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max outbound sessions allowed <0-999999999>
• max-outbound-sustain-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max outbound sustained rate (invites per second) <0-999999999>
• max-sessions: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max sessions allowed <0-999999999>
• max-sustain-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max sustained rate (invites per second) <0-999999999>
• min-asr: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  minimum asr <0-100>percentage
• min-seizures: integer (int64)
  Minimum Value: 1

  Maximum Value: 999999999

  minimum number of seizures for a no-answer scenario <1-999999999>
• name(required): string
  Minimum Length: 1

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

  name of the constraint
• rate-constraints: array rate-constraints
  create a rate constraint for a method
• state: boolean
  session constraint is enabled or not <enabled/disabled>
• sustain-rate-window: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  sustained rate window (seconds) <0-999999999>
• time-to-resume: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  time to resume <0-999999999>
• ttr-no-response: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  no response time to resume <0-999999999>

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"name of the constraint",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "state":{
            "description":"session constraint is enabled or not <enabled/disabled>",
            "type":"boolean"
        },
        "max-sessions":{
            "description":"max sessions allowed <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-inbound-sessions":{
            "description":"max inbound sessions allowed <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-outbound-sessions":{
            "description":"max outbound sessions allowed <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-burst-rate":{
            "description":"max burst rate (invites per second) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-inbound-burst-rate":{
            "description":"max inbound burst rate (invites per second) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-outbound-burst-rate":{
            "description":"max outbound burst rate (invites per second) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-sustain-rate":{
            "description":"max sustained rate (invites per second) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-inbound-sustain-rate":{
            "description":"max inbound sustained rate (invites per second) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-outbound-sustain-rate":{
            "description":"max outbound sustained rate (invites per second) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "min-seizures":{
            "description":"minimum number of seizures for a no-answer scenario <1-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":1,
            "type":"integer"
        },
        "min-asr":{
            "description":"minimum asr <0-100>percentage",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "cac-alarm-threshold":{
            "description":"CAC utilization threshold (percent). An alarm will be generated when session utilization or burst-rate utilization exceeds this value.",
            "format":"int64",
            "maximum":99,
            "minimum":0,
            "type":"integer"
        },
        "time-to-resume":{
            "description":"time to resume <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "ttr-no-response":{
            "description":"no response time to resume <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "in-service-period":{
            "description":"in service period <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "burst-rate-window":{
            "description":"burst rate window (seconds) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "sustain-rate-window":{
            "description":"sustained rate window (seconds) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "rate-constraints":{
            "description":"create a rate constraint for a method",
            "items":{
                "$ref":"#/components/schemas/RateConstraints"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure session constraints",
    "type":"object"
}

Nested Schema : rate-constraints

Type: array

create a rate constraint for a method

Show Source

• Array of: object schema
  create a rate constraint for a method

{
    "description":"create a rate constraint for a method",
    "items":{
        "$ref":"#/components/schemas/RateConstraints"
    },
    "type":"array"
}

Nested Schema : schema

Type: object

create a rate constraint for a method

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• max-inbound-burst-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max inbound burst rate (methods per rate)
• max-inbound-sustain-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max inbound sustained rate (methods per rate)
• max-outbound-burst-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max outbound burst rate (methods per rate)
• max-outbound-sustain-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max outbound sustained rate (methods per rate)
• method(required): string
  Allowed Values: [ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]

{
    "required":[
        "method"
    ],
    "properties":{
        "method":{
            "$ref":"#/components/schemas/SipMethodsConstraintEnum"
        },
        "max-inbound-burst-rate":{
            "description":"max inbound burst rate (methods per rate)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-outbound-burst-rate":{
            "description":"max outbound burst rate (methods per rate)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-inbound-sustain-rate":{
            "description":"max inbound sustained rate (methods per rate)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-outbound-sustain-rate":{
            "description":"max outbound sustained rate (methods per rate)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"create a rate constraint for a method",
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: SessionConstraints

Body ()

Root Schema : schema

Type: object

configure session constraints

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• burst-rate-window: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  burst rate window (seconds) <0-999999999>
• cac-alarm-threshold: integer (int64)
  Minimum Value: 0

  Maximum Value: 99

  CAC utilization threshold (percent). An alarm will be generated when session utilization or burst-rate utilization exceeds this value.
• in-service-period: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  in service period <0-999999999>
• max-burst-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max burst rate (invites per second) <0-999999999>
• max-inbound-burst-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max inbound burst rate (invites per second) <0-999999999>
• max-inbound-sessions: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max inbound sessions allowed <0-999999999>
• max-inbound-sustain-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max inbound sustained rate (invites per second) <0-999999999>
• max-outbound-burst-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max outbound burst rate (invites per second) <0-999999999>
• max-outbound-sessions: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max outbound sessions allowed <0-999999999>
• max-outbound-sustain-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max outbound sustained rate (invites per second) <0-999999999>
• max-sessions: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max sessions allowed <0-999999999>
• max-sustain-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max sustained rate (invites per second) <0-999999999>
• min-asr: integer (int64)
  Minimum Value: 0

  Maximum Value: 100

  minimum asr <0-100>percentage
• min-seizures: integer (int64)
  Minimum Value: 1

  Maximum Value: 999999999

  minimum number of seizures for a no-answer scenario <1-999999999>
• name(required): string
  Minimum Length: 1

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

  name of the constraint
• rate-constraints: array rate-constraints
  create a rate constraint for a method
• state: boolean
  session constraint is enabled or not <enabled/disabled>
• sustain-rate-window: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  sustained rate window (seconds) <0-999999999>
• time-to-resume: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  time to resume <0-999999999>
• ttr-no-response: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  no response time to resume <0-999999999>

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"name of the constraint",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "state":{
            "description":"session constraint is enabled or not <enabled/disabled>",
            "type":"boolean"
        },
        "max-sessions":{
            "description":"max sessions allowed <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-inbound-sessions":{
            "description":"max inbound sessions allowed <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-outbound-sessions":{
            "description":"max outbound sessions allowed <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-burst-rate":{
            "description":"max burst rate (invites per second) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-inbound-burst-rate":{
            "description":"max inbound burst rate (invites per second) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-outbound-burst-rate":{
            "description":"max outbound burst rate (invites per second) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-sustain-rate":{
            "description":"max sustained rate (invites per second) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-inbound-sustain-rate":{
            "description":"max inbound sustained rate (invites per second) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-outbound-sustain-rate":{
            "description":"max outbound sustained rate (invites per second) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "min-seizures":{
            "description":"minimum number of seizures for a no-answer scenario <1-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":1,
            "type":"integer"
        },
        "min-asr":{
            "description":"minimum asr <0-100>percentage",
            "format":"int64",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "cac-alarm-threshold":{
            "description":"CAC utilization threshold (percent). An alarm will be generated when session utilization or burst-rate utilization exceeds this value.",
            "format":"int64",
            "maximum":99,
            "minimum":0,
            "type":"integer"
        },
        "time-to-resume":{
            "description":"time to resume <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "ttr-no-response":{
            "description":"no response time to resume <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "in-service-period":{
            "description":"in service period <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "burst-rate-window":{
            "description":"burst rate window (seconds) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "sustain-rate-window":{
            "description":"sustained rate window (seconds) <0-999999999>",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "rate-constraints":{
            "description":"create a rate constraint for a method",
            "items":{
                "$ref":"#/components/schemas/RateConstraints"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure session constraints",
    "type":"object"
}

Nested Schema : rate-constraints

Type: array

create a rate constraint for a method

Show Source

• Array of: object schema
  create a rate constraint for a method

{
    "description":"create a rate constraint for a method",
    "items":{
        "$ref":"#/components/schemas/RateConstraints"
    },
    "type":"array"
}

Nested Schema : schema

Type: object

create a rate constraint for a method

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• max-inbound-burst-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max inbound burst rate (methods per rate)
• max-inbound-sustain-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max inbound sustained rate (methods per rate)
• max-outbound-burst-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max outbound burst rate (methods per rate)
• max-outbound-sustain-rate: integer (int64)
  Minimum Value: 0

  Maximum Value: 999999999

  max outbound sustained rate (methods per rate)
• method(required): string
  Allowed Values: [ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]

{
    "required":[
        "method"
    ],
    "properties":{
        "method":{
            "$ref":"#/components/schemas/SipMethodsConstraintEnum"
        },
        "max-inbound-burst-rate":{
            "description":"max inbound burst rate (methods per rate)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-outbound-burst-rate":{
            "description":"max outbound burst rate (methods per rate)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-inbound-sustain-rate":{
            "description":"max inbound sustained rate (methods per rate)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "max-outbound-sustain-rate":{
            "description":"max outbound sustained rate (methods per rate)",
            "format":"int64",
            "maximum":999999999,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"create a rate constraint for a method",
    "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"
}

406 Response

Validation Failure

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