redocly logoAPI docs by Redocly

F5 Distributed Cloud Services API for ves.io.schema.known_label

Download OpenAPI specification:Download

Known labels serves two purposes

Its let users declare labels so that they can be consistently used across their namespaces. Declared labels can be used by the Web UI in drop down. Description field in the label lets everyone know what this label means.

System allocates unique integer (ID) values for known labels. These ID(s) are used in Network Policy or Service Policy enforcement. Hence only Known labels can be used in Network Policy or L7 Policy.

Create

Create creates a new label in shared namespace. Any other namespace requested will return error

Examples of this operation
path Parameters
namespace
required
string

Namespace

x-example: "value" Namespace in which to create the label

Request Body schema: application/json
required
description
string (Description)

Description of the label to be created

Example: "Paris metro region in France (EU)"

key
string (Key)

Key for the label to be created

Example: "ves.io/region"

namespace
string (Namespace)

Namespace in which to create the label

Example: "value"

value
string (Value)

Value of the label to be created

Example: "ves-io-par"

Validation Rules: ves.io.schema.rules.string.k8s_label_value: true

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "key": "string",
  • "namespace": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "label": {
    }
}

Delete

Delete will delete a given label label key = label value from current tenants shared namespace

Examples of this operation
path Parameters
namespace
required
string

Namespace

x-example: "value" Namespace of the label to be deleted

Request Body schema: application/json
required
key
string (Key)

Key of the label to be deleted

Example: "ves.io/region"

namespace
string (Namespace)

Namespace of the label to be deleted

Example: "value"

value
string (Value)

Value of the label to be deleted

Example: "ves-io-par"

Validation Rules: ves.io.schema.rules.string.k8s_label_value: true

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "namespace": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{ }

Get

Get is generic label query. Two types of queries are supported Return label with exact matching entry label key = label value. Return list of labels that have prefix of label key = label value. Returns list of labels. Query will look into current tenants shared namespace and ves-io shared.

Examples of this operation
path Parameters
namespace
required
string

Namespace

x-example: "value" Namespace for the label to be retrieved

query Parameters
query
string
Default: "QUERY_ALL_LABELS"
Enum: "QUERY_ALL_LABELS" "QUERY_EXACT_LABEL" "QUERY_VALUE_PREFIX_LABELS" "QUERY_KEY_PREFIX_LABELS"

Query type

Generic Get of all available labels for a given tenant Get exact match of label.key = label.value Or label.key(label.value) Get prefix match of label.key = label.value Get prefix match of label.key

key
string

x-example: "ves.io/region" Key of the label to be retrieved

value
string

x-example: "ves-io-par" Value of the label to be retrieved

Responses

Response samples

Content type
application/json
{
  • "label": [
    ]
}