Retrieve application components

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.

Query examples

Queries are limited on this API. Most of the details are nested under the nfs_access, cifs_access, or san_access properties, but those properties do not support queries, and properties nested under those properties cannot be requested individually in the current release.

The following query returns all application components with names beginning in secondary.

GET /application/applications/{application.uuid}/components?name=secondary*

The following query returns all application components at the extreme storage service.

GET /application/applications/{application.uuid}/components?storage_service.name=extreme

Learn more

DOC /application

Parameters

Name	Type	In	Required	Description
application.uuid	string	path	True	Application UUID
uuid	string	query	False	Filter by UUID
name	string	query	False	Filter by name
storage_service.name	string	query	False	Filter by storage_service.name
storage_service.uuid	string	query	False	Filter by storage_service.uuid
fields	array[string]	query	False	Specify the fields to return.
max_records	integer	query	False	Limit the number of records 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. Default value: 15 Max value: 120 Min value: 0
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
order_by	array[string]	query	False	Order results by specified fields and optional [asc

Name

Type

In

Required

Description

application.uuid

string

path

True

Application UUID

uuid

string

query

False

Filter by UUID

name

string

query

False

Filter by name

storage_service.name

string

query

False

Filter by storage_service.name

storage_service.uuid

string

query

False

Filter by storage_service.uuid

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records 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.

Default value: 15
Max value: 120
Min value: 0

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

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok

Name	Type	Description
_links	_links
num_records	integer	Number of records
records	array[application_component]

Name

Type

Description

_links

num_records

integer

Number of records

records

array[application_component]

Example response

{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_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": "lif1",
                    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
                    "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	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

Name

Type

Description

href

string

_links

Name	Type	Description
next	href
self	href

Name

Type

Description

self

href

_links

Name	Type	Description
self	href

Name

Type

Description

self

href

application

Name	Type	Description
_links	_links
name	string	Application name
uuid	string	The application UUID. Valid in URL.

Name

Type

Description

_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

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	string	Namespace name
size	integer	Namespace size
uuid	string	Namespace UUID

Name

Type

Description

_links

creation_timestamp

string

Namespace creation time

name

string

Namespace name

size

integer

Namespace size

uuid

string

Namespace UUID

application_volume_object

Volume object

Name	Type	Description
creation_timestamp	string	Creation time
name	string	Name
size	integer	Size
uuid	string	UUID

Name

Type

Description

creation_timestamp

string

Creation time

name

string

Name

size

integer

Size

uuid

string

UUID

application_backing_storage

Name	Type	Description
luns	array[application_lun_object]
namespaces	array[application_namespace_object]
volumes	array[application_volume_object]

Name

Type

Description

luns

array[application_lun_object]

namespaces

array[application_namespace_object]

volumes

array[application_volume_object]

backing_storage

Name	Type	Description
type	string	Backing storage type
uuid	string	Backing storage UUID

Name

Type

Description

type

string

Backing storage type

uuid

string

Backing storage UUID

permissions

Name	Type	Description
access	string	Access granted to the user or group
user_or_group	string	User or group

Name

Type

Description

access

string

Access granted to the user or group

user_or_group

string

User or group

server

Name	Type	Description
name	string	Server name

Name

Type

Description

name

string

Server name

Name	Type	Description
name	string	Share name

Name

Type

Description

name

string

Share name

application_cifs_properties

Name	Type	Description
backing_storage	backing_storage
ips	array[string]
path	string	Junction path
permissions	array[permissions]
server	server
share	share

Name

Type

Description

backing_storage

ips

array[string]

path

string

Junction path

permissions

array[permissions]

server

share

export_policy

Name	Type	Description
name	string	Export policy name

Name

Type

Description

name

string

Export policy name

permissions

Name	Type	Description
access	string	Access granted to the host
host	string	Host granted access

Name

Type

Description

access

string

Access granted to the host

host

string

Host granted access

application_nfs_properties

Name	Type	Description
backing_storage	backing_storage
export_policy	export_policy
ips	array[string]
path	string	Junction path
permissions	array[permissions]

Name

Type

Description

backing_storage

export_policy

ips

array[string]

path

string

Junction path

permissions

array[permissions]

self

Name	Type	Description
self	href

Name

Type

Description

self

href

_links

Name	Type	Description
self	self

Name

Type

Description

self

hosts

Name	Type	Description
_links	_links
nqn	string	Host

Name

Type

Description

_links

nqn

string

Host

subsystem

Name	Type	Description
_links	_links
hosts	array[hosts]
name	string	Subsystem name
uuid	string	Subsystem UUID

Name

Type

Description

_links

hosts

array[hosts]

name

string

Subsystem name

uuid

string

Subsystem UUID

subsystem_map

Subsystem map object

Name	Type	Description
anagrpid	string	Subsystem ANA group ID
nsid	string	Subsystem namespace ID
subsystem	subsystem

Name

Type

Description

anagrpid

string

Subsystem ANA group ID

nsid

string

Subsystem namespace ID

subsystem

application_nvme_access

Application NVME access

Name	Type	Description
backing_storage	backing_storage
is_clone	boolean	Clone
subsystem_map	subsystem_map	Subsystem map object

Name

Type

Description

backing_storage

is_clone

boolean

Clone

subsystem_map

Subsystem map object

local

Name	Type	Description
description	string	A detailed description of the local RPO. This includes details on the Snapshot copy schedule.
name	string	The local RPO of the component. This indicates how often component Snapshot copies are automatically created.

Name

Type

Description

description

string

A detailed description of the local RPO. This includes details on the Snapshot copy schedule.

name

string

The local RPO of the component. This indicates how often component Snapshot copies are automatically created.

remote

Name	Type	Description
description	string	A detailed description of the remote RPO.
name	string	The remote RPO of the component. A remote RPO of zero indicates that the component is synchronously replicated to another cluster.

Name

Type

Description

description

string

A detailed description of the remote RPO.

name

string

The remote RPO of the component. A remote RPO of zero indicates that the component is synchronously replicated to another cluster.

rpo

Name	Type	Description
local	local
remote	remote

Name

Type

Description

local

remote

application_protection_groups

Name	Type	Description
name	string	Protection group name
rpo	rpo
uuid	string	Protection group UUID

Name

Type

Description

name

string

Protection group name

rpo

uuid

string

Protection group UUID

fc_interface_reference

An FC interface.

Name	Type	Description
_links	_links
name	string	The name of the FC interface.
uuid	string	The unique identifier of the FC interface.
wwpn	string	The WWPN of the FC interface.

Name

Type

Description

_links

name

string

The name of the FC interface.

uuid

string

The unique identifier of the FC interface.

wwpn

string

The WWPN of the FC interface.

application_san_access_fcp_endpoint

A Fibre Channel Protocol (FCP) access endpoint for the LUN.

Name	Type	Description
interface	fc_interface_reference	An FC interface.

Name

Type

Description

interface

fc_interface_reference

An FC interface.

igroup

Name	Type	Description
initiators	array[string]
name	string	Igroup name
uuid	string	Igroup UUID

Name

Type

Description

initiators

array[string]

name

string

Igroup name

uuid

string

Igroup UUID

ip

IP information

Name	Type	Description
address	string	IPv4 or IPv6 address

Name

Type

Description

address

string

IPv4 or IPv6 address

interface

Name	Type	Description
_links	_links
ip	ip	IP information
name	string	The name of the interface.
uuid	string	The UUID that uniquely identifies the interface.

Name

Type

Description

_links

ip

IP information

name

string

The name of the interface.

uuid

string

The UUID that uniquely identifies the interface.

application_san_access_iscsi_endpoint

An iSCSI access endpoint for the LUN.

Name	Type	Description
_links	_links
interface	interface
port	integer	The TCP port number of the iSCSI access endpoint.

Name

Type

Description

_links

interface

port

integer

The TCP port number of the iSCSI access endpoint.

application_lun_mapping_object

Name	Type	Description
fcp	array[application_san_access_fcp_endpoint]	All possible Fibre Channel Protocol (FCP) access endpoints for the LUN.
igroup	igroup
iscsi	array[application_san_access_iscsi_endpoint]	All possible iSCSI access endpoints for the LUN.
lun_id	integer	LUN ID

Name

Type

Description

fcp

array[application_san_access_fcp_endpoint]

All possible Fibre Channel Protocol (FCP) access endpoints for the LUN.

igroup

iscsi

array[application_san_access_iscsi_endpoint]

All possible iSCSI access endpoints for the LUN.

lun_id

integer

LUN ID

application_san_access

Name	Type	Description
backing_storage	backing_storage
is_clone	boolean	Clone
lun_mappings	array[application_lun_mapping_object]
serial_number	string	LUN serial number

Name

Type

Description

backing_storage

is_clone

boolean

Clone

lun_mappings

array[application_lun_mapping_object]

serial_number

string

LUN serial number

storage_service

Name	Type	Description
name	string	Storage service name
uuid	string	Storage service UUID

Name

Type

Description

name

string

Storage service name

uuid

string

Storage service UUID

svm

Name	Type	Description
name	string	SVM name
uuid	string	SVM UUID

Name

Type

Description

name

string

SVM name

uuid

string

SVM UUID

application_component

Application component

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.

Name

Type

Description

_links

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

svm

uuid

string

The application component UUID. Valid in URL.

error_arguments

Name	Type	Description
code	string	Argument code
message	string	Message argument

Name

Type

Description

code

string

Argument code

message

string

Message argument

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.

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.

Retrieve application components

Creating your file...

Overview

Query examples

Learn more

Parameters

Response

Error

Definitions