[Index]
NetflowDruidNetflow resource. The schema will be used to create data/ReporterResource instances, the description is used to store the table name of the associate field.
Model ref.: data/NetflowDruidNetflow
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"AGENTID": {
"title": "Agent ID",
"description": "netflow",
"type": "string"
},
"VERSION": {
"title": "Version",
"description": "netflow",
"type": "string"
},
"PROTOCOLIDENTIFIER": {
"title": "Protocol Identifier",
"description": "netflow",
"type": "string"
},
"IPCLASSOFSERVICE": {
"title": "IP Class of Service",
"description": "netflow",
"type": "string"
},
"TCPCONTROLBITS": {
"title": "TCP Control Bits",
"description": "netflow",
"type": "string"
},
"SOURCETRANSPORTPORT": {
"title": "Source Transport Port",
"description": "netflow",
"type": "string"
},
"SOURCEIPV4ADDRESS": {
"title": "Source IPv4 Address",
"description": "netflow",
"type": "string"
},
"SOURCEIPV4PREFIXLENGTH": {
"title": "Source IPv4 Prefix Length",
"description": "netflow",
"type": "string"
},
"INGRESSINTERFACE": {
"title": "Ingress Interface",
"description": "netflow",
"type": "string"
},
"DESTINATIONTRANSPORTPORT": {
"title": "Destination Transport Port",
"description": "netflow",
"type": "string"
},
"DESTINATIONIPV4ADDRESS": {
"title": "Destination IPv4 Address",
"description": "netflow",
"type": "string"
},
"DESTINATIONIPV4PREFIXLENGTH": {
"title": "Destination IPv4 Prefix Length",
"description": "netflow",
"type": "string"
},
"EGRESSINTERFACE": {
"title": "Egress Interface",
"description": "netflow",
"type": "string"
},
"IPNEXTHOPIPV4ADDRESS": {
"title": "IP Next Hop IPv4 Address",
"description": "netflow",
"type": "string"
},
"BGPSOURCEASNUMBER": {
"title": "BGP Source AS Number",
"description": "netflow",
"type": "number"
},
"BGPDESTINATIONASNUMBER": {
"title": "BGP Destination AS Number",
"description": "netflow",
"type": "number"
},
"INPUT_INTERFACE": {
"title": "Input Interface",
"description": "netflow",
"type": "string"
},
"OUTPUT_INTERFACE": {
"title": "Output Interface",
"description": "netflow",
"type": "string"
},
"DIRECTION": {
"title": "Direction",
"description": "netflow",
"type": "string"
},
"ENRICHED_DEST_CITY": {
"title": "Enriched Destination City",
"description": "netflow",
"type": "string"
},
"ENRICHED_DEST_COUNTRY": {
"title": "Enriched Destination Country",
"description": "netflow",
"type": "string"
},
"ENRICHED_SRC_CITY": {
"title": "Enriched Source City",
"description": "netflow",
"type": "string"
},
"ENRICHED_SRC_COUNTRY": {
"title": "Enriched Source Country",
"description": "netflow",
"type": "string"
},
"SRC_HOSTNAME": {
"title": "Source Hostname",
"description": "netflow",
"type": "string"
},
"DST_HOSTNAME": {
"title": "Destination Hostname",
"description": "netflow",
"type": "string"
},
"APPLICATIONDESCRIPTION": {
"title": "Application Description",
"description": "netflow",
"type": "string"
},
"APPLICATIONID": {
"title": "Application ID",
"description": "netflow",
"type": "string"
},
"APPLICATIONNAME": {
"title": "Application Name",
"description": "netflow",
"type": "string"
},
"count": {
"title": "Count",
"description": "netflow",
"type": "number"
},
"TOTALBYTES_METRIC_SUM": {
"title": "Total Bytes Metric Sum",
"description": "netflow",
"type": "number"
},
"TOTALPACKETS_METRIC_SUM": {
"title": "Total Packets Metric Sum",
"description": "netflow",
"type": "number"
},
"DURATION_METRIC_SUM": {
"title": "Duration Metric Sum",
"description": "netflow",
"type": "number"
},
"FLOW_METRIC_SUM": {
"title": "Flow Metric Sum",
"description": "netflow",
"type": "number"
}
},
"schema_version": "0.1"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/NetflowDruidNetflow/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/NetflowDruidNetflow/[pkid1]", "/api/data/NetflowDruidNetflow/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/NetflowDruidNetflow/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/NetflowDruidNetflow/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/NetflowDruidNetflow/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/NetflowDruidNetflow/ |
|
The data/NetflowDruidNetflow schema and all instances as JSON. |
(The list will return 0 to 3 data/NetflowDruidNetflow instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "AGENTID",
"direction": "asc",
"current": "/api/data/NetflowDruidNetflow/?skip=0&limit=3&order_by=AGENTID&direction=asc&traversal=fulltree"
},
"operations": [
"export",
"help",
"update",
"migration",
"get",
"list",
"remove",
"move",
"configuration_template",
"add",
"export_bulkload_template",
"transform",
"bulk_update_form",
"field_display_policy"
],
"meta": {
"model_type": "data/NetflowDruidNetflow",
"summary_attrs": [
{
"name": "AGENTID",
"title": "Agent ID"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"field_display_policy",
"get",
"help",
"list",
"migration",
"transform",
"remove"
],
"schema_version": "0.1",
"actions": [
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/NetflowDruidNetflow/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/NetflowDruidNetflow/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/data/NetflowDruidNetflow/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/NetflowDruidNetflow/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/NetflowDruidNetflow/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/data/NetflowDruidNetflow/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/NetflowDruidNetflow. | GET | /api/data/NetflowDruidNetflow/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/NetflowDruidNetflow as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/data/NetflowDruidNetflow/transform/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/NetflowDruidNetflow/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/NetflowDruidNetflow/[pkid] | hierarchy=[hierarchy] | The data/NetflowDruidNetflow instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/NetflowDruidNetflow/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/NetflowDruidNetflow. |