REST API for Oracle Digital Experience for Communications Industry Fabric

Get all endpoint rules

get

/admin/endpointRules

Request

There are no request parameters for this operation.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: array

Show Source

Array of: object EndpointRule

{
    "items":{
        "$ref":"#/components/schemas/EndpointRule"
    }
}

Nested Schema : EndpointRule

Type: object

Show Source

host: string
id: string
outlier-detection: object outlier-detection

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "host":{
            "type":"string",
            "nullable":false
        },
        "outlier-detection":{
            "type":"object",
            "properties":{
                "consecutive-5xx-errors":{
                    "description":"This field captures the number of consecutive 5xx HTTP responses received \nfrom a host before it is considered an outlier and is ejected from the pool \nof available hosts.\n",
                    "type":"number",
                    "minimum":1,
                    "multipleOf":1
                },
                "interval":{
                    "description":"This field captures the amount of time during which consecutive 5xx errors are counted. \nFor example, if the interval is set to \"30s\", then any consecutive 5xx errors received \nfrom a host within 30 seconds will be counted towards its ejection.\n",
                    "type":"string",
                    "pattern":"^([1-9]\\d*h)?([1-9]\\d*m)?([1-9]\\d*s)?$",
                    "example":"30m"
                },
                "base-ejection-time":{
                    "description":"This field captures the amount of time for which a host should be ejected \nfrom the pool of available hosts once it has been identified as an outlier. \nThe value of this field is multiplied by the number of consecutive 5xx errors \nto calculate the total ejection time.\n",
                    "type":"string",
                    "pattern":"^([1-9]\\d*h)?([1-9]\\d*m)?([1-9]\\d*s)?$",
                    "example":"10s"
                }
            },
            "oneOf":[
                {
                    "required":[
                        "consecutive-5xx-errors",
                        "interval",
                        "base-ejection-time"
                    ]
                }
            ]
        }
    },
    "oneOf":[
        {
            "required":[
                "host",
                "outlier-detection"
            ]
        }
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "host":{
            "type":"string",
            "nullable":false
        },
        "outlier-detection":{
            "type":"object",
            "properties":{
                "consecutive-5xx-errors":{
                    "description":"This field captures the number of consecutive 5xx HTTP responses received \nfrom a host before it is considered an outlier and is ejected from the pool \nof available hosts.\n",
                    "type":"number",
                    "minimum":1,
                    "multipleOf":1
                },
                "interval":{
                    "description":"This field captures the amount of time during which consecutive 5xx errors are counted. \nFor example, if the interval is set to \"30s\", then any consecutive 5xx errors received \nfrom a host within 30 seconds will be counted towards its ejection.\n",
                    "type":"string",
                    "pattern":"^([1-9]\\d*h)?([1-9]\\d*m)?([1-9]\\d*s)?$",
                    "example":"30m"
                },
                "base-ejection-time":{
                    "description":"This field captures the amount of time for which a host should be ejected \nfrom the pool of available hosts once it has been identified as an outlier. \nThe value of this field is multiplied by the number of consecutive 5xx errors \nto calculate the total ejection time.\n",
                    "type":"string",
                    "pattern":"^([1-9]\\d*h)?([1-9]\\d*m)?([1-9]\\d*s)?$",
                    "example":"10s"
                }
            },
            "oneOf":[
                {
                    "required":[
                        "consecutive-5xx-errors",
                        "interval",
                        "base-ejection-time"
                    ]
                }
            ]
        }
    },
    "oneOf":[
        {
            "required":[
                "host",
                "outlier-detection"
            ]
        }
    ]
}

Nested Schema : outlier-detection

Type: object

Show Source

base-ejection-time: string

Pattern: ^([1-9]\d*h)?([1-9]\d*m)?([1-9]\d*s)?$

This field captures the amount of time for which a host should be ejected from the pool of available hosts once it has been identified as an outlier. The value of this field is multiplied by the number of consecutive 5xx errors to calculate the total ejection time.

Example: 10s
consecutive-5xx-errors: number

Minimum Value: 1

Multiple Of: 1

This field captures the number of consecutive 5xx HTTP responses received from a host before it is considered an outlier and is ejected from the pool of available hosts.
interval: string

Pattern: ^([1-9]\d*h)?([1-9]\d*m)?([1-9]\d*s)?$

