ves-io-schema-policer-API-Create
On This Page:
Examples of creating policer
Usecase:
Create policer-1 with 10kBps committed information rate and 10kB burst size
Request using vesctl:
vesctl configuration create policer -i policer.yaml
where file policer.yaml has following contents (policer.CreateRequest):
RequestJSON:
{
"metadata": {
"name": "policer-1",
"namespace": "documentation"
},
"spec": {
"committed_information_rate": 10000,
"burst_size": 10000,
"policer_mode": "POLICER_MODE_SHARED"
}
}
vesctl yaml response:
ResponseJSON:
{
"metadata": {
"name": "policer-1",
"namespace": "documentation",
"labels": {},
"annotations": {},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "43309b57-f5ae-4424-98f7-65cb7fa7865a",
"creation_timestamp": "2024-03-21T14:06:38.879958Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {}
},
"spec": {
"policer_type": "POLICER_SINGLE_RATE_TWO_COLOR",
"committed_information_rate": 10000,
"burst_size": 10000,
"policer_mode": "POLICER_MODE_SHARED"
}
}
Request using curl:
curl -X 'POST' -d '{"metadata":{"name":"policer-1","namespace":"documentation"},"spec":{"committed_information_rate":10000,"burst_size":10000,"policer_mode":"POLICER_MODE_SHARED"}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_2__8qnt6fwd5dvglr1xqq6l8b7w0000gp_T_go-build3109416560_b001_apidocs.test/host=C02FN35BMD6R/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/documentation/policers'
curl response:
HTTP/1.1 200 OK
Content-Length: 774
Content-Type: application/json
Date: Thu, 21 Mar 2024 14:06:38 GMT
Vary: Accept-Encoding
{
"metadata": {
"name": "policer-1",
"namespace": "documentation",
"labels": {
},
"annotations": {
},
"description": "",
"disable": false
},
"system_metadata": {
"uid": "43309b57-f5ae-4424-98f7-65cb7fa7865a",
"creation_timestamp": "2024-03-21T14:06:38.879958Z",
"deletion_timestamp": null,
"modification_timestamp": null,
"initializers": null,
"finalizers": [
],
"tenant": "acmecorp",
"creator_class": "examplesvc",
"creator_id": "examplesvc",
"object_index": 0,
"owner_view": null,
"labels": {
}
},
"spec": {
"policer_type": "POLICER_SINGLE_RATE_TWO_COLOR",
"committed_information_rate": 10000,
"burst_size": 10000,
"policer_mode": "POLICER_MODE_SHARED"
}
}