Avi PoolGroupDeploymentPolicy Object API
CLI ``` - configure poolgroupdeploymentpolicy - show poolgroupdeploymentpolicy ```
Contact Info: support@avinetworks.com
Version: 20.1.9
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /poolgroupdeploymentpolicypost /poolgroupdeploymentpolicydelete /poolgroupdeploymentpolicy/{uuid}get /poolgroupdeploymentpolicy/{uuid}patch /poolgroupdeploymentpolicy/{uuid}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
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,
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
} ]
}
Produces
This API call produces the following media types according to the 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
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,
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the 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 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
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,
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the 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
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,
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the 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
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,
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
PoolGroupDeploymentPolicy
401
log in failed
[ Jump to Methods ]
Table of Contents
KeyValuePGDeploymentRulePoolGroupDeploymentPolicyPoolGroupDeploymentPolicyApiResponseRoleFilterMatchLabel
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
_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 deprecated in 20.1.5. Field introduced in 20.1.2. Maximum of 4 items allowed.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Basic edition, Essentials edition, Enterprise edition.
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)
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.
count
results
next (optional)
key
String Key for filter match. Field introduced in 20.1.3.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3.