Skip to main content
REST API reference

Retrieve connection status between a cache and origin volume

PDFs

GET /storage/flexcache/connection-status/{node}/{svm}/{local_fg_msid}/{remote_svm_uuid}/{remote_vol_const_msid}

Introduced In: 9.18

Retrieves connection status between a cache and origin volume.

  • volume flexcache connection-status show

Learn more

Parameters

Name Type In Required Description

node

string

path

True

Node Name

svm

string

path

True

SVM Name

local_fg_msid

integer

path

True

Local FG MSID

remote_svm_uuid

string

path

True

Remote SVM UUID

remote_vol_const_msid

integer

path

True

Remote Constituent MSID

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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.
Example response 
{
  "_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

self

href

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.