Triggers

Description

Trigger APIs

DEFAULT

DELETE ``/api/v2/analytics/configuration/ruledef/{trigger-name}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

trigger-name

path

Yes

string

Generated path parameter. Example value =’trigger1’

Request

Headers

x-account: Generated header parameter. Example value ='a23da25e-c0cc-11ea-9866-26b621aa8d0e'
authorization: Generated header parameter. Example value ='Session 2fc0b924-e14a-4850-9d7c-50f6c793d9f3'

Responses

202

GET ``/api/v2/analytics/configuration/metricscategory``

Request

Headers

x-account: Generated header parameter. Example value ='a23da25e-c0cc-11ea-9866-26b621aa8d0e'
authorization: Generated header parameter. Example value ='Session 53a1e8e3-ec79-4ea4-ab71-15362f5176f7'

Responses

200

Type: MetricscategoryResponse

Example:

{
    "mainCategory": "somestring",
    "metricsType": "somestring",
    "objectType": "somestring",
    "subCategory": "somestring"
}

GET ``/api/v2/analytics/configuration/ruledef``

Request

Headers

x-account: Generated header parameter. Example value ='a23da25e-c0cc-11ea-9866-26b621aa8d0e'
authorization: Generated header parameter. Example value ='Session 53a1e8e3-ec79-4ea4-ab71-15362f5176f7'

Responses

200

Type: array of TenantTriggersList

Example:

[
    {
        "account_id": "somestring",
        "created_on": "somestring",
        "def_id": "somestring",
        "def_name": "somestring",
        "definition": {
            "category": "somestring",
            "conditions": {
                "and": [
                    {
                        "aggregation": "somestring",
                        "operator": "somestring",
                        "params": [
                            "somestring",
                            "somestring"
                        ],
                        "value": 1
                    },
                    {
                        "aggregation": "somestring",
                        "operator": "somestring",
                        "params": [
                            "somestring",
                            "somestring"
                        ],
                        "value": 1
                    }
                ]
            },
            "default_headers": {
                "account_id": "somestring",
                "app_svc_id": "somestring",
                "app_svc_type": "somestring",
                "cluster_id": "somestring",
                "device_uuid": "somestring",
                "h_ver": "somestring",
                "o_ha_state": "somestring",
                "o_oper_state": "somestring",
                "o_uuid": "somestring",
                "p_id": "somestring",
                "p_ver": "somestring"
            },
            "metric_data_type": "somestring",
            "metric_type": "somestring",
            "object_type": "somestring",
            "sub-category": "somestring",
            "trigger_message": "somestring",
            "window": {
                "params": [
                    "somestring",
                    "somestring"
                ],
                "type": "somestring"
            }
        },
        "name": "somestring"
    },
    {
        "account_id": "somestring",
        "created_on": "somestring",
        "def_id": "somestring",
        "def_name": "somestring",
        "definition": {
            "category": "somestring",
            "conditions": {
                "and": [
                    {
                        "aggregation": "somestring",
                        "operator": "somestring",
                        "params": [
                            "somestring",
                            "somestring"
                        ],
                        "value": 1
                    },
                    {
                        "aggregation": "somestring",
                        "operator": "somestring",
                        "params": [
                            "somestring",
                            "somestring"
                        ],
                        "value": 1
                    }
                ]
            },
            "default_headers": {
                "account_id": "somestring",
                "app_svc_id": "somestring",
                "app_svc_type": "somestring",
                "cluster_id": "somestring",
                "device_uuid": "somestring",
                "h_ver": "somestring",
                "o_ha_state": "somestring",
                "o_oper_state": "somestring",
                "o_uuid": "somestring",
                "p_id": "somestring",
                "p_ver": "somestring"
            },
            "metric_data_type": "somestring",
            "metric_type": "somestring",
            "object_type": "somestring",
            "sub-category": "somestring",
            "trigger_message": "somestring",
            "window": {
                "params": [
                    "somestring",
                    "somestring"
                ],
                "type": "somestring"
            }
        },
        "name": "somestring"
    }
]

GET ``/api/v2/analytics/configuration/ruledef/hc_canned_rules``

Request

Headers

x-account: Generated header parameter. Example value ='a23da25e-c0cc-11ea-9866-26b621aa8d0e'
authorization: Generated header parameter. Example value ='Session 53a1e8e3-ec79-4ea4-ab71-15362f5176f7'

Responses

200

Type: array of TenantTriggersList

Example:

