List HTTP Monitor.

GET

/api/observability/synthetic_monitor/namespaces/{namespace}/v1_http_monitors

const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/observability/synthetic_monitor/namespaces/example/v1_http_monitors';
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/observability/synthetic_monitor/namespaces/example/v1_http_monitors \
  --header 'Authorization: <Authorization>'

List the set of v1_http_monitor in a namespace.

Examples of this operation.

Authorizations

ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace to scope the listing of v1_http_monitor.

Query Parameters

label_filter

string

A LabelSelectorType expression that every item in list response will satisfy.

report_fields

Array<string>

X-example: "" Extra fields to return along with summary fields.

report_status_fields

Array<string>

X-example: "" Extra status fields to return along with summary fields.

Responses

200

A successful response.

application/json

ListResponse is the collection of v1_http_monitor

This is the output message of ‘List’ RPC.

object

errors

errors

Errors(if any) while listing items from collection.

Array<object>

ErrorType

Information about a error in API operation.

object

code

string

default: EOK

Allowed values: EOK EPERMS EBADINPUT ENOTFOUND EEXISTS EUNKNOWN ESERIALIZE EINTERNAL EPARTIAL

error_obj

object

type_url

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.

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

string

<= 1024 characters

value

Must be a valid serialized protocol buffer of the above specified type.

string format: byte

>= 3 characters <= 1024 characters

message

message

A human readable string of the error.

string

<= 1024 characters

items

items

Items represents the collection in response.

Array<object>

ListResponseItem is an individual item in a collection of v1_http_monitor

By default a summary of v1_http_monitor is returned in ‘List’. By setting ‘report_fields’ in the ListRequest more details of each item can be got.

object

annotations

annotations

The set of annotations present on this v1_http_monitor.

object

description

description

The description set for this v1_http_monitor.

string

>= 21 characters <= 1024 characters

disabled

disabled

A value of true indicates v1_http_monitor is administratively disabled.

boolean format: boolean

get_spec

object

delete

object

request_body

content

Ensure appropriate request headers are added based on the content type added here.

string

<= 65535 characters

external_sources

Internet facing monitor sources

Required: YES.

Array<object>

>= 1 items <= 8 items

Source

A location where a monitor runs.

object

aws

object

regions

AWS Regions

A specific source location within AWS Required: YES.

Array<string>

f5xc

object

regions

F5 Distributed Cloud Regions

A specific source location within F5 Distributed Cloud Required: YES.

Array<string>

follow_redirects

Controls if the monitor will follow redirects while determining health.

boolean format: boolean

get

object

head

object

health_policy

object

dynamic_threshold

object

eval_period

string

default: EVAL_PERIOD_3_MINS

Allowed values: EVAL_PERIOD_3_MINS EVAL_PERIOD_5_MINS EVAL_PERIOD_10_MINS EVAL_PERIOD_15_MINS

std_dev_val

string

default: STD_DEV_VAL_3

Allowed values: STD_DEV_VAL_3 STD_DEV_VAL_4 STD_DEV_VAL_5 STD_DEV_VAL_6

dynamic_threshold_disabled

object

static_max_threshold

object

eval_period

string

default: EVAL_PERIOD_3_MINS

Allowed values: EVAL_PERIOD_3_MINS EVAL_PERIOD_5_MINS EVAL_PERIOD_10_MINS EVAL_PERIOD_15_MINS

max_response_time

max_response_time

The maximum response time value that must be exceeded before the monitor turns critical. Required: YES.

integer format: int64

static_max_threshold_disabled

object

static_min_threshold

object

eval_period

string

default: EVAL_PERIOD_3_MINS

Allowed values: EVAL_PERIOD_3_MINS EVAL_PERIOD_5_MINS EVAL_PERIOD_10_MINS EVAL_PERIOD_15_MINS

min_response_time

min_response_time

The minimum value that response time must fall below before the monitor turns critical. Required: YES.

integer format: int64

static_min_threshold_disabled

object

ignore_cert_errors

Controls if an SSL error will result in a change of health status.

boolean format: boolean

interval_12_hours

object

interval_15_mins

object

interval_1_day

object

interval_1_hour

object

interval_1_min

object

interval_30_mins

object

interval_30_secs

object

interval_5_mins

object

interval_6_hours

object

on_failure_count

The number of times a monitor must fail before the global monitor changes health Required: YES.

integer format: int64

options

object

patch

object

request_body

content

Ensure appropriate request headers are added based on the content type added here.

string

<= 65535 characters

post

object

request_body

content

Ensure appropriate request headers are added based on the content type added here.

string

<= 65535 characters

put

object

request_body

content

Ensure appropriate request headers are added based on the content type added here.

string

<= 65535 characters

receive

The regex pattern that the monitor looks for in the returned resource. If the text string is returned, the monitor is healthy. Note, headers are not considered in the matching.

string

<= 2048 characters

request_headers

Configuration parameter for request headers

Array<object>

HTTPMonitorHeader

object

key

Key

Required: YES.

string

>= 7 characters <= 2048 characters

value

Value

Configuration parameter for value

string

>= 3 characters <= 8192 characters

response_codes

HTTP response codes which will result in a healthy monitor. Use ”*” as a wildcard character. Required: YES.

Array<string>

>= 1 items

response_timeout

The amount of time in milliseconds before the monitor considers a pending request to be a failure.

integer format: int64

sni_host

A string value which will override the default SNI host.

string

<= 253 characters

source_critical_threshold

The number of provider-regions a monitor must fail from before the global monitor changes health Required: YES.

integer format: int64

url

Required: YES.

string format: uri

<= 2048 characters

labels

labels

The set of labels present on this v1_http_monitor.

object

metadata

