Avi VSDataScriptSet Object API

CLI ``` - configure vsdatascriptset - show vsdatascriptset ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 20.1.2
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /vsdatascriptset
  2. post /vsdatascriptset
  3. delete /vsdatascriptset/{uuid}
  4. get /vsdatascriptset/{uuid}
  5. patch /vsdatascriptset/{uuid}
  6. put /vsdatascriptset/{uuid}
Up
get /vsdatascriptset
(vsdatascriptsetGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

VSDataScriptSetApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "pool_refs" : [ "aeiou" ],
    "string_group_refs" : [ "aeiou" ],
    "description" : "aeiou",
    "created_by" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "labels" : [ {
      "value" : "aeiou",
      "key" : "aeiou"
    } ],
    "protocol_parser_refs" : [ "aeiou" ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "rate_limiters" : [ {
      "period" : 123,
      "count" : 123,
      "name" : "aeiou",
      "burst_sz" : 123
    } ],
    "pool_group_refs" : [ "aeiou" ],
    "ipgroup_refs" : [ "aeiou" ],
    "datascript" : [ {
      "evt" : "aeiou",
      "script" : "aeiou"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VSDataScriptSetApiResponse

401

log in failed

Up
post /vsdatascriptset
(vsdatascriptsetPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — VSDataScriptSet object creation

Return type

VSDataScriptSet

Example data

Content-Type: application/json
{
  "pool_refs" : [ "aeiou" ],
  "string_group_refs" : [ "aeiou" ],
  "description" : "aeiou",
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "protocol_parser_refs" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "rate_limiters" : [ {
    "period" : 123,
    "count" : 123,
    "name" : "aeiou",
    "burst_sz" : 123
  } ],
  "pool_group_refs" : [ "aeiou" ],
  "ipgroup_refs" : [ "aeiou" ],
  "datascript" : [ {
    "evt" : "aeiou",
    "script" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VSDataScriptSet

401

log in failed

Up
delete /vsdatascriptset/{uuid}
(vsdatascriptsetUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /vsdatascriptset/{uuid}
(vsdatascriptsetUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

VSDataScriptSet

Example data

Content-Type: application/json
{
  "pool_refs" : [ "aeiou" ],
  "string_group_refs" : [ "aeiou" ],
  "description" : "aeiou",
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "protocol_parser_refs" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "rate_limiters" : [ {
    "period" : 123,
    "count" : 123,
    "name" : "aeiou",
    "burst_sz" : 123
  } ],
  "pool_group_refs" : [ "aeiou" ],
  "ipgroup_refs" : [ "aeiou" ],
  "datascript" : [ {
    "evt" : "aeiou",
    "script" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VSDataScriptSet

401

log in failed

Up
patch /vsdatascriptset/{uuid}
(vsdatascriptsetUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — VSDataScriptSet object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

VSDataScriptSet

Example data

Content-Type: application/json
{
  "pool_refs" : [ "aeiou" ],
  "string_group_refs" : [ "aeiou" ],
  "description" : "aeiou",
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "protocol_parser_refs" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "rate_limiters" : [ {
    "period" : 123,
    "count" : 123,
    "name" : "aeiou",
    "burst_sz" : 123
  } ],
  "pool_group_refs" : [ "aeiou" ],
  "ipgroup_refs" : [ "aeiou" ],
  "datascript" : [ {
    "evt" : "aeiou",
    "script" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VSDataScriptSet

401

log in failed

Up
put /vsdatascriptset/{uuid}
(vsdatascriptsetUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — VSDataScriptSet object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

VSDataScriptSet

Example data

Content-Type: application/json
{
  "pool_refs" : [ "aeiou" ],
  "string_group_refs" : [ "aeiou" ],
  "description" : "aeiou",
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "protocol_parser_refs" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "rate_limiters" : [ {
    "period" : 123,
    "count" : 123,
    "name" : "aeiou",
    "burst_sz" : 123
  } ],
  "pool_group_refs" : [ "aeiou" ],
  "ipgroup_refs" : [ "aeiou" ],
  "datascript" : [ {
    "evt" : "aeiou",
    "script" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK VSDataScriptSet

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. KeyValue
  2. RateLimiter
  3. VSDataScript
  4. VSDataScriptSet
  5. VSDataScriptSetApiResponse

KeyValue Up

key
String Key.
value (optional)
String Value.

RateLimiter Up

burst_sz (optional)
Integer Maximum number of connections, requests or packets to be let through instantaneously. If this is less than count, it will have no effect. Allowed values are 0-1000000000. Field introduced in 18.2.9. format: int32
count
Integer Maximum number of connections, requests or packets permitted each period. Allowed values are 1-1000000000. Field introduced in 18.2.9. format: int32
name (optional)
String Identifier for Rate Limit. Constructed according to context. Field introduced in 18.2.9.
period
Integer Time value in seconds to enforce rate count. Allowed values are 1-1000000000. Field introduced in 18.2.9. Unit is SEC. format: int32

VSDataScript Up

evt
String Event triggering execution of datascript. Enum options - VS_DATASCRIPT_EVT_HTTP_REQ, VS_DATASCRIPT_EVT_HTTP_RESP, VS_DATASCRIPT_EVT_HTTP_RESP_DATA, VS_DATASCRIPT_EVT_HTTP_LB_FAILED, VS_DATASCRIPT_EVT_HTTP_REQ_DATA, VS_DATASCRIPT_EVT_HTTP_RESP_FAILED, VS_DATASCRIPT_EVT_HTTP_LB_DONE, VS_DATASCRIPT_EVT_TCP_CLIENT_ACCEPT, VS_DATASCRIPT_EVT_SSL_HANDSHAKE_DONE, VS_DATASCRIPT_EVT_DNS_REQ, VS_DATASCRIPT_EVT_DNS_RESP, VS_DATASCRIPT_EVT_L4_REQUEST, VS_DATASCRIPT_EVT_L4_RESPONSE, VS_DATASCRIPT_EVT_MAX.
script
String Datascript to execute when the event triggers.

VSDataScriptSet Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
created_by (optional)
String Creator name. Field introduced in 17.1.11,17.2.4.
datascript (optional)
array[VSDataScript] DataScripts to execute.
description (optional)
String User defined description for the object.
ipgroup_refs (optional)
array[String] UUID of IP Groups that could be referred by VSDataScriptSet objects. It is a reference to an object of type IpAddrGroup.
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2.
name
String Name for the virtual service datascript collection.
pool_group_refs (optional)
array[String] UUID of pool groups that could be referred by VSDataScriptSet objects. It is a reference to an object of type PoolGroup.
pool_refs (optional)
array[String] UUID of pools that could be referred by VSDataScriptSet objects. It is a reference to an object of type Pool.
protocol_parser_refs (optional)
array[String] List of protocol parsers that could be referred by VSDataScriptSet objects. It is a reference to an object of type ProtocolParser. Field introduced in 18.2.3.
rate_limiters (optional)
array[RateLimiter] The Rate Limit definitions needed for this DataScript. The name is composed of the Virtual Service name and the DataScript name. Field introduced in 18.2.9.
string_group_refs (optional)
array[String] UUID of String Groups that could be referred by VSDataScriptSet objects. It is a reference to an object of type StringGroup.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String UUID of the virtual service datascript collection.

VSDataScriptSetApiResponse Up

count
Integer format: int32
results
next (optional)