Jump to

• Request
• Response

Get All Peer Nodes

get

ss/oc-cnpolicy-configuration/v1/diameter/peernodes/export

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object PeerNodeIEData
  Title: PeerNodeIEData

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PeerNodeIEData"
    }
}

Nested Schema : PeerNodeIEData

Type: object

Title: PeerNodeIEData

Show Source

• date(optional): string
• exportData: array exportData
• key(optional): string
• sourceVersion(optional): string
• topic: string

{
    "type":"object",
    "required":[
        "exportData",
        "topic"
    ],
    "properties":{
        "date":{
            "type":"string"
        },
        "exportData":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PeerNode"
            }
        },
        "key":{
            "type":"string"
        },
        "sourceVersion":{
            "type":"string"
        },
        "topic":{
            "type":"string"
        }
    },
    "title":"PeerNodeIEData"
}

Nested Schema : exportData

Type: array

Show Source

• Array of: object PeerNode
  Title: PeerNode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PeerNode"
    }
}

Nested Schema : PeerNode

Type: object

Title: PeerNode

Show Source

• diamName: string
• dtype: string
  Allowed Values: [ "af", "backend", "dra", "ocs", "pcf", "tdf", "udr" ]
• host(optional): string
  enter a FQDN, ipv4 or ipv6 address'.
• identity(optional): string
  Enter valid FQDN.
• initiateConnection: boolean
• port(optional): string
  Enter a range in [0-65535].

  Example: 3868
• realm(optional): string
  Enter valid FQDN.
• reconnectLimit(optional): string
  enter number of seconds.

  Example: 3

{
    "type":"object",
    "required":[
        "diamName",
        "dtype",
        "initiateConnection"
    ],
    "properties":{
        "diamName":{
            "type":"string"
        },
        "dtype":{
            "type":"string",
            "enum":[
                "af",
                "backend",
                "dra",
                "ocs",
                "pcf",
                "tdf",
                "udr"
            ]
        },
        "host":{
            "type":"string",
            "description":"enter a FQDN, ipv4 or ipv6 address'."
        },
        "identity":{
            "type":"string",
            "description":"Enter valid FQDN."
        },
        "initiateConnection":{
            "type":"boolean"
        },
        "port":{
            "type":"string",
            "example":3868,
            "description":"Enter a range in [0-65535]."
        },
        "realm":{
            "type":"string",
            "description":"Enter valid FQDN."
        },
        "reconnectLimit":{
            "type":"string",
            "example":3,
            "description":"enter number of seconds."
        }
    },
    "title":"PeerNode"
}

400 Response

Bad request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found

429 Response

Too Many Requests

500 Response

Internal Server Error

503 Response

Service Unavailable

Back to Top