Jump to

• Request
• Response

Retrieve all sub-elements: SD.session-agent.rate-constraints

get

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

Retrieve all sub-elements: SD.session-agent.rate-constraints

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

return all sub elements: RateConstraints

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object schema
  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"
}

Back to Top