Jump to

• Request
• Response

Retrieve the config element: Logging.transcode-controller-logging

get

https://cloud-native-SBC-IP/config/v1/logging/transcode-controller-logging

Retrieve the config element: Logging.transcode-controller-logging

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: TranscodeControllerLogging

Body ()

Root Schema : schema

Type: object

used to configure the log level for Transcode Controller

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• levels: array levels
  Log levels for Transcode Controller

{
    "properties":{
        "levels":{
            "description":"Log levels for Transcode Controller",
            "items":{
                "$ref":"#/components/schemas/LogLevelInfo"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"used to configure the log level for Transcode Controller",
    "type":"object"
}

Nested Schema : levels

Type: array

Log levels for Transcode Controller

Show Source

• Array of: object LogLevelInfo

{
    "description":"Log levels for Transcode Controller",
    "items":{
        "$ref":"#/components/schemas/LogLevelInfo"
    },
    "type":"array"
}

Nested Schema : LogLevelInfo

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• group(required): string group
  Group of the logger
• level(required): string level
  log level
• subgroup: string subgroup
  Sub Group of the logger

{
    "required":[
        "group",
        "level"
    ],
    "properties":{
        "group":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/GroupEnum"
                }
            ],
            "description":"Group of the logger",
            "type":"string"
        },
        "level":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/LevelEnum"
                }
            ],
            "description":"log level",
            "type":"string"
        },
        "subgroup":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/SubgroupEnum"
                }
            ],
            "description":"Sub Group of the logger",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : group

Group of the logger

Match All

Group of the logger

Show Source

• string
  Allowed Values: [ "CNSBC", "COHERENCE", "VENDOR", "ORG" ]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GroupEnum"
        }
    ],
    "description":"Group of the logger",
    "type":"string"
}

Nested Schema : level

log level

Match All

log level

Show Source

• string
  Allowed Values: [ "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/LevelEnum"
        }
    ],
    "description":"log level",
    "type":"string"
}

Nested Schema : subgroup

Sub Group of the logger

Match All

Sub Group of the logger

Show Source

• string
  Allowed Values: [ "API", "CONTROLLER", "INSTANCE", "HSM", "CONFIG_MGR", "METRICS", "SERVER", "CDI" ]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SubgroupEnum"
        }
    ],
    "description":"Sub Group of the logger",
    "type":"string"
}

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