object

annotations

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

object

description

description

Human readable description for the object.

string

>= 21 characters <= 1200 characters

disable

disable

A value of true will administratively disable the object.

boolean format: boolean

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object

name

name

This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.

string

>= 6 characters <= 1024 characters

namespace

namespace

This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

string

>= 6 characters <= 1024 characters

name

name

The name of this v1_http_monitor.

string

>= 6 characters <= 1024 characters

namespace

namespace

The namespace this item belongs to.

string

>= 6 characters <= 1024 characters

owner_view

object

kind

kind

Kind of the view object.

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

uid

uid

UID of the view object.

string format: uuid

>= 36 characters <= 1024 characters

status_set

status

The status reported by different services for this configuration object.

Array<object>

StatusObject

Most recently observed status of object.

object

conditions

conditions

Conditions reported by various component of the system.

Array<object>

ConditionType

Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.

object

hostname

hostname

Hostname of the instance of the site that sent the status.

string

<= 1024 characters

last_update_time

last_update_time

Last time the condition was updated.

string format: date-time

<= 1024 characters

reason

reason

X-reason: “Insufficient memory in data plane” A human readable string explaining the reason for reaching this condition.

string

>= 27 characters <= 1024 characters

service_name

service name

Name of the service that sent the status.

string

<= 1024 characters

status

status

Status of the condition “Success” Validtion has succeded. Requested operation was successful. “Failed” Validation has failed. “Incomplete” Validation of configuration has failed due to missing configuration. “Installed” Validation has passed and configuration has been installed in data path or K8s “Down” Configuration is operationally down. E.g. Down interface “Disabled” Configuration is administratively disabled i.e. objectmetatype.disable = true. “NotApplicable” Configuration is not applicable e.g. Tenant service_policy_set(s) in system namespace are not applicable on REs.

string

>= 17 characters <= 1024 characters

type

type

Type of the condition “Validation” represents validation user given configuration object “Operational” represents operational status of a given configuration object.

string

<= 1024 characters

metadata

object

creation_timestamp

creation_timestamp

Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.

string format: date-time

<= 1024 characters

creator_class

creator_class

Class of creator which created this StatusObject. This will be service’s DNS FQDN. This will be set by the system based on client certificate information.

string

<= 1024 characters

creator_id

creator_id

ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.

string

<= 1024 characters

publish

string

default: STATUS_DO_NOT_PUBLISH

Allowed values: STATUS_DO_NOT_PUBLISH STATUS_PUBLISH

status_id

status_id

Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID)

string

<= 1024 characters

uid

uid

Uid is the unique in time and space value for a StatusObject.

string format: uuid

>= 36 characters <= 1024 characters

vtrp_id

vtrp_id

Origin of this status exchanged by VTRP.

string

<= 1024 characters

vtrp_stale

vtrp_stale

Indicate whether mars deems this object to be stale via graceful restart timer information.

boolean format: boolean

object_refs

object_refs

Object reference.

Array<object>

ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

system_metadata

object

creation_timestamp

creation_timestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

string format: date-time

<= 1024 characters

creator_class

creator_class

A value identifying the class of the user or service which created this configuration object.

string

<= 1024 characters

creator_id

creator_id

A value identifying the exact user or service that created this configuration object.

string

<= 1024 characters

deletion_timestamp

deletion_timestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only.

string format: date-time

<= 1024 characters

finalizers

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

Array<string>

initializers

object

pending

pending

Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

Array<object>

InitializerType

Initializer is information about an initializer that has not yet completed.

object

name

name

Name of the service that is responsible for initializing this object.

string

>= 6 characters <= 1024 characters

result

object

code

code

Suggested HTTP return code for this status, 0 if not set.

integer format: int32

reason

reason

A human-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available.

string

>= 27 characters <= 1024 characters

status

status

Status of the operation. One of: “Success” or “Failure”.

string

>= 17 characters <= 1024 characters

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).

object

modification_timestamp

modification_timestamp

ModificationTimestamp is a timestamp representing the server time when this object was last modified.

string format: date-time

<= 1024 characters

object_index

object_index

Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.

integer format: int64

owner_view

object

kind

kind

Kind of the view object.

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

uid

uid

UID of the view object.

string format: uuid

>= 36 characters <= 1024 characters

tenant

tenant

Tenant to which this configuration object belongs to. The value for this is found from presented credentials.

string

>= 6 characters <= 1024 characters

uid

uid

Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.

string format: uuid

>= 36 characters <= 1024 characters

tenant

tenant

The tenant this item belongs to.

string

>= 6 characters <= 1024 characters

uid

uid

The unique uid of this v1_http_monitor.

string format: uuid

>= 36 characters <= 1024 characters

Example

{
  "errors": [
    {
      "code": "EOK"
    }
  ],
  "items": [
    {
      "get_spec": {
        "health_policy": {
          "dynamic_threshold": {
            "eval_period": "EVAL_PERIOD_3_MINS",
            "std_dev_val": "STD_DEV_VAL_3"
          },
          "static_max_threshold": {
            "eval_period": "EVAL_PERIOD_3_MINS"
          },
          "static_min_threshold": {
            "eval_period": "EVAL_PERIOD_3_MINS"
          }
        }
      },
      "status_set": [
        {
          "metadata": {
            "publish": "STATUS_DO_NOT_PUBLISH"
          }
        }
      ]
    }
  ]
}

401

Returned when operation is not authorized.

application/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

application/json

string format: string

Example^generated

example

404

Returned when resource is not found.

application/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

application/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

application/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

application/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

application/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

application/json

string format: string

Example^generated

example

List HTTP Monitor.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

429

Examplegenerated

500

Examplegenerated

503

Examplegenerated

504

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated