GET Active Alert Policies.

GET

/api/config/namespaces/{namespace}/active_alert_policies

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/active_alert_policies \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

GetActiveAlertPolicies returns the list of active alert policies for the namespace.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace The name of the namespace.

Responses

200

A successful response.

Media typeapplication/json

GetActiveAlertPoliciesResponse

GetActiveAlertPoliciesResponse is the shape of the response for GetActiveAlertPolicies.

object

alert_policies

alert_policies

A list of references to alert_policy objects.

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.

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

alert_policies_status

policy_status

The status of alert policies.

Array<object>

object

policy

object

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. Required: YES.

string

>= 1 characters <= 128 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 <= 64 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 <= 64 characters

reason

Reason

A human-readable description of why this status is in the “Partially Active” or “Inactive” status. The value will be empty for “Active” status.

Array<string>

>= 27 characters <= 43 characters

status

Status

Staus of the alert policy.

string

>= 17 characters <= 1024 characters

Example^generated

{
  "alert_policies": [
    {
      "name": "example",
      "namespace": "example"
    }
  ],
  "alert_policies_status": [
    {
      "policy": {
        "name": "example",
        "namespace": "example"
      },
      "reason": [
        "example"
      ],
      "status": "example"
    }
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

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

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example