Jump to

• Request
• Response

Replace a config element: SD.te-steering-pool-ip-list

put

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

Replace a config element: SD.te-steering-pool-ip-list

Request

Path Parameters

• ElementKey: string
  Identifier for the element

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

The Transcode Engine Steering Pool IP List creates steering pool IP list at the Transcode Engine

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: array ip-addr-list
  Add HIP IP address list To add a list with multiple entries, surround the entries with () and seperated with comma eg.: (IP1,IP2) To add list elements, use '+'to add and '-' to remove, excluding '+', '-' will replace the list eg.: (+IP1,-IP2)
• 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",
        "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":"Add HIP IP address list To add a list with multiple entries, surround the entries with () and seperated with comma eg.: (IP1,IP2) To add list elements, use '+'to add and '-' to remove, excluding '+', '-' will replace the list eg.: (+IP1,-IP2)",
            "items":{
                "type":"string"
            },
            "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":"The Transcode Engine Steering Pool IP List creates steering pool IP list at the Transcode Engine",
    "type":"object"
}

Nested Schema : ip-addr-list

Type: array

Add HIP IP address list To add a list with multiple entries, surround the entries with () and seperated with comma eg.: (IP1,IP2) To add list elements, use '+'to add and '-' to remove, excluding '+', '-' will replace the list eg.: (+IP1,-IP2)

Show Source

• Array of: string

{
    "description":"Add HIP IP address list To add a list with multiple entries, surround the entries with () and seperated with comma eg.: (IP1,IP2) To add list elements, use '+'to add and '-' to remove, excluding '+', '-' will replace the list eg.: (+IP1,-IP2)",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: TeSteeringPoolIpList

Body ()

Root Schema : schema

Type: object

The Transcode Engine Steering Pool IP List creates steering pool IP list at the Transcode Engine

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: array ip-addr-list
  Add HIP IP address list To add a list with multiple entries, surround the entries with () and seperated with comma eg.: (IP1,IP2) To add list elements, use '+'to add and '-' to remove, excluding '+', '-' will replace the list eg.: (+IP1,-IP2)
• 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",
        "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":"Add HIP IP address list To add a list with multiple entries, surround the entries with () and seperated with comma eg.: (IP1,IP2) To add list elements, use '+'to add and '-' to remove, excluding '+', '-' will replace the list eg.: (+IP1,-IP2)",
            "items":{
                "type":"string"
            },
            "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":"The Transcode Engine Steering Pool IP List creates steering pool IP list at the Transcode Engine",
    "type":"object"
}

Nested Schema : ip-addr-list

Type: array

Add HIP IP address list To add a list with multiple entries, surround the entries with () and seperated with comma eg.: (IP1,IP2) To add list elements, use '+'to add and '-' to remove, excluding '+', '-' will replace the list eg.: (+IP1,-IP2)

Show Source

• Array of: string

{
    "description":"Add HIP IP address list To add a list with multiple entries, surround the entries with () and seperated with comma eg.: (IP1,IP2) To add list elements, use '+'to add and '-' to remove, excluding '+', '-' will replace the list eg.: (+IP1,-IP2)",
    "items":{
        "type":"string"
    },
    "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"
}

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