Avi PoolGroupDeploymentPolicy Object API

CLI ``` - configure poolgroupdeploymentpolicy - show poolgroupdeploymentpolicy ```
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 /poolgroupdeploymentpolicy
  2. post /poolgroupdeploymentpolicy
  3. delete /poolgroupdeploymentpolicy/{uuid}
  4. get /poolgroupdeploymentpolicy/{uuid}
  5. patch /poolgroupdeploymentpolicy/{uuid}
  6. put /poolgroupdeploymentpolicy/{uuid}
Up
get /poolgroupdeploymentpolicy
(poolgroupdeploymentpolicyGet)

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

PoolGroupDeploymentPolicyApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "test_traffic_ratio_rampup" : 123,
    "scheme" : "aeiou",
    "webhook_ref" : "aeiou",
    "description" : "aeiou",
    "rules" : [ {
      "metric_id" : "aeiou",
      "threshold" : 1.3579000000000001069366817318950779736042022705078125,
      "operator" : "aeiou"
    } ],
    "uuid" : "aeiou",
    "target_test_traffic_ratio" : 123,
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "labels" : [ {
      "value" : "aeiou",
      "key" : "aeiou"
    } ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "auto_disable_old_prod_pools" : true,
    "evaluation_duration" : 123
  } ]
}

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 PoolGroupDeploymentPolicyApiResponse

401

log in failed

Up
post /poolgroupdeploymentpolicy
(poolgroupdeploymentpolicyPost)

Consumes

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

Request body

body (required)
Body Parameter — PoolGroupDeploymentPolicy object creation

Return type

PoolGroupDeploymentPolicy

Example data

Content-Type: application/json
{
  "test_traffic_ratio_rampup" : 123,
  "scheme" : "aeiou",
  "webhook_ref" : "aeiou",
  "description" : "aeiou",
  "rules" : [ {
    "metric_id" : "aeiou",
    "threshold" : 1.3579000000000001069366817318950779736042022705078125,
    "operator" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "target_test_traffic_ratio" : 123,
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "auto_disable_old_prod_pools" : true,
  "evaluation_duration" : 123
}

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 PoolGroupDeploymentPolicy

401

log in failed

Up
delete /poolgroupdeploymentpolicy/{uuid}
(poolgroupdeploymentpolicyUuidDelete)

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 /poolgroupdeploymentpolicy/{uuid}
(poolgroupdeploymentpolicyUuidGet)

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

PoolGroupDeploymentPolicy

Example data

Content-Type: application/json
{
  "test_traffic_ratio_rampup" : 123,
  "scheme" : "aeiou",
  "webhook_ref" : "aeiou",
  "description" : "aeiou",
  "rules" : [ {
    "metric_id" : "aeiou",
    "threshold" : 1.3579000000000001069366817318950779736042022705078125,
    "operator" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "target_test_traffic_ratio" : 123,
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "auto_disable_old_prod_pools" : true,
  "evaluation_duration" : 123
}

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 PoolGroupDeploymentPolicy

401

log in failed

Up
patch /poolgroupdeploymentpolicy/{uuid}
(poolgroupdeploymentpolicyUuidPatch)

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 — PoolGroupDeploymentPolicy object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

PoolGroupDeploymentPolicy

Example data

Content-Type: application/json
{
  "test_traffic_ratio_rampup" : 123,
  "scheme" : "aeiou",
  "webhook_ref" : "aeiou",
  "description" : "aeiou",
  "rules" : [ {
    "metric_id" : "aeiou",
    "threshold" : 1.3579000000000001069366817318950779736042022705078125,
    "operator" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "target_test_traffic_ratio" : 123,
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "auto_disable_old_prod_pools" : true,
  "evaluation_duration" : 123
}

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 PoolGroupDeploymentPolicy

401

log in failed

Up
put /poolgroupdeploymentpolicy/{uuid}
(poolgroupdeploymentpolicyUuidPut)

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 — PoolGroupDeploymentPolicy object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

PoolGroupDeploymentPolicy

Example data

Content-Type: application/json
{
  "test_traffic_ratio_rampup" : 123,
  "scheme" : "aeiou",
  "webhook_ref" : "aeiou",
  "description" : "aeiou",
  "rules" : [ {
    "metric_id" : "aeiou",
    "threshold" : 1.3579000000000001069366817318950779736042022705078125,
    "operator" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "target_test_traffic_ratio" : 123,
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "auto_disable_old_prod_pools" : true,
  "evaluation_duration" : 123
}

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 PoolGroupDeploymentPolicy

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. KeyValue
  2. PGDeploymentRule
  3. PoolGroupDeploymentPolicy
  4. PoolGroupDeploymentPolicyApiResponse

KeyValue Up

key
String Key.
value (optional)
String Value.

PGDeploymentRule Up

metric_id (optional)
String metric_id of PGDeploymentRule.
operator (optional)
String Enum options - CO_EQ, CO_GT, CO_GE, CO_LT, CO_LE, CO_NE.
threshold (optional)
Double metric threshold that is used as the pass fail. If it is not provided then it will simply compare it with current pool vs new pool. format: double

PoolGroupDeploymentPolicy Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
auto_disable_old_prod_pools (optional)
Boolean It will automatically disable old production pools once there is a new production candidate.
description (optional)
String User defined description for the object.
evaluation_duration (optional)
Integer Duration of evaluation period for automatic deployment. Allowed values are 60-86400. Unit is SEC. format: int32
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 The name of the pool group deployment policy.
rules (optional)
array[PGDeploymentRule] Placeholder for description of property rules of obj type PoolGroupDeploymentPolicy field type str type object
scheme (optional)
String deployment scheme. Enum options - BLUE_GREEN, CANARY.
target_test_traffic_ratio (optional)
Integer Target traffic ratio before pool is made production. Allowed values are 1-100. Unit is RATIO. format: int32
tenant_ref (optional)
String It is a reference to an object of type Tenant.
test_traffic_ratio_rampup (optional)
Integer Ratio of the traffic that is sent to the pool under test. test ratio of 100 means blue green. Allowed values are 1-100. format: int32
url (optional)
String url
uuid (optional)
String UUID of the pool group deployment policy.
webhook_ref (optional)
String Webhook configured with URL that Avi controller will pass back information about pool group, old and new pool information and current deployment rule results. It is a reference to an object of type Webhook. Field introduced in 17.1.1.

PoolGroupDeploymentPolicyApiResponse Up

count
Integer format: int32
results
next (optional)