Jump to

• Request
• Response

Replace a config element: SD.sip-adv-log-trace

put

https://cloud-native-SBC-IP/config/v1/sd/sip-adv-log-trace/{ElementKey}

Replace a config element: SD.sip-adv-log-trace

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Configure logging of specific SIP requests/session by criteria

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• conditions: array conditions
  List of conditions to match for logging
• level: string
  Allowed Values: [ "None", "Fatal", "Error", "Warning", "Info", "Debug", "Trace" ]
• matches-per-window: integer (int64)
  Minimum Value: 1

  Maximum Value: 999999999

  Number of matches to be logged per time window
• name(required): string
  Minimum Length: 1

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

  Logging Name
• state: boolean
  administrative state
• trace-scope: string
  Allowed Values: [ "None", "SIPOnly", "Detailed" ]
• window-size: integer (int64)
  Minimum Value: 1

  Maximum Value: 999999999

  Size of the logging time window (seconds)

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"Logging Name",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "state":{
            "description":"administrative state",
            "type":"boolean"
        },
        "level":{
            "$ref":"#/components/schemas/CondLogLevelEnum"
        },
        "trace-scope":{
            "$ref":"#/components/schemas/CondTraceScopeEnum"
        },
        "matches-per-window":{
            "description":"Number of matches to be logged per time window",
            "format":"int64",
            "maximum":999999999,
            "minimum":1,
            "type":"integer"
        },
        "window-size":{
            "description":"Size of the logging time window (seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":1,
            "type":"integer"
        },
        "conditions":{
            "description":"List of conditions to match for logging",
            "items":{
                "$ref":"#/components/schemas/SipAdvancedLogCondition"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"Configure logging of specific SIP requests/session by criteria",
    "type":"object"
}

Nested Schema : conditions

Type: array

List of conditions to match for logging

Show Source

• Array of: object SipAdvancedLogCondition
  Configure conditions for matching SIP requests/sessions

{
    "description":"List of conditions to match for logging",
    "items":{
        "$ref":"#/components/schemas/SipAdvancedLogCondition"
    },
    "type":"array"
}

Nested Schema : SipAdvancedLogCondition

Type: object

Configure conditions for matching SIP requests/sessions

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• match-procedure: string
  Allowed Values: [ "exact-match", "regex-match" ]
• match-type(required): string
  Allowed Values: [ "request-type", "recv-agent", "recv-realm", "request-uri-user", "request-uri-host", "to-header-user", "to-header-host", "from-header-user", "from-header-host", "call-id" ]
• match-value: string
  Exact value to match or regular expression format. For match-type = request-type, Valid Values : REGISTER, INVITE, ACK, BYE, CANCEL, PRACK, OPTIONS, INFO, SUBSCRIBE, NOTIFY, REFER, UPDATE, MESSAGE, PUBLISH

{
    "required":[
        "match-type"
    ],
    "properties":{
        "match-type":{
            "$ref":"#/components/schemas/CondLoggingConditionEnum"
        },
        "match-procedure":{
            "$ref":"#/components/schemas/CondLoggingMatchProcedureEnum"
        },
        "match-value":{
            "description":"Exact value to match or regular expression format. For match-type = request-type, Valid Values : REGISTER, INVITE, ACK, BYE, CANCEL, PRACK, OPTIONS, INFO, SUBSCRIBE, NOTIFY, REFER, UPDATE, MESSAGE, PUBLISH",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"Configure conditions for matching SIP requests/sessions",
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: SipAdvancedLogging

Body ()

Root Schema : schema

Type: object

Configure logging of specific SIP requests/session by criteria

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• conditions: array conditions
  List of conditions to match for logging
• level: string
  Allowed Values: [ "None", "Fatal", "Error", "Warning", "Info", "Debug", "Trace" ]
• matches-per-window: integer (int64)
  Minimum Value: 1

  Maximum Value: 999999999

  Number of matches to be logged per time window
• name(required): string
  Minimum Length: 1

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

  Logging Name
• state: boolean
  administrative state
• trace-scope: string
  Allowed Values: [ "None", "SIPOnly", "Detailed" ]
• window-size: integer (int64)
  Minimum Value: 1

  Maximum Value: 999999999

  Size of the logging time window (seconds)

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"Logging Name",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "state":{
            "description":"administrative state",
            "type":"boolean"
        },
        "level":{
            "$ref":"#/components/schemas/CondLogLevelEnum"
        },
        "trace-scope":{
            "$ref":"#/components/schemas/CondTraceScopeEnum"
        },
        "matches-per-window":{
            "description":"Number of matches to be logged per time window",
            "format":"int64",
            "maximum":999999999,
            "minimum":1,
            "type":"integer"
        },
        "window-size":{
            "description":"Size of the logging time window (seconds)",
            "format":"int64",
            "maximum":999999999,
            "minimum":1,
            "type":"integer"
        },
        "conditions":{
            "description":"List of conditions to match for logging",
            "items":{
                "$ref":"#/components/schemas/SipAdvancedLogCondition"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"Configure logging of specific SIP requests/session by criteria",
    "type":"object"
}

Nested Schema : conditions

Type: array

List of conditions to match for logging

Show Source

• Array of: object SipAdvancedLogCondition
  Configure conditions for matching SIP requests/sessions

{
    "description":"List of conditions to match for logging",
    "items":{
        "$ref":"#/components/schemas/SipAdvancedLogCondition"
    },
    "type":"array"
}

Nested Schema : SipAdvancedLogCondition

Type: object

Configure conditions for matching SIP requests/sessions

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• match-procedure: string
  Allowed Values: [ "exact-match", "regex-match" ]
• match-type(required): string
  Allowed Values: [ "request-type", "recv-agent", "recv-realm", "request-uri-user", "request-uri-host", "to-header-user", "to-header-host", "from-header-user", "from-header-host", "call-id" ]
• match-value: string
  Exact value to match or regular expression format. For match-type = request-type, Valid Values : REGISTER, INVITE, ACK, BYE, CANCEL, PRACK, OPTIONS, INFO, SUBSCRIBE, NOTIFY, REFER, UPDATE, MESSAGE, PUBLISH

{
    "required":[
        "match-type"
    ],
    "properties":{
        "match-type":{
            "$ref":"#/components/schemas/CondLoggingConditionEnum"
        },
        "match-procedure":{
            "$ref":"#/components/schemas/CondLoggingMatchProcedureEnum"
        },
        "match-value":{
            "description":"Exact value to match or regular expression format. For match-type = request-type, Valid Values : REGISTER, INVITE, ACK, BYE, CANCEL, PRACK, OPTIONS, INFO, SUBSCRIBE, NOTIFY, REFER, UPDATE, MESSAGE, PUBLISH",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"Configure conditions for matching SIP requests/sessions",
    "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