Retrieve FC protocol services
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /protocols/san/fcp/services
Introduced In: 9.6
Retrieves FC Protocol services.
Expensive properties
There is an added computational cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields
query parameter. See Requesting specific fields to learn more.
-
statistics.*
-
metric.*
Related ONTAP commands
-
vserver fcp show
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
metric.duration |
string |
query |
False |
Filter by metric.duration
|
metric.throughput.total |
integer |
query |
False |
Filter by metric.throughput.total
|
metric.throughput.write |
integer |
query |
False |
Filter by metric.throughput.write
|
metric.throughput.read |
integer |
query |
False |
Filter by metric.throughput.read
|
metric.status |
string |
query |
False |
Filter by metric.status
|
metric.iops.write |
integer |
query |
False |
Filter by metric.iops.write
|
metric.iops.read |
integer |
query |
False |
Filter by metric.iops.read
|
metric.iops.other |
integer |
query |
False |
Filter by metric.iops.other
|
metric.iops.total |
integer |
query |
False |
Filter by metric.iops.total
|
metric.timestamp |
string |
query |
False |
Filter by metric.timestamp
|
metric.latency.write |
integer |
query |
False |
Filter by metric.latency.write
|
metric.latency.read |
integer |
query |
False |
Filter by metric.latency.read
|
metric.latency.other |
integer |
query |
False |
Filter by metric.latency.other
|
metric.latency.total |
integer |
query |
False |
Filter by metric.latency.total
|
enabled |
boolean |
query |
False |
Filter by enabled |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
svm.name |
string |
query |
False |
Filter by svm.name |
statistics.iops_raw.write |
integer |
query |
False |
Filter by statistics.iops_raw.write
|
statistics.iops_raw.read |
integer |
query |
False |
Filter by statistics.iops_raw.read
|
statistics.iops_raw.other |
integer |
query |
False |
Filter by statistics.iops_raw.other
|
statistics.iops_raw.total |
integer |
query |
False |
Filter by statistics.iops_raw.total
|
statistics.status |
string |
query |
False |
Filter by statistics.status
|
statistics.throughput_raw.total |
integer |
query |
False |
Filter by statistics.throughput_raw.total
|
statistics.throughput_raw.write |
integer |
query |
False |
Filter by statistics.throughput_raw.write
|
statistics.throughput_raw.read |
integer |
query |
False |
Filter by statistics.throughput_raw.read
|
statistics.latency_raw.write |
integer |
query |
False |
Filter by statistics.latency_raw.write
|
statistics.latency_raw.read |
integer |
query |
False |
Filter by statistics.latency_raw.read
|
statistics.latency_raw.other |
integer |
query |
False |
Filter by statistics.latency_raw.other
|
statistics.latency_raw.total |
integer |
query |
False |
Filter by statistics.latency_raw.total
|
statistics.timestamp |
string |
query |
False |
Filter by statistics.timestamp
|
target.name |
string |
query |
False |
Filter by target.name
|
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
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.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
num_records |
integer |
The number of records in the response. |
records |
array[fcp_service] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"metric": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"duration": "PT15S",
"iops": {
"read": 200,
"total": 1000,
"write": 100
},
"latency": {
"read": 200,
"total": 1000,
"write": 100
},
"status": "ok",
"throughput": {
"read": 200,
"total": 1000,
"write": 100
},
"timestamp": "2017-01-25 06:20:13 -0500"
},
"statistics": {
"iops_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"latency_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"status": "ok",
"throughput_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"timestamp": "2017-01-25 06:20:13 -0500"
},
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"target": {
"name": "20:00:00:50:56:bb:b2:4b"
}
}
]
}
Error
Status: Default, Error
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
next |
||
self |
_links
Name | Type | Description |
---|---|---|
self |
iops
The rate of I/O operations observed at the storage object.
Name | Type | Description |
---|---|---|
other |
integer |
Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on. |
read |
integer |
Performance metric for read I/O operations. |
total |
integer |
Performance metric aggregated over all types of I/O operations. |
write |
integer |
Peformance metric for write I/O operations. |
latency
The round trip latency in microseconds observed at the storage object.
Name | Type | Description |
---|---|---|
other |
integer |
Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on. |
read |
integer |
Performance metric for read I/O operations. |
total |
integer |
Performance metric aggregated over all types of I/O operations. |
write |
integer |
Peformance metric for write I/O operations. |
throughput
The rate of throughput bytes per second observed at the storage object.
Name | Type | Description |
---|---|---|
read |
integer |
Performance metric for read I/O operations. |
total |
integer |
Performance metric aggregated over all types of I/O operations. |
write |
integer |
Peformance metric for write I/O operations. |
metric
Performance numbers, such as IOPS latency and throughput, for SVM protocols.
Name | Type | Description |
---|---|---|
_links |
||
duration |
string |
The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations: |
iops |