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": "833458ae-eca9-4486-a1b7-c3b094d6de74",
        "creation_timestamp": "2022-09-23T13:13:43.979068098Z",
        "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-build243329498_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: Fri, 23 Sep 2022 13:13:43 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "policer-1",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "833458ae-eca9-4486-a1b7-c3b094d6de74",
    "creation_timestamp": "2022-09-23T13:13:43.979068098Z",
    "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"
  }
}