Retrieve the historical performance and capacity metrics for a consistency group
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /application/consistency-groups/{consistency_group.uuid}/metrics
Introduced In: 9.13
Retrieves historical performance and capacity metrics for a consistency group.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
used_space |
integer |
query |
False |
Filter by used_space |
size |
integer |
query |
False |
Filter by size |
status |
string |
query |
False |
Filter by status |
iops.write |
integer |
query |
False |
Filter by iops.write |
iops.read |
integer |
query |
False |
Filter by iops.read |
iops.other |
integer |
query |
False |
Filter by iops.other |
iops.total |
integer |
query |
False |
Filter by iops.total |
timestamp |
string |
query |
False |
Filter by timestamp |
latency.write |
integer |
query |
False |
Filter by latency.write |
latency.read |
integer |
query |
False |
Filter by latency.read |
latency.other |
integer |
query |
False |
Filter by latency.other |
latency.total |
integer |
query |
False |
Filter by latency.total |
throughput.write |
integer |
query |
False |
Filter by throughput.write |
throughput.read |
integer |
query |
False |
Filter by throughput.read |
throughput.other |
integer |
query |
False |
Filter by throughput.other |
throughput.total |
integer |
query |
False |
Filter by throughput.total |
duration |
string |
query |
False |
Filter by duration |
available_space |
integer |
query |
False |
Filter by available_space |
consistency_group.uuid |
string |
path |
True |
Unique identifier of the consistency group. |
interval |
string |
query |
False |
The time range for the data. Examples can be 1h, 1d, 1w, 1m, 1y. The period for each time range is as follows:
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
desc] direction. Default direction is 'asc' for ascending. |
return_records |
boolean |
query |
False |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
num_records |
integer |
Number of records |
records |
array[records] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"available_space": 4096,
"duration": "PT15S",
"iops": {
"read": 200,
"total": 1000,
"write": 100
},
"latency": {
"read": 200,
"total": 1000,
"write": 100
},
"size": 4096,
"status": "ok",
"throughput": {
"read": 200,
"total": 1000,
"write": 100
},
"timestamp": "2017-01-25 06:20:13 -0500",
"used_space": 4096
}
]
}