Jump to

• Request
• Response

Retrieve one config element: SD.qos-constraints

get

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

Retrieve one config element: SD.qos-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 one config element: QoSConstraints

Body ()

Root Schema : schema

Type: object

configure qos constraints

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• call-load-reduction: integer (int32)
  Minimum Value: 0

  Maximum Value: 100

  call load reduction (percentage)
• critical-rfactor: integer (int32)
  Minimum Value: 0

  Maximum Value: 9321

  critical RFactor threshold
• major-rfactor: integer (int32)
  Minimum Value: 0

  Maximum Value: 9321

  major RFactor threshold
• name(required): string
  Minimum Length: 1

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

  name of the constraint
• state: boolean
  administrative state

{
    "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":"administrative state",
            "type":"boolean"
        },
        "major-rfactor":{
            "description":"major RFactor threshold",
            "format":"int32",
            "maximum":9321,
            "minimum":0,
            "type":"integer"
        },
        "critical-rfactor":{
            "description":"critical RFactor threshold",
            "format":"int32",
            "maximum":9321,
            "minimum":0,
            "type":"integer"
        },
        "call-load-reduction":{
            "description":"call load reduction (percentage)",
            "format":"int32",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure qos constraints",
    "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