VoltShare Access Count Query.

POST

/api/secret_management/namespaces/{namespace}/voltshare/access_count

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/secret_management/namespaces/example/voltshare/access_count \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "end_time": "example", "group_by": [ "OPERATION" ], "label_filter": [ { "label": "OPERATION", "op": "EQ", "value": "example" } ], "namespace": "example", "start_time": "example", "step": "example" }'

• F5 Distributed Cloud Console

Request to GET number of VoltShare API calls aggregated across multiple dimensions like OPERATION, COUNTRY, RESULT, USER_TENANT.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace namespace is used to scope the security events for the given namespace.

Request Body^required

Media typeapplication/json

VoltShareAccessCountRequest

Request to GET number of VoltShare API calls aggregated across multiple dimensions like OPERATION, COUNTRY, RESULT, USER_TENANT.

object

end_time

End time

End time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339

Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to

string

<= 1024 characters

group_by

Group by

Aggregate data by one or more labels listed here. OPERATION, RESULT, USER_TENANT, COUNTRY.

Optional: If not specified, then the metric is aggregated across all the labels.

Array<string>

Allowed values: OPERATION RESULT USER_TENANT COUNTRY

label_filter

Label Filter

List of label filter expressions of the form “label” Op “value”. Response will only contain data that matches all the conditions specified in the label_filter. One or more of the following labels can be specified in the label_filter. OPERATION, RESULT, USER_TENANT, COUNTRY.

Optional: If not specified, then the metrics will be filtered only based on the namespace in the request.

Array<object>

MetricLabelFilter

VoltShare Access metric is tagged with labels mentioned in MetricLabel. Metric label filter can be specified to query/aggregate specific timeseries based on label match.

object

label

string

default: OPERATION

Allowed values: OPERATION RESULT USER_TENANT COUNTRY

op

string

default: EQ

Allowed values: EQ NEQ

value

Value

Value to be compared with.

string

>= 3 characters <= 1024 characters

namespace

Namespace

Namespace is used to scope the security events for the given namespace.

string

>= 6 characters <= 1024 characters

start_time

Start time

Start time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339

Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.

string

<= 1024 characters

step

Step

Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, … Tn=tn-1+step, where tn <= end_time. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days

Optional: If not specified, then step size is evaluated to <end_time - start_time>

string

<= 1024 characters

Responses

200

A successful response.

Media typeapplication/json

VoltShareAccessCountResponse

VoltShare access count for each unique combination of group_by labels in the VoltShareAccessCountRequest.

object

data

Security events counter data

List of VoltShare Access count data for each unique combination of group_by labels.

Array<object>

VoltShare Access Counter

VoltShareAccessCounter contains the access count for each unique combination of group_by label in the request.

object

id

object

country

Country

Country from where the API call was made.

string

<= 1024 characters

operation

Operation

Encrypt/Decrypt operation.

string

<= 1024 characters

result

Result

Result of the VoltShare operation.

string

<= 1024 characters

user_tenant

User Tenant

Tenant that made the VoltShare API call.

string

<= 1024 characters

metric

Metric Values

List of metric values.

Array<object>

Metric Value

Value returned for a VoltShare Access Metrics query.

object

timestamp

Timestamp

Timestamp

number format: double

value

Value

Number of accesses.

string

>= 3 characters <= 1024 characters

step

step

Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.

string

<= 1024 characters

Example^generated

{
  "data": [
    {
      "id": {
        "country": "example",
        "operation": "example",
        "result": "example",
        "user_tenant": "example"
      },
      "metric": [
        {
          "timestamp": 1,
          "value": "example"
        }
      ]
    }
  ],
  "step": "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