Jump to

• Request
• Response

Retrieve one config element: SD.steering-pool-ip-list

get

https://cloud-native-SBC-IP/config/v1/sd/steering-pool-ip-list/{ElementKey}

Retrieve one config element: SD.steering-pool-ip-list

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

Body ()

Root Schema : schema

Type: object

Create an IP address list that will be referenced in a steering-pool

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• identifier(required): string
  Minimum Length: 1

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

  Name of steering pool IP list
• ip-addr-list(required): array ip-addr-list
  Minimum Number of Items: 1

  List of media IP addresses for the steering pool
• service-network-id(required): string
  Minimum Length: 1

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

  name of service network this pool is used for

{
    "required":[
        "identifier",
        "ip-addr-list",
        "service-network-id"
    ],
    "properties":{
        "identifier":{
            "description":"Name of steering pool IP list",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "ip-addr-list":{
            "description":"List of media IP addresses for the steering pool",
            "items":{
                "type":"string"
            },
            "minItems":1,
            "type":"array"
        },
        "service-network-id":{
            "description":"name of service network this pool is used for",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"Create an IP address list that will be referenced in a steering-pool",
    "type":"object"
}

Nested Schema : ip-addr-list

Type: array

Minimum Number of Items: 1

List of media IP addresses for the steering pool

Show Source

• Array of: string

{
    "description":"List of media IP addresses for the steering pool",
    "items":{
        "type":"string"
    },
    "minItems":1,
    "type":"array"
}

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