ves-io-schema-policer-API-Create

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": "24cfd298-ff90-4c67-a3a2-e3edf530c2d2",
    "creation_timestamp": "2022-07-28T12:11:25.506120051Z",
    "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=_tmp_go-build1372770011_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/documentation/policers'



curl response:

	


HTTP/1.1 200 OK Content-Length: 777 Content-Type: application/json Date: Thu, 28 Jul 2022 12:11:25 GMT Vary: Accept-Encoding

{ "metadata": { "name": "policer-1", "namespace": "documentation", "labels": { }, "annotations": { }, "description": "", "disable": false }, "system_metadata": { "uid": "24cfd298-ff90-4c67-a3a2-e3edf530c2d2", "creation_timestamp": "2022-07-28T12:11:25.506120051Z", "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" } }