Skip to main content
REST API reference

Retrieve connection status between cache and origin volumes

PDFs

GET /storage/flexcache/connection-status

Introduced In: 9.18

Retrieves attributes of the connection status between cache and origin volumes.

  • volume flexcache connection-status show

Learn more

Parameters

Name Type In Required Description

local_fg_msid

integer

query

False

Filter by local_fg_msid

remote_vol_const_msid

integer

query

False

Filter by remote_vol_const_msid

node

string

query

False

Filter by node

remote_endpoint

string

query

False

Filter by remote_endpoint

remote_svm_uuid

string

query

False

Filter by remote_svm_uuid

last_update_time

string

query

False

Filter by last_update_time

svm

string

query

False

Filter by svm

remote_cluster

string

query

False

Filter by remote_cluster

svm_uuid

string

query

False

Filter by svm_uuid

conn_state

string

query

False

Filter by conn_state

volume

string

query

False

Filter by volume

remote_volume

string

query

False

Filter by remote_volume

remote_svm

string

query

False

Filter by remote_svm

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.

  • Default value: 1

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.

  • Default value: 15

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

collection_links

num_records

integer

Number of Records

records

array[connection_status]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "conn_state": "string",
      "last_update_time": "2018-06-04 19:00:00 +0000",
      "local_fg_msid": 0,
      "node": "string",
      "remote_cluster": "string",
      "remote_endpoint": "string",
      "remote_svm": "string",
      "remote_svm_uuid": "string",
      "remote_vol_const_msid": 0,
      "remote_volume": "string",
      "svm": "string",
      "svm_uuid": "string",
      "volume": "string"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

returned_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
Name Type Description

next

href

self

href
Name Type Description

self

href

connection_status

FlexCache Connection Status Endpoint

Name Type Description

_links

self_link

conn_state

string

Connection Status between the Flexcache and Origin volumes.

last_update_time

string

Last update time of the connection status.

local_fg_msid

integer

The local volume's Master Set ID.

node

string

Name of the node.

remote_cluster

string

Remote cluster.

remote_endpoint

string

Remote endpoint type.

remote_svm

string

Remote volume SVM.

remote_svm_uuid

string

Remote SVM UUID.

remote_vol_const_msid

integer

Remote volume's Master Set ID.

remote_volume

string

Remote Volume name.

svm

string

Volume SVM.

svm_uuid

string

Local SVM UUID.

volume

string

Local Volume name.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.