This field captures the amount of time during which consecutive 5xx errors are counted. For example, if the interval is set to "30s", then any consecutive 5xx errors received from a host within 30 seconds will be counted towards its ejection.

Example: 30m

{
    "type":"object",
    "properties":{
        "consecutive-5xx-errors":{
            "description":"This field captures the number of consecutive 5xx HTTP responses received \nfrom a host before it is considered an outlier and is ejected from the pool \nof available hosts.\n",
            "type":"number",
            "minimum":1,
            "multipleOf":1
        },
        "interval":{
            "description":"This field captures the amount of time during which consecutive 5xx errors are counted. \nFor example, if the interval is set to \"30s\", then any consecutive 5xx errors received \nfrom a host within 30 seconds will be counted towards its ejection.\n",
            "type":"string",
            "pattern":"^([1-9]\\d*h)?([1-9]\\d*m)?([1-9]\\d*s)?$",
            "example":"30m"
        },
        "base-ejection-time":{
            "description":"This field captures the amount of time for which a host should be ejected \nfrom the pool of available hosts once it has been identified as an outlier. \nThe value of this field is multiplied by the number of consecutive 5xx errors \nto calculate the total ejection time.\n",
            "type":"string",
            "pattern":"^([1-9]\\d*h)?([1-9]\\d*m)?([1-9]\\d*s)?$",
            "example":"10s"
        }
    },
    "oneOf":[
        {
            "required":[
                "consecutive-5xx-errors",
                "interval",
                "base-ejection-time"
            ]
        }
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "properties":{
        "consecutive-5xx-errors":{
            "description":"This field captures the number of consecutive 5xx HTTP responses received \nfrom a host before it is considered an outlier and is ejected from the pool \nof available hosts.\n",
            "type":"number",
            "minimum":1,
            "multipleOf":1
        },
        "interval":{
            "description":"This field captures the amount of time during which consecutive 5xx errors are counted. \nFor example, if the interval is set to \"30s\", then any consecutive 5xx errors received \nfrom a host within 30 seconds will be counted towards its ejection.\n",
            "type":"string",
            "pattern":"^([1-9]\\d*h)?([1-9]\\d*m)?([1-9]\\d*s)?$",
            "example":"30m"
        },
        "base-ejection-time":{
            "description":"This field captures the amount of time for which a host should be ejected \nfrom the pool of available hosts once it has been identified as an outlier. \nThe value of this field is multiplied by the number of consecutive 5xx errors \nto calculate the total ejection time.\n",
            "type":"string",
            "pattern":"^([1-9]\\d*h)?([1-9]\\d*m)?([1-9]\\d*s)?$",
            "example":"10s"
        }
    },
    "oneOf":[
        {
            "required":[
                "consecutive-5xx-errors",
                "interval",
                "base-ejection-time"
            ]
        }
    ]
}

400 Response

Bad Request

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): string

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

401 Response

Unauthorized

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): string

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

403 Response

Forbidden

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): string

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

404 Response

Not Found

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): string

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

500 Response

Internal Server Error

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

@baseType: string

When sub-classing, this defines the super-class.
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class entity name.
code(required): string

Application relevant detail, defined in the API or a common list.
message: string

More details and corrective actions related to the error which can be shown to a client user.
reason(required): string

Explanation of the reason for the error which can be shown to a client user.
referenceError: string (uri)

URI of documentation describing the error.
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

Examples

The following example shows how to get all endpoint rules by submitting a get request on the REST resource using cURL.

cURL Command

curl --<username:password> --request GET '{FABRIC_HOST}/admin/endpointRules' --header 'Authorization: Bearer <accessToken> --header 'Content-Type: application/json'

Example of Response Body

The following shows an example of the response body in JSON format.

[
    {
        "host": "fa-wrpv-pintlabfadev.fa.ocs.oc-test.com",
        "outlier-detection": {
            "consecutive-5xx-errors": 5,
            "interval": "30s",
            "base-ejection-time": "60s"
        },
        "id": "fa-wrpv-pintlabfadev-fa-ocs-oc-test-com"
    },
    {
        "host": "oracle2.ad2.fusionappsdphx1.oraclevcn.com",
        "outlier-detection": {
            "consecutive-5xx-errors": 5,
            "interval": "30s",
            "base-ejection-time": "60s"
        },
        "id": "oracle2-ad2-fusionappsdphx1-oraclevcn-comwp47m"
    }
]