openapi: 3.0.1
info:
title: FlashArray REST Active Directory Metrics API
version: '2.52'
description: 'Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos
or New Technology LAN Manager (NTLM). Active Directory is also used to authorize users by
mapping identities across the NFS and SMB protocols by using LDAP queries.
'
servers:
- url: /
tags:
- name: Metrics
description: 'Provides information about historical metrics for arrays, buckets, directories,
file systems, pods, subscription licenses, and volumes.
'
paths:
/api/1.5/metrics:
get:
tags:
- Metrics
summary: Pure Storage Get Metrics
description: 'Retrieves information about metrics that can be queried for.
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/Continuation_token'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Names'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Resource_types'
- $ref: '#/components/parameters/Sort'
responses:
'200':
description: OK
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
X-RateLimit-Remaining-second:
description: 'The number of requests remaining for the organization in that second.
'
schema:
type: integer
X-RateLimit-Remaining-minute:
description: 'The number of requests remaining for the organization in that minute.
'
schema:
type: integer
X-RateLimit-Limit-second:
description: The number of requests available per second.
schema:
type: integer
X-RateLimit-Limit-minute:
description: The number of requests available per minute.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/MetricGetResponse'
'400':
$ref: '#/components/responses/Error400'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
/api/1.5/metrics/history:
get:
tags:
- Metrics
summary: Pure Storage Get Metrics History
description: 'Retrieves historical metric data for resources.
This endpoint supports batching: Up to 32 time series can be retrieved in one call.
It can be multiple metrics for one resource,
(e.g., load and bandwidth for one array - 2 time series),
one metric for multiple resource (e.g., load for arrayA and arrayB - 2 time series),
or a combination of both, multiple metrics for multiple resources,
(e.g., load and bandwidth for arrayA and arrayB - 4 time series).
'
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XRequestId'
- $ref: '#/components/parameters/AggregationRequired'
- $ref: '#/components/parameters/End_timeRequired'
- $ref: '#/components/parameters/IdsRequired'
- $ref: '#/components/parameters/NamesRequired'
- $ref: '#/components/parameters/ResolutionRequired'
- $ref: '#/components/parameters/Resource_idsRequired'
- $ref: '#/components/parameters/Resource_namesRequired'
- $ref: '#/components/parameters/Start_timeRequired'
responses:
'200':
description: OK
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: string
X-RateLimit-Remaining-second:
description: 'The number of requests remaining for the organization in that second.
'
schema:
type: integer
X-RateLimit-Remaining-minute:
description: 'The number of requests remaining for the organization in that minute.
'
schema:
type: integer
X-RateLimit-Limit-second:
description: The number of requests available per second.
schema:
type: integer
X-RateLimit-Limit-minute:
description: The number of requests available per minute.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/MetricHistoryGetResponse'
'400':
$ref: '#/components/responses/Error400'
'403':
$ref: '#/components/responses/Error403'
'404':
$ref: '#/components/responses/Error404'
'429':
$ref: '#/components/responses/Error429'
'500':
$ref: '#/components/responses/Error500'
components:
schemas:
MetricGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/MetricResponse'
Error:
type: object
properties:
errors:
description: The list of errors encountered.
type: array
items:
$ref: '#/components/schemas/_errorErrors'
_timeAware:
type: object
properties:
_as_of:
description: The freshness of the data (timestamp in millis since epoch).
type: integer
format: int64
readOnly: true
example: 1502729489760
ErrorNoContext:
type: object
properties:
message:
type: string
example: Something was wrong
_errorErrors:
type: object
properties:
context:
type: string
example: Error with ...
message:
type: string
example: Something was wrong
MetricResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Metric'
_metricAvailability:
type: object
properties:
aggregations:
description: Available aggregations for this metric at the given resolution, e.g. 'avg', 'max'.
type: array
readOnly: true
items:
type: string
description: 'Valid values are `avg` and `max`.
'
example: avg
resolution:
description: An available resolution of this metric in milliseconds.
type: integer
format: int64
readOnly: true
example: 30000
retention:
description: The retention at this given resolution in milliseconds.
type: integer
format: int64
readOnly: true
example: 2592000000
x-readOnly: true
MetricHistoryResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MetricHistory'
MetricHistoryGetResponse:
allOf:
- $ref: '#/components/schemas/PageInfo'
- $ref: '#/components/schemas/MetricHistoryResponse'
_fixedReferenceFqdn:
allOf:
- $ref: '#/components/schemas/_fixedReference'
- type: object
properties:
fqdn:
description: 'The fully qualified domain name of the appliance when `resource_type` is `arrays`,
`null` otherwise.
'
type: string
readOnly: true
example: example_name.dc1.example.com
_builtInAsOf:
description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support
settings). Some correspond to a piece of software, like an app, or hardware,
like a controller. Others are created by the system in response to some event
(e.g., alerts, audit records).
Typically, a user can''t create, delete or rename a built-in resource. A few
can be created or deleted, but not renamed because the names are meaningful
to Purity (e.g., VIFs).
'
allOf:
- $ref: '#/components/schemas/_timeAware'
- type: object
properties:
id:
description: A non-modifiable, globally unique ID chosen by the system.
type: string
readOnly: true
example: 01c2889a-4124-49ff-8cbd-c33405ede123
name:
description: A non-modifiable, locally unique name chosen by the system.
type: string
readOnly: true
example: example_name
MetricHistory:
allOf:
- $ref: '#/components/schemas/_builtInAsOf'
- description: 'Historical time-series data of a given metric on a resource.
'
type: object
properties:
aggregation:
description: The aggregation of the metric data.
type: string
readOnly: true
example: avg
data:
description: 'The data points of the metric corresponding to the time window,
resolution and aggregation. The points are returned in a nested array
of 2-element arrays. For each of the 2-element array, the 1st element
is the UTC millisecond epoch, and the 2nd element is the value,
e.g. [[1519362000000, 11], [1519362030000, 21], ...].
'
type: array
readOnly: true
items:
type: array
example:
- 1502729489760
- 123
items:
type: number
resolution:
description: The resolution of the metric data in milliseconds.
type: integer
format: int64
readOnly: true
example: 30000
resources:
description: 'The references to the resources that the metric data is for.
For example, write-iops metric for an array will have one element in
this list referencing the array entity. the write-iops from an array to
a pod will contain two elements in this list - first element pointing
to the array, and second element pointing to the pod.
'
type: array
readOnly: true
items:
$ref: '#/components/schemas/_fixedReferenceFqdn'
unit:
description: The unit of the metric data.
type: string
readOnly: true
example: B/s
x-readOnly: true
Metric:
description: 'A type of measurement recorded on a resource.
'
allOf:
- $ref: '#/components/schemas/_builtInAsOf'
- type: object
properties:
availabilities:
description: 'The available resolutions, aggregations and retentions of this metric.
'
type: array
readOnly: true
items:
$ref: '#/components/schemas/_metricAvailability'
description:
description: The additional description for the the metric.
type: string
readOnly: true
resource_types:
description: 'The type of resource (as described by their endpoints) that this metric
is available at. NOTE that a metric could be available for a combination
of resource types, e.g. mirrored writes from "arrays" to "pods".
'
type: array
readOnly: true
items:
type: string
description: 'Valid values are `arrays`, `pods`, and `volumes`.
'
example: example_resource_type
unit:
description: The unit of the metric.
type: string
readOnly: true
example: B/s
x-readOnly: true
_fixedReference:
type: object
properties:
id:
description: The opaque and unique id of this resource.
type: string
readOnly: true
example: 2a989a09-c851-4d52-9ec6-ab728b1c04db
name:
description: The name of this resource.
type: string
readOnly: true
example: example_name
resource_type:
description: 'The type of this resource represented by the name of its REST endpoint.
For example, "arrays", "network-interfaces", and "metrics".
The value may be `null` if the resource is not represented.
'
type: string
readOnly: true
example: example_resource_type
x-readOnly: true
PageInfo:
type: object
properties:
continuation_token:
description: 'Continuation token that can be provided in the continuation_token
query param to get the next page of data.
If you use the continuation token to page through data you
are guaranteed to get all items exactly once regardless of
how items are modified. If an item is added or deleted during
the pagination then it may or may not be returned.
The continuation token is generated if the limit is less
than the remaining number of items, and the default sort is used
(no sort is specified).
'
type: string
example: MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My
total_item_count:
description: Total number of items after applying filter params.
type: integer
format: int32
example: 1
responses:
Error404:
description: NOT FOUND
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: object
X-RateLimit-Remaining-minute:
description: 'The number of requests remaining for the organization in that minute.
'
schema:
type: object
X-RateLimit-Remaining-second:
description: 'The number of requests remaining for the organization in that second.
'
schema:
type: object
X-RateLimit-Limit-minute:
description: The number of requests available per minute.
schema:
type: object
X-RateLimit-Limit-second:
description: The number of requests available per second.
schema:
type: object
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Error500:
description: INTERNAL SERVER ERROR
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: object
X-RateLimit-Remaining-minute:
description: 'The number of requests remaining for the organization in that minute.
'
schema:
type: object
X-RateLimit-Remaining-second:
description: 'The number of requests remaining for the organization in that second.
'
schema:
type: object
X-RateLimit-Limit-minute:
description: The number of requests available per minute.
schema:
type: object
X-RateLimit-Limit-second:
description: The number of requests available per second.
schema:
type: object
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Error403:
description: FORBIDDEN
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: object
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorNoContext'
Error400:
description: BAD REQUEST
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: object
X-RateLimit-Remaining-minute:
description: 'The number of requests remaining for the organization in that minute.
'
schema:
type: object
X-RateLimit-Remaining-second:
description: 'The number of requests remaining for the organization in that second.
'
schema:
type: object
X-RateLimit-Limit-minute:
description: The number of requests available per minute.
schema:
type: object
X-RateLimit-Limit-second:
description: The number of requests available per second.
schema:
type: object
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Error429:
description: TOO MANY REQUESTS
headers:
X-Request-ID:
description: Supplied by client during request or generated by server.
schema:
type: object
X-RateLimit-Remaining-minute:
description: 'The number of requests remaining for the organization in that minute.
'
schema:
type: object
X-RateLimit-Remaining-second:
description: 'The number of requests remaining for the organization in that second.
'
schema:
type: object
X-RateLimit-Limit-minute:
description: The number of requests available per minute.
schema:
type: object
X-RateLimit-Limit-second:
description: The number of requests available per second.
schema:
type: object
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorNoContext'
parameters:
NamesRequired:
name: names
in: query
description: 'REQUIRED: either `names` or `ids`.
A comma-separated list of resource names.
If there is not at least one resource that matches each `name` element,
an error is returned.
Single quotes are required around all strings.
'
style: form
explode: false
schema:
type: array
items:
type: string
x-quoted: true
x-quoted: true
Offset:
name: offset
in: query
description: 'The offset of the first resource to return from a collection.
'
schema:
type: integer
format: int32
minimum: 0
Filter:
name: filter
in: query
description: 'Exclude resources that don''t match the specified criteria.
Single quotes are required around all strings inside the filters.
'
schema:
type: string
Continuation_token:
name: continuation_token
in: query
description: 'An opaque token used to iterate over a collection.
The token to use on the next request is returned in the
`continuation_token` field of the result.
Single quotes are required around all strings.
'
schema:
type: string
x-quoted: true
x-quoted: true
XRequestId:
name: X-Request-ID
in: header
description: 'Supplied by client during request or generated by server.
'
schema:
type: string
Limit:
name: limit
in: query
description: 'Limit the size of the response to the specified number of resources.
A limit of 0 can be used to get the number of resources without getting
all of the resources. It will be returned in the total_item_count field.
If a client asks for a page size larger than the maximum number, the request
is still valid. In that case the server just returns the maximum number of
items, disregarding the client''s page size request. If not specified, defaults
to 1000.
'
schema:
type: integer
format: int32
IdsRequired:
name: ids
in: query
description: 'REQUIRED: either `ids` or `names`.
A comma-separated list of object IDs.
If there is not at least one resource that matches each `id` element,
an error is returned.
Single quotes are required around all strings.
'
style: form
explode: false
schema:
type: array
items:
type: string
x-quoted: true
x-quoted: true
Resource_idsRequired:
name: resource_ids
in: query
description: 'REQUIRED: either `resource_ids` or `resource_names`.
A comma-separated list of resource IDs.
If there is not at least one resource that matches each `resource_id` element,
an error is returned.
Single quotes are required around all strings.
'
style: form
explode: false
schema:
type: array
items:
type: string
x-quoted: true
x-quoted: true
Authorization:
name: Authorization
in: header
description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`)
'
schema:
type: string
Names:
name: names
in: query
description: 'A comma-separated list of resource names.
If there is not at least one resource that matches each `name` element,
an error is returned.
Single quotes are required around all strings.
'
style: form
explode: false
schema:
type: array
items:
type: string
x-quoted: true
x-quoted: true
Resource_types:
name: resource_types
in: query
description: 'The resource types to list the available metrics.
Valid values are `arrays`, `buckets`, `directories`,
`file-systems`, `pods`, `subscription-licenses` and
`volumes`.
A metric can belong to a combination of resources,
e.g., write-iops from array to pod. In that case, query by
[''arrays'', ''pods''].
Single quotes are required around all strings.
'
style: form
explode: false
schema:
type: array
items:
type: string
x-quoted: true
x-quoted: true
Resource_namesRequired:
name: resource_names
in: query
description: 'REQUIRED: either `resource_ids` or `resource_names`.
A comma-separated list of resource names.
If there is not at least one resource that matches each `resource_name`
element, an error is returned.
Single quotes are required around all strings.
'
style: form
explode: false
schema:
type: array
items:
type: string
x-quoted: true
x-quoted: true
Ids:
name: ids
in: query
description: 'A comma-separated list of resource IDs.
If there is not at least one resource that matches each `id` element,
an error is returned.
Single quotes are required around all strings.
'
style: form
explode: false
schema:
type: array
items:
type: string
x-quoted: true
x-quoted: true
Start_timeRequired:
name: start_time
in: query
description: 'Timestamp of when the time window starts. Measured in milliseconds since the UNIX epoch.
'
required: true
schema:
type: integer
format: int64
ResolutionRequired:
name: resolution
in: query
description: 'The duration of time between individual data points, in milliseconds.
'
required: true
schema:
type: integer
format: int64
AggregationRequired:
name: aggregation
in: query
description: 'Aggregation needed on the metric data.
Valid values are `avg` and `max`.
Single quotes are required around all strings.
Latency metrics averages are weighted by the IOPS.
'
required: true
schema:
type: string
x-quoted: true
x-quoted: true
End_timeRequired:
name: end_time
in: query
description: 'Timestamp of when the time window ends. Measured in milliseconds since the UNIX epoch.
'
required: true
schema:
type: integer
format: int64
Sort:
name: sort
in: query
description: 'Sort the response by the specified fields (in descending order if ''-''
is appended to the field name).
If you provide a sort you will not get a continuation token in
the response.
'
style: form
explode: false
schema:
type: array
items:
pattern: ^[a-z]+(_[a-z]+)*-?
type: string