GET Implicit Labels.
const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/system/implicit_labels?query=QUERY_ALL_LABELS';const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/system/implicit_labels?query=QUERY_ALL_LABELS' \ --header 'Authorization: <Authorization>'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-I/O shared.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Type of Query
GET all available implicit labels GET exact match of label.key = label.value Or label.key(label.value) GET prefix match of label.key = label.value GET list of all keys GET list of all labels that exactly match the given key and substring match either ‘value’ or description provided in ‘value’ field GET list of all keys matching a substring.
Key string in Query parameters.
Value string in Query parameters.
Key classes
Includes label keys with generic names such as “example-key”, “foobar-key” etc. Keys that are obtained using GET on /API/config/configconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfignamespaces/shared/known_label_keys Includes F5 Distributed Cloud-defined known label keys such as “F5 XC/app_type”, “F5 XC/app” and “F5 XC/siteType” as well as tenant-defined known keys such as “example-key”, “acme-key-foo” and “acme-key-bar”. Note that tenant-defined known keys don’t have any standard name format - they are known keys because they have been explicitly created as known keys by the tenant and are stored in the configuration as known_label_keys. Includes implicit geoip label keys “geoip.F5 XC/city”, “geoip.F5 XC/region” and “geoip.F5 XC/country” Includes implicit label keys associated with packets/requests by the infrastructure e.g. “implicit.F5 XC/namespace” Include IP reputation label keys “ipreputation.F5 XC/threattype”, “ipreputation.F5 XC/threatlevel” Include URL reputation label keys “urlreputation.F5 XC/category”, “urlreputation.F5 XC/reputationlevel” Includes implicit geoip label keys “geoip.F5 XC/continent” Includes implicit geoip label keys “geoip.F5 XC/region”, “geoip.F5 XC/country” and “geoip.F5 XC/continent” Implicit AWS resource labels (dynamically queried). This may be VPC level tags and/or subnet level tags.
Responses
Section titled “Responses”A successful response.
GET Label Response, list of labels.
object
List of labels as Query response.
Generic Label type label.key(label.value)
object
Label description.
Label key
Label value.
Examplegenerated
{ "label": [ { "description": "example", "key": "example", "value": "example" } ]}Returned when operation is not authorized.
Examplegenerated
exampleReturned when there is no permission to access resource.
Examplegenerated
exampleReturned when resource is not found.
Examplegenerated
exampleReturned when operation on resource is conflicting with current value.
Examplegenerated
exampleReturned when operation has been rejected as it is happening too frequently.
Examplegenerated
exampleReturned when server encountered an error in processing API.
Examplegenerated
exampleReturned when service is unavailable temporarily.
Examplegenerated
exampleReturned when server timed out processing request.
Examplegenerated
example