PATCH /poolgroupdeploymentpolicy/{uuid}

PATCH /poolgroupdeploymentpolicy/{uuid}

/poolgroupdeploymentpolicy/{uuid}

Request
URI
PATCH
https://{api_host}/api/poolgroupdeploymentpolicy/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Request Body

PoolGroupDeploymentPolicy object creation

PoolGroupDeploymentPolicy of type(s) application/json
Optional

Show optional properties

{
    "name": "string"
}
{
    "_last_modified": "string",
    "auto_disable_old_prod_pools": false,
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "evaluation_duration": 0,
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "rules": [
        {
            "metric_id": "string",
            "operator": "string",
            "threshold": "number"
        }
    ],
    "scheme": "string",
    "target_test_traffic_ratio": 0,
    "tenant_ref": "string",
    "test_traffic_ratio_rampup": 0,
    "url": "string",
    "uuid": "string",
    "webhook_ref": "string"
}
Responses
200

OK

Returns PoolGroupDeploymentPolicy of type(s) application/json 
"PoolGroupDeploymentPolicy Object"
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

boolean
auto_disable_old_prod_pools
Optional
Constraints: default: true

It will automatically disable old production pools once there is a new production candidate. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
configpb_attributes
Optional

configpb_attributes

string
description
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
evaluation_duration
Optional
Constraints: default: 300

Duration of evaluation period for automatic deployment. Allowed values are 60-86400. Unit is SEC. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of object
markers
Optional

List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

string
name
Required

The name of the pool group deployment policy. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of object
rules
Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
scheme
Optional
Constraints: default: BLUE_GREEN

deployment scheme. Enum options - BLUE_GREEN, CANARY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
target_test_traffic_ratio
Optional
Constraints: default: 100

Target traffic ratio before pool is made production. Allowed values are 1-100. Unit is RATIO. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
test_traffic_ratio_rampup
Optional
Constraints: default: 100

Ratio of the traffic that is sent to the pool under test. test ratio of 100 means blue green. Allowed values are 1-100. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of the pool group deployment policy. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
webhook_ref
Optional

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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}'
On This Page
Pool Group Deployment Policy Operations
GET
GET /poolgroupdeploymentpolicy
POST
POST /poolgroupdeploymentpolicy
GET
GET /poolgroupdeploymentpolicy/{uuid}
PUT
PUT /poolgroupdeploymentpolicy/{uuid}
PATCH
PATCH /poolgroupdeploymentpolicy/{uuid}
DELETE
DELETE /poolgroupdeploymentpolicy/{uuid}