FlowPreviewService_PreviewFlowLabels2

FlowPreviewService_PreviewFlowLabels2

Path Parameters

• control_point string required

  Control point to preview.

Query Parameters

• samples int64

  Number of samples to collect.

• service string

  Service to preview.

application/json

Request Body required

Flow labels to match. Optional parameter for advanced filtering.

• expression object

  An arbitrary expression to be evaluated on the labels.

  all object

  The expression is true when all sub expressions are true.

  of object[]

  List of sub expressions of the match expression.

  Array [

  0

  1

  2

  3

  4

  5

  6

  7

  8

  9

  ]

  any object

  The expression is true when any sub expression is true.

  of object[]

  List of sub expressions of the match expression.

  Array [

  0

  1

  2

  3

  4

  5

  6

  7

  8

  9

  ]

  label_equals object

  The expression is true when label value equals given value.

  label string required

  Name of the label to equal match the value.

  value string

  Exact value that the label should be equal to.

  label_exists string

  The expression is true when label with given name exists.

  label_matches object

  The expression is true when label matches given regular expression.

  label string required

  Name of the label to match the regular expression.

  regex string required

  Regular expression that should match the label value. It uses Go's regular expression syntax.

  not object

  The expression negates the result of sub expression.

  0

  1

  2

  3

  4

  5

  6

  7

  8

  9
• match_expressions object[]

  List of Kubernetes-style label matcher requirements.

  Note: The requirements are combined using the logical AND operator. Deprecated: v3.0.0. Use match_list instead.

  Array [

  key string required

  Label key that the selector applies to.

  operator string required

  Possible values: [In, NotIn, Exists, DoesNotExist]

  Logical operator which represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  values string[]

  An array of string values that relates to the key by an operator. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty.

  ]
• match_labels object

  A map of {key,value} pairs representing labels to be matched. A single {key,value} in the match_labels requires that the label key is present and equal to value.

  Note: The requirements are combined using the logical AND operator.

  property name* string
• match_list object[]

  List of label matching requirements.

  Note: The requirements are combined using the logical AND operator.

  Array [

  key string required

  Label key that the selector applies to.

  operator string required

  Possible values: [In, NotIn, Exists, DoesNotExist]

  Logical operator which represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  values string[]

  An array of string values that relates to the key by an operator. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty.

  ]

Responses

• 200
• default

---

A successful response.

application/json

• Schema
• Example (from schema)

---

Schema

• samples object[]

  Array [

  labels object

  property name* string

  ]

{
  "samples": [
    {
      "labels": {}
    }
  ]
}

An unexpected error response.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32

  The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

• details object[]

  A list of messages that carry the error details. There is a common set of message types for APIs to use.

  Array [

  @type string

  A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

  In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

  • If no scheme is provided, https is assumed.
  • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
  • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

  Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

  Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  ]
• message string

  A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

POST /v1/flowcontrol/preview/labels/:control_point

Request

Base URL

https://aperture-agent

control_point — path required

samples — query

service — query

Body required

{
  "expression": {
    "all": {
      "of": [
        {}
      ]
    },
    "any": {
      "of": [
        {}
      ]
    },
    "label_equals": {
      "label": "string",
      "value": "string"
    },
    "label_exists": "string",
    "label_matches": {
      "label": "string",
      "regex": "string"
    },
    "not": {}
  },
  "match_expressions": [
    {
      "key": "string",
      "operator": "In",
      "values": [
        "string"
      ]
    }
  ],
  "match_labels": {},
  "match_list": [
    {
      "key": "string",
      "operator": "In",
      "values": [
        "string"
      ]
    }
  ]
}

curl / cURL

curl -L -X POST 'https://aperture-agent/v1/flowcontrol/preview/labels/:control_point' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "expression": {
    "all": {
      "of": [
        {}
      ]
    },
    "any": {
      "of": [
        {}
      ]
    },
    "label_equals": {
      "label": "string",
      "value": "string"
    },
    "label_exists": "string",
    "label_matches": {
      "label": "string",
      "regex": "string"
    },
    "not": {}
  },
  "match_expressions": [
    {
      "key": "string",
      "operator": "In",
      "values": [
        "string"
      ]
    }
  ],
  "match_labels": {},
  "match_list": [
    {
      "key": "string",
      "operator": "In",
      "values": [
        "string"
      ]
    }
  ]
}'

python / requests

curl -L -X POST 'https://aperture-agent/v1/flowcontrol/preview/labels/:control_point' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "expression": {
    "all": {
      "of": [
        {}
      ]
    },
    "any": {
      "of": [
        {}
      ]
    },
    "label_equals": {
      "label": "string",
      "value": "string"
    },
    "label_exists": "string",
    "label_matches": {
      "label": "string",
      "regex": "string"
    },
    "not": {}
  },
  "match_expressions": [
    {
      "key": "string",
      "operator": "In",
      "values": [
        "string"
      ]
    }
  ],
  "match_labels": {},
  "match_list": [
    {
      "key": "string",
      "operator": "In",
      "values": [
        "string"
      ]
    }
  ]
}'

go / native

curl -L -X POST 'https://aperture-agent/v1/flowcontrol/preview/labels/:control_point' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "expression": {
    "all": {
      "of": [
        {}
      ]
    },
    "any": {
      "of": [
        {}
      ]
    },
    "label_equals": {
      "label": "string",
      "value": "string"
    },
    "label_exists": "string",
    "label_matches": {
      "label": "string",
      "regex": "string"
    },
    "not": {}
  },
  "match_expressions": [
    {
      "key": "string",
      "operator": "In",
      "values": [
        "string"
      ]
    }
  ],
  "match_labels": {},
  "match_list": [
    {
      "key": "string",
      "operator": "In",
      "values": [
        "string"
      ]
    }
  ]
}'