Skip to main content

Retrieve an application component

Contributors
PDFs

GET /application/applications/{application.uuid}/components/{uuid}

Introduced In: 9.6

Retrieves an application component.

Overview

The application component object exposes how to access an application. Most application interfaces abstract away the underlying ONTAP storage elements, but this interface exposes what is necessary to connect to and uses the storage that is provisioned for an application. See the application component model for a detailed description of each property.

Access

Each application component can be accessed via NFS, CIFS, or SAN. NFS and CIFS access can be enabled simultaneously. Each access section includes a backing_storage property. This property is used to correlate the storage elements with the access elements of the application. The backing_storage portion of the access section provides the type and uuid of the backing storage. There is another backing_storage property at the same level as the access properties which contains lists of backing storage elements corresponding to the types listed in the access section.

Learn more

Parameters

Name Type In Required Description

application.uuid

string

path

True

Application UUID

uuid

string

path

True

Application component UUID

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

application

application

backing_storage

application_backing_storage

cifs_access

array[application_cifs_properties]

file_system

string

Defines the type of file system that will be installed on this application component.

host_management_url

string

Host management URL

host_name

string

L2 Host FQDN

name

string

Application component name

nfs_access

array[application_nfs_properties]

nvme_access

array[application_nvme_access]

protection_groups

array[application_protection_groups]

san_access

array[application_san_access]

storage_service

storage_service

svm

svm

uuid

string

The application component UUID. Valid in URL.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "application": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "string",
    "uuid": "string"
  },
  "backing_storage": {
    "luns": [
      {
        "creation_timestamp": "string",
        "path": "string",
        "size": 0,
        "uuid": "string"
      }
    ],
    "namespaces": [
      {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "creation_timestamp": "string",
        "name": "string",
        "size": 0,
        "uuid": "string"
      }
    ],
    "volumes": [
      {
        "creation_timestamp": "string",
        "name": "string",
        "size": 0,
        "uuid": "string"
      }
    ]
  },
  "cifs_access": [
    {
      "backing_storage": {
        "type": "string",
        "uuid": "string"
      },
      "ips": [
        "string"
      ],
      "path": "string",
      "permissions": [
        {
          "access": "string",
          "user_or_group": "string"
        }
      ],
      "server": {
        "name": "string"
      },
      "share": {
        "name": "string"
      }
    }
  ],
  "file_system": "string",
  "host_management_url": "string",
  "host_name": "string",
  "name": "string",
  "nfs_access": [
    {
      "backing_storage": {
        "type": "string",
        "uuid": "string"
      },
      "export_policy": {
        "name": "string"
      },
      "ips": [
        "string"
      ],
      "path": "string",
      "permissions": [
        {
          "access": "string",
          "host": "string"
        }
      ]
    }
  ],
  "nvme_access": [
    {
      "backing_storage": {
        "type": "string",
        "uuid": "string"
      },
      "subsystem_map": {
        "anagrpid": "string",
        "nsid": "string",
        "subsystem": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "hosts": [
            {
              "_links": {
                "self": {
                  "self": {
                    "href": "/api/resourcelink"
                  }
                }
              },
              "nqn": "string"
            }
          ],
          "name": "string",
          "uuid": "string"
        }
      }
    }
  ],
  "protection_groups": [
    {
      "name": "string",
      "rpo": {
        "local": {
          "description": "string",
          "name": "string"
        },
        "remote": {
          "description": "string",
          "name": "string"
        }
      },
      "uuid": "string"
    }
  ],
  "san_access": [
    {
      "backing_storage": {
        "type": "string",
        "uuid": "string"
      },
      "lun_mappings": [
        {
          "fcp": [
            {
              "interface": {
                "_links": {
                  "self": {
                    "href": "/api/resourcelink"
                  }
                },
                "name": "fc_lif1",
                "uuid": "3a09ab42-4da1-32cf-9d35-3385a6101a0b",
                "wwpn": "20:00:00:50:56:b4:13:a8"
              }
            }
          ],
          "igroup": {
            "initiators": [
              "string"
            ],
            "name": "string",
            "uuid": "string"
          },
          "iscsi": [
            {
              "_links": {
                "self": {
                  "href": "/api/resourcelink"
                }
              },
              "interface": {
                "_links": {
                  "self": {
                    "href": "/api/resourcelink"
                  }
                },
                "ip": {
                  "address": "10.10.10.7"
                },
                "name": "lif1",
                "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
              },
              "port": 3260
            }
          ],
          "lun_id": 0
        }
      ],
      "serial_number": "string"
    }
  ],
  "storage_service": {
    "name": "string",
    "uuid": "string"
  },
  "svm": {
    "name": "string",
    "uuid": "string"
  },
  "uuid": "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

_links

Name Type Description

self

href

application

Name Type Description

_links

_links

name

string

Application name

uuid

string

The application UUID. Valid in URL.

application_lun_object

LUN object

Name Type Description

creation_timestamp

string

LUN creation time

path

string

LUN path

size

integer

LUN size

uuid

string

LUN UUID

application_namespace_object

Namespace object

Name Type Description

_links

_links

creation_timestamp

string

Namespace creation time

name