Jump to

• Request
• Response

Retrieve the config element: SD.http-config

get

https://cloud-native-SBC-IP/config/v1/sd/http-config

Retrieve the config element: SD.http-config

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

Body ()

Root Schema : schema

Type: object

modifying tcp Connections settings

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• exclusive-http-client-port-range: boolean
  Enable for active and standby signaling pods to use different Http Client Port Range
• httpclient-cache-size-multiplier: integer (int32)
  Minimum Value: 4

  Maximum Value: 50

  connection cache multiplier value
• httpclient-max-cpu-load: integer (int32)
  Minimum Value: 30

  Maximum Value: 90

  The maximum CPU percentage allowed before the HTTP client starts discarding HTTP/HTTPS requests.
• httpclient-max-total-conn: integer (int64)
  Minimum Value: 0

  Maximum Value: 2147483647

  The maximum TCP connections is the lower of the configured value or 50% of available file descriptors. Set to 0 to disable the limit. Consider existing connections when changing configuration.

{
    "properties":{
        "httpclient-max-total-conn":{
            "description":"The maximum TCP connections is the lower of the configured value or 50% of available file descriptors. Set to 0 to disable the limit. Consider existing connections when changing configuration.",
            "format":"int64",
            "maximum":2147483647,
            "minimum":0,
            "type":"integer"
        },
        "httpclient-max-cpu-load":{
            "description":"The maximum CPU percentage allowed before the HTTP client starts discarding HTTP/HTTPS requests.",
            "format":"int32",
            "maximum":90,
            "minimum":30,
            "type":"integer"
        },
        "httpclient-cache-size-multiplier":{
            "description":"connection cache multiplier value",
            "format":"int32",
            "maximum":50,
            "minimum":4,
            "type":"integer"
        },
        "exclusive-http-client-port-range":{
            "description":"Enable for active and standby signaling pods to use different Http Client Port Range",
            "type":"boolean"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"modifying tcp Connections settings",
    "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