[
    {
        "account_id": "somestring",
        "created_on": "somestring",
        "def_id": "somestring",
        "def_name": "somestring",
        "definition": {
            "category": "somestring",
            "conditions": {
                "and": [
                    {
                        "aggregation": "somestring",
                        "operator": "somestring",
                        "params": [
                            "somestring",
                            "somestring"
                        ],
                        "value": 1
                    },
                    {
                        "aggregation": "somestring",
                        "operator": "somestring",
                        "params": [
                            "somestring",
                            "somestring"
                        ],
                        "value": 1
                    }
                ]
            },
            "default_headers": {
                "account_id": "somestring",
                "app_svc_id": "somestring",
                "app_svc_type": "somestring",
                "cluster_id": "somestring",
                "device_uuid": "somestring",
                "h_ver": "somestring",
                "o_ha_state": "somestring",
                "o_oper_state": "somestring",
                "o_uuid": "somestring",
                "p_id": "somestring",
                "p_ver": "somestring"
            },
            "metric_data_type": "somestring",
            "metric_type": "somestring",
            "object_type": "somestring",
            "sub-category": "somestring",
            "trigger_message": "somestring",
            "window": {
                "params": [
                    "somestring",
                    "somestring"
                ],
                "type": "somestring"
            }
        },
        "name": "somestring"
    },
    {
        "account_id": "somestring",
        "created_on": "somestring",
        "def_id": "somestring",
        "def_name": "somestring",
        "definition": {
            "category": "somestring",
            "conditions": {
                "and": [
                    {
                        "aggregation": "somestring",
                        "operator": "somestring",
                        "params": [
                            "somestring",
                            "somestring"
                        ],
                        "value": 1
                    },
                    {
                        "aggregation": "somestring",
                        "operator": "somestring",
                        "params": [
                            "somestring",
                            "somestring"
                        ],
                        "value": 1
                    }
                ]
            },
            "default_headers": {
                "account_id": "somestring",
                "app_svc_id": "somestring",
                "app_svc_type": "somestring",
                "cluster_id": "somestring",
                "device_uuid": "somestring",
                "h_ver": "somestring",
                "o_ha_state": "somestring",
                "o_oper_state": "somestring",
                "o_uuid": "somestring",
                "p_id": "somestring",
                "p_ver": "somestring"
            },
            "metric_data_type": "somestring",
            "metric_type": "somestring",
            "object_type": "somestring",
            "sub-category": "somestring",
            "trigger_message": "somestring",
            "window": {
                "params": [
                    "somestring",
                    "somestring"
                ],
                "type": "somestring"
            }
        },
        "name": "somestring"
    }
]

GET ``/api/v2/schema-registry/subjects/system_session/versions/1``

Request

Headers

x-account: Generated header parameter. Example value ='a23da25e-c0cc-11ea-9866-26b621aa8d0e'
authorization: Generated header parameter. Example value ='Session 53a1e8e3-ec79-4ea4-ab71-15362f5176f7'

Responses

200

POST ``/api/v2/analytics/configuration/ruledef``

Request

Headers

x-account: Generated header parameter. Example value ='a23da25e-c0cc-11ea-9866-26b621aa8d0e'
authorization: Generated header parameter. Example value ='Session 53a1e8e3-ec79-4ea4-ab71-15362f5176f7'

Body

Name

Required

Type

Format

Properties

Description

account_id

No

string

def_name

No

string

definition

No

Definition

filter

No

Filter

type

No

string

{
    "account_id": "somestring",
    "def_name": "somestring",
    "definition": {
        "category": "somestring",
        "conditions": {
            "and": [
                {
                    "aggregation": "somestring",
                    "operator": "somestring",
                    "params": [
                        "somestring",
                        "somestring"
                    ],
                    "value": 1
                },
                {
                    "aggregation": "somestring",
                    "operator": "somestring",
                    "params": [
                        "somestring",
                        "somestring"
                    ],
                    "value": 1
                }
            ]
        },
        "default_headers": {
            "account_id": "somestring",
            "app_svc_id": "somestring",
            "app_svc_type": "somestring",
            "cluster_id": "somestring",
            "device_uuid": "somestring",
            "h_ver": "somestring",
            "o_ha_state": "somestring",
            "o_oper_state": "somestring",
            "o_uuid": "somestring",
            "p_id": "somestring",
            "p_ver": "somestring"
        },
        "metric_data_type": "somestring",
        "metric_type": "somestring",
        "object_type": "somestring",
        "sub-category": "somestring",
        "trigger_message": "somestring",
        "window": {
            "params": [
                "somestring",
                "somestring"
            ],
            "type": "somestring"
        }
    },
    "filter": {
        "account_id": "somestring"
    },
    "type": "somestring"
}

Responses

200

Type: CreateTriggerResponse

Example:

