Retrieve an application
GET /application/applications/{uuid}
Introduced In: 9.6
Retrieves an application
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.
-
<template>
the property corresponding to thetemplate.name
of the application
Property overview
An application includes three main groups or properties.
-
Generic properties - such as the
name
,template.name
, andstate
of the application. These properties are all inexpensive to retrieve and their meaning is consistent for every type of application. -
statistics.*
- application statistics report live usage data about the application and its components. Various space and IOPS details are included at both the application level and at a per component level. The application model includes a detailed description of each property. These properties are slightly more expensive than the generic properties because live data must be collected from every storage element in the application. -
<template>
- the property corresponding to the value of thetemplate.name
returns the contents of the application in the same layout that was used to provision the application. This information is very expensive to retrieve because it requires collecting information about all the storage and access settings for every element of the application. There are a few notable limitations to what can be returned in the<template>
section:-
The
new_igroups
array of many SAN templates is not returned by GET. This property allows igroup creation in the same call that creates an application, but is not a property of the application itself. Thenew_igroups
array is allowed during PATCH operations, but that does not modify thenew_igroups
of the application. It is another way to allow igroup creation while updating the application to use a different igroup. -
The
vdi_on_san
andvdi_on_nas
desktops.count
property is rounded to the nearest 1000 during creation, and is reported with that rounding applied. -
The
mongo_db_on_san
dataset.element_count
property is rounded up to an even number, and is reported with that rounding applied. -
The
sql_on_san
andsql_on_smb
server_cores_count
property is limited to 8 for GET operations. Higher values are accepted by POST, but the impact of theserver_cores_count
property on the application layout currently reaches its limit at 8.
-
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
uuid |
string |
path |
True |
Application UUID |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
creation_timestamp |
string |
The time when the application was created. |
delete_data |
boolean |
Should application storage elements be deleted? An application is considered to use storage elements from a shared storage pool. Possible values are 'true' and 'false'. If the value is 'true', the application will be deleted in its entirety. If the value is 'false', the storage elements will be disassociated from the application and preserved. The application will then be deleted. |
generation |
integer |
The generation number of the application. This indicates which features are supported on the application. For example, generation 1 applications do not support Snapshot copies. Support for Snapshot copies was added at generation 2. Any future generation numbers and their feature set will be documented. |
mongo_db_on_san |
MongoDB using SAN. |
|
name |
string |
Application Name. This field is user supplied when the application is created. |
nas |
A generic NAS application. |
|
nvme |
An NVME application. |
|
oracle_on_nfs |
Oracle using NFS. |
|
oracle_on_san |
Oracle using SAN. |
|
oracle_rac_on_nfs |
Oracle RAC using NFS. |
|
oracle_rac_on_san |
Oracle RAC using SAN. |
|
protection_granularity |
string |
Protection granularity determines the scope of Snapshot copy operations for the application. Possible values are "application" and "component". If the value is "application", Snapshot copy operations are performed on the entire application. If the value is "component", Snapshot copy operations are performed separately on the application components. |
rpo |
||
s3_bucket |
A generic S3 bucket application. |
|
san |
A generic SAN application. |
|
smart_container |
boolean |
Identifies if this is a smart container or not. |
sql_on_san |
Microsoft SQL using SAN. |
|
sql_on_smb |
Microsoft SQL using SMB. |
|
state |
string |
The state of the application. For full functionality, applications must be in the online state. Other states indicate that the application is in a transient state and not all operations are supported. |
statistics |
||
svm |
||
template |
||
uuid |
string |
Application UUID. This field is generated when the application is created. |
vdi_on_nas |
A VDI application using NAS. |
|
vdi_on_san |
A VDI application using SAN. |
|
vsi_on_nas |
A VSI application using NAS. |
|
vsi_on_san |
A VSI application using SAN. |
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
},
"snapshots": {
"href": "/api/resourcelink"
}
},
"creation_timestamp": "string",
"generation": 0,
"name": "string",
"nas": {
"application_components": [
{
}
],
"cifs_access": [
{
"access": "string",
"user_or_group": "string"
}
],
"cifs_share_name": "string",
"exclude_aggregates": [
{
"name": "string",
"uuid": "string"
}
],
"nfs_access": [
{
"access": "string",
"host": "string"
}
],
"protection_type": {
"local_policy": "string",
"local_rpo": "string",
"remote_rpo": "string"
}
},
"nvme": {
"components": [
{
"name": "string",
"os_type": "string",
"performance": {
"storage_service": {
"name": "string"
}
},
"qos": {
"policy": {
"name": "string",
"uuid": "string"
}
},
"subsystem": {
"hosts": [
{
"dh_hmac_chap": {
"controller_secret_key": "string",
"group_size": "string",
"hash_function": "string",
"host_secret_key": "string"
},
"nqn": "string",
"priority": "string"
}
],
"name": "string",
"os_type": "string",
"uuid": "string"
},
"tiering": {
"control": "string",
"object_stores": [
{
"name": "string"
}
],
"policy": "string"
}
}
],
"os_type": "string",
"rpo": {
"local": {
"name": "string",
"policy": "string"
},
"remote": {
"name": "string"
}
}
},
"protection_granularity": "string",
"rpo": {
"components": [
{
"name": "string",
"rpo": {
"local": {
"description": "string",
"name": "string"
},
"remote": {
"description": "string",
"name": "string"
}
},
"uuid": "string"
}
],
"local": {
"description": "string",
"name": "string"
},
"remote": {
"description": "string",
"name": "string"
}
},
"s3_bucket": {
"application_components": [
{
"access_policies": [
{
"actions": [
"string"
],
"conditions": [
{
"delimiters": [
"string"
],
"max_keys": [
"integer"
],
"operator": "string",
"prefixes": [
"string"
],
"source_ips": [
"string"
],
"usernames": [
"string"
]
}
],
"effect": "string",
"principals": [
"string"
],
"resources": [
"string"
],
"sid": "string"
}
],
"bucket_endpoint_type": "string",
"comment": "string",
"default_retention_period": "string",
"exclude_aggregates": [
{
"name": "string",
"uuid": "string"
}
],
"name": "string",
"nas_path": "string",
"qos": {
"policy": {
"name": "string",
"uuid": "string"
}
},
"retention_mode": "string",
"storage_service": {
"name": "string"
},
"uuid": "string",
"versioning_state": "string"
}
],
"protection_type": {
"remote_rpo": "string"
}
},
"san": {
"application_components": [
{
"igroup_name": "string",
"name": "string",
"os_type": "string",
"qos": {
"policy": {
"name": "string",
"uuid": "string"
}
},
"storage_service": {
"name": "string"
},
"tiering": {
"control": "string",
"object_stores": [
{
"name": "string"
}
],
"policy": "string"
}
}
],
"exclude_aggregates": [
{
"name": "string",
"uuid": "string"
}
],
"new_igroups": [
{
"comment": "string",
"igroups": [
{
"name": "string",
"uuid": "string"
}
],
"initiator_objects": [
{
"comment": "string",
"name": "string"
}
],
"initiators": [
"string"
],
"name": "string",
"os_type": "string",
"protocol": "string"
}
],
"os_type": "string",
"protection_type": {
"local_policy": "string",
"local_rpo": "string",
"remote_rpo": "string"
}
},
"state": "string",
"statistics": {
"components": [
{
"iops": {
"per_tb": 0,
"total": 0
},
"latency": {
"average": 0,
"raw": 0
},
"name": "string",
"snapshot": {
"reserve": 0,
"used": 0
},
"space": {
"available": 0,
"logical_used": 0,
"provisioned": 0,
"reserved_unused": 0,
"savings": 0,
"used": 0,
"used_excluding_reserves": 0,
"used_percent": 0
},
"storage_service": {
"name": "string",
"uuid": "string"
},
"uuid": "string"
}
],
"iops": {
"per_tb": 0,
"total": 0
},
"latency": {
"average": 0,
"raw": 0
},
"snapshot": {
"reserve": 0,
"used": 0
},
"space": {
"available": 0,
"logical_used": 0,
"provisioned": 0,
"reserved_unused": 0,
"savings": 0,
"used": 0,
"used_excluding_reserves": 0,
"used_percent": 0
}
},
"svm": {
"name": "string",
"uuid": "string"
},
"template": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "string",
"protocol": "string",
"version": 0
},
"uuid": "string"
}
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 |
---|---|---|
self |
||
snapshots |
storage_service
Name | Type | Description |
---|---|---|
name |
string |
The storage service of the database. |
dataset
Name | Type | Description |
---|---|---|
element_count |
integer |
The number of storage elements (LUNs for SAN) of the database to maintain. Must be an even number between 2 and 16. Odd numbers will be rounded up to the next even number within range. |
replication_factor |
integer |
The number of data bearing members of the replicaset, including 1 primary and at least 1 secondary. |
size |
integer |
The size of the database. Usage: {<integer>[KB|MB|GB|TB|PB]} |
storage_service |
igroups
Name | Type | Description |
---|---|---|
name |
string |
The name of an igroup to nest within a parent igroup. Mutually exclusive with initiators and initiator_objects. |
uuid |
string |
The UUID of an igroup to nest within a parent igroup Usage: <UUID> |
initiator_objects
Name | Type | Description |
---|---|---|
comment |
string |
A comment available for use by the administrator. |
name |
string |
The WWPN, IQN, or Alias of the initiator. Mutually exclusive with nested igroups and the initiators array. |
mongo_db_on_san_new_igroups
The list of initiator groups to create.
Name | Type | Description |
---|---|---|
comment |
string |
A comment available for use by the administrator. |
igroups |
array[igroups] |
|
initiator_objects |
array[initiator_objects] |
|
initiators |
array[string] |
|
name |
string |
The name of the new initiator group. |
os_type |
string |
The name of the host OS accessing the application. The default value is the host OS that is running the application. |
protocol |
string |
The protocol of the new initiator group. |
protection_type
Name | Type | Description |
---|---|---|
local_rpo |
string |
The local RPO of the application. |
remote_rpo |
string |
The remote RPO of the application. |
secondary_igroups
Name | Type | Description |
---|---|---|
name |
string |
The name of the initiator group for each secondary. |
mongo_db_on_san
MongoDB using SAN.
Name | Type | Description |
---|---|---|
dataset |
||
new_igroups |
array[mongo_db_on_san_new_igroups] |
The list of initiator groups to create. |
os_type |
string |
The name of the host OS running the application. |
primary_igroup_name |
string |
The initiator group for the primary. |
prot |