{
    "account_id": "somestring",
    "created_on": "somestring",
    "def_id": "somestring",
    "def_name": "somestring",
    "definition": {
        "category": "somestring",
        "conditions": {
            "and": [
                {
                    "aggregation": "somestring",
                    "operator": "somestring",
                    "params": [
                        "somestring",
                        "somestring"
                    ],
                    "value": 1
                },
                {
                    "aggregation": "somestring",
                    "operator": "somestring",
                    "params": [
                        "somestring",
                        "somestring"
                    ],
                    "value": 1
                }
            ]
        },
        "default_headers": {
            "account_id": "somestring",
            "app_svc_id": "somestring",
            "app_svc_type": "somestring",
            "cluster_id": "somestring",
            "device_uuid": "somestring",
            "h_ver": "somestring",
            "o_ha_state": "somestring",
            "o_oper_state": "somestring",
            "o_uuid": "somestring",
            "p_id": "somestring",
            "p_ver": "somestring"
        },
        "metric_data_type": "somestring",
        "metric_type": "somestring",
        "object_type": "somestring",
        "sub-category": "somestring",
        "trigger_message": "somestring",
        "window": {
            "params": [
                "somestring",
                "somestring"
            ],
            "type": "somestring"
        }
    },
    "name": "somestring",
    "type": "somestring"
}

Data Structures

And Model Structure

Name

Required

Type

Format

Properties

Description

aggregation

No

string

operator

No

string

params

No

array of string

value

No

integer

int32

Conditions Model Structure

Name

Required

Type

Format

Properties

Description

and

No

array of And

Create Trigger Request Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

def_name

No

string

definition

No

Definition

filter

No

Filter

type

No

string

Create Trigger Response Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

created_on

No

string

def_id

No

string

def_name

No

string

definition

No

TriggerResponseDefinition

name

No

string

type

No

string

Default Headers Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

app_svc_id

No

string

app_svc_type

No

string

cluster_id

No

string

device_uuid

No

string

h_ver

No

string

o_ha_state

No

string

o_oper_state

No

string

o_uuid

No

string

p_id

No

string

p_ver

No

string

Definition Model Structure

Name

Required

Type

Format

Properties

Description

category

No

string

conditions

No

Conditions

default_headers

No

Default_headers

metric_data_type

No

string

metric_type

No

string

object_type

No

string

sub-category

No

string

trigger_message

No

string

window

No

Window

Filter Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

Metrics Category Response Model Structure

Name

Required

Type

Format

Properties

Description

mainCategory

No

string

metricsType

No

string

objectType

No

string

subCategory

No

string

Tenant Trigger Definition Model Structure

Name

Required

Type

Format

Properties

Description

category

No

string

conditions

No

TenantTriggerDefinitionConditions

default_headers

No

TenantTriggerDefinitionDefaultHeaders

metric_data_type

No

string

metric_type

No

string

object_type

No

string

sub-category

No

string

trigger_message

No

string

window

No

TenantTriggerDefinitionWindow

Tenant Trigger Definition Conditions Model Structure

Name

Required

Type

Format

Properties

Description

and

No

array of TenantTriggerDefinitionConditionsAnd

Tenant Trigger Definition Conditions And Model Structure

Name

Required

Type

Format

Properties

Description

aggregation

No

string

operator

No

string

params

No

array of string

value

No

integer

int32

Tenant Trigger Definition Default Headers Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

app_svc_id

No

string

app_svc_type

No

string

cluster_id

No

string

device_uuid

No

string

h_ver

No

string

o_ha_state

No

string

o_oper_state

No

string

o_uuid

No

string

p_id

No

string

p_ver

No

string

Tenant Trigger Definition Window Model Structure

Name

Required

Type

Format

Properties

Description

params

No

array of string

type

No

string

Tenant Triggers List Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

created_on

No

string

def_id

No

string

def_name

No

string

definition

No

TenantTriggerDefinition

name

No

string

Trigger Response Definition Model Structure

Name

Required

Type

Format

Properties

Description

category

No

string

conditions

No

TriggerResponseDefinitionConditions

default_headers

No

TriggerResponseDefinitionDefaultHeaders

metric_data_type

No

string

metric_type

No

string

object_type

No

string

sub-category

No

string

trigger_message

No

string

window

No

TriggerResponseDefinitionWindow

Trigger Response Definition Conditions Model Structure

Name

Required

Type

Format

Properties

Description

and

No

array of TriggerResponseDefinitionConditionsAnd

Trigger Response Definition Conditions And Model Structure

Name

Required

Type

Format

Properties

Description

aggregation

No

string

operator

No

string

params

No

array of string

value

No

integer

int32

Trigger Response Definition Default Headers Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

app_svc_id

No

string

app_svc_type

No

string

cluster_id

No

string

device_uuid

No

string

h_ver

No

string

o_ha_state

No

string

o_oper_state

No

string

o_uuid

No

string

p_id

No

string

p_ver

No

string

Trigger Response Definition Window Model Structure

Name

Required

Type

Format

Properties

Description

params

No

array of string

type

No

string

Window Model Structure

Name

Required

Type

Format

Properties

Description

params

No

array of string

type

No

string