GET Syntax Details

GET https://<array_name>:<port_number>/<version_number>/<object_set><addition_query_parameter><query_parameter>

Note: Use the following substitutions for the variables in the query.

<array_name> = array management IP address or fully qualified domain name (FQDN)
<port_number> = 5392
<version_number> = v1
<object_set> = supported object set name, such as volumes
<qualifiers> = optional parameters, such as /detail to show verbose details about an object set, /<ID> to narrow down an object set results to only one object.
<query_parameter> = the ? character appened to <object_set_name> or <query_parameter> to filter for specific rows or fields.

Examples:

Return a list of volumes:

GET https://<array_name>:5392/v1/volumes

Expected output:
{ "data": [ { "id": "0600000000000004d3000000000000000000000001", "name": "myvol1" } ], "endRow": 1, "startRow": 0, "totalRows": 1 }

Return verbose details for all volumes in the array:

GET https://<array_name>:5392/v1/volumes/detail

Expected output:

{
    "data": [
        {
            "access_control_records": [
                {
                    "access_protocol": "iscsi", 
                    "acl_id": "0d00000000000004d3000000000000000000000001", 
                    "apply_to": "both", 
                    "chap_user_id": "", 
                    "chap_user_name": "*", 
                    "initiator_group_id": "", 
                    "initiator_group_name": "*", 
                    "lun": 0
                }
            ], 
            "agent_type": "none", 
            "app_uuid": "", 
            "base_snap_id": "", 
            "base_snap_name": "", 
            "block_size": 4096, 
            "cache_needed_for_pin": 104857600, 
            "cache_pinned": false, 
            "cache_policy": "normal", 
            "caching_enabled": true, 
            "clone": false, 
            "creation_time": 1430516996, 
            "description": "", 
            "dest_pool_id": "", 
            "dest_pool_name": "", 
            "encryption_cipher": "none", 
            "fc_sessions": null, 
            "full_name": "", 
            "id": "0600000000000004d3000000000000000000000001", 
            "iscsi_sessions": null, 
            "last_modified": 1430516996, 
            "limit": 100, 
            "metadata": null, 
            "move_aborting": false, 
            "move_bytes_migrated": 0, 
            "move_bytes_remaining": 0, 
            "move_start_time": 0, 
            "multi_initiator": false, 
            "name": "myvol1", 
            "num_connections": 0, 
            "num_fc_connections": 0, 
            "num_iscsi_connections": 0, 
            "num_snaps": 0, 
            "offline_reason": null, 
            "online": true, 
            "online_snaps": null, 
            "owned_by_group": "g1a1", 
            "parent_vol_id": "", 
            "parent_vol_name": "", 
            "perfpolicy_id": "0300000000000004d3000000000000000000000001", 
            "perfpolicy_name": "default", 
            "pinned_cache_size": 0, 
            "pool_id": "0a00000000000004d3000000000000000000000001", 
            "pool_name": "default", 
            "projected_num_snaps": 0, 
            "read_only": false, 
            "reserve": 0, 
            "search_name": "myvol1", 
            "serial_number": "9965f28016895f826c9ce900d3040000", 
            "size": 100, 
            "snap_limit": 9223372036854775807, 
            "snap_reserve": 0, 
            "snap_usage_compressed_bytes": 0, 
            "snap_usage_populated_bytes": 0, 
            "snap_usage_uncompressed_bytes": 0, 
            "snap_warn_level": 0, 
            "target_name": "iqn.2007-11.com.nimblestorage:myvol1-v00000000000004d3.00000001.000004d3", 
            "thinly_provisioned": true, 
            "upstream_cache_pinned": false, 
            "usage_valid": true, 
            "vol_state": "online", 
            "vol_usage_compressed_bytes": 0, 
            "vol_usage_uncompressed_bytes": 0, 
            "volcoll_id": "", 
            "volcoll_name": "", 
            "warn_level": 80
        }
    ], 
    "endRow": 1, 
    "startRow": 0, 
    "totalRows": 1
}

Retrieve information on a specific volume of interest, with the volume ID of “060df0fe6f7dc7bb160000000000000000000001be” as input:

GET https://<array_name>.com:5392/v1/volumes/060df0fe6f7dc7bb160000000000000000000001be

Expected output:

{
    "data": {
        "access_control_records": [
            {
                "access_protocol": "iscsi", 
                "acl_id": "0d00000000000004d3000000000000000000000001", 
                "apply_to": "both", 
                "chap_user_id": "", 
                "chap_user_name": "*", 
                "initiator_group_id": "", 
                "initiator_group_name": "*", 
                "lun": 0
            }
        ], 
        "agent_type": "none", 
        "app_uuid": "", 
        "base_snap_id": "", 
        "base_snap_name": "", 
        "block_size": 4096, 
        "cache_needed_for_pin": 104857600, 
        "cache_pinned": false, 
        "cache_policy": "normal", 
        "caching_enabled": true, 
        "clone": false, 
        "creation_time": 1430516996, 
        "description": "", 
        "dest_pool_id": "", 
        "dest_pool_name": "", 
        "encryption_cipher": "none", 
        "fc_sessions": null, 
        "full_name": "", 
        "id": "0600000000000004d3000000000000000000000001", 
        "iscsi_sessions": null, 
        "last_modified": 1430516996, 
        "limit": 100, 
        "metadata": null, 
        "move_aborting": false, 
        "move_bytes_migrated": 0, 
        "move_bytes_remaining": 0, 
        "move_start_time": 0, 
        "multi_initiator": false, 
        "name": "myvol1", 
        "num_connections": 0, 
        "num_fc_connections": 0, 
        "num_iscsi_connections": 0, 
        "num_snaps": 0, 
        "offline_reason": null, 
        "online": true, 
        "online_snaps": null, 
        "owned_by_group": "g1a1", 
        "parent_vol_id": "", 
        "parent_vol_name": "", 
        "perfpolicy_id": "0300000000000004d3000000000000000000000001", 
        "perfpolicy_name": "default", 
        "pinned_cache_size": 0, 
        "pool_id": "0a00000000000004d3000000000000000000000001", 
        "pool_name": "default", 
        "projected_num_snaps": 0, 
        "read_only": false, 
        "reserve": 0, 
        "search_name": "myvol1", 
        "serial_number": "9965f28016895f826c9ce900d3040000", 
        "size": 100, 
        "snap_limit": 9223372036854775807, 
        "snap_reserve": 0, 
        "snap_usage_compressed_bytes": 0, 
        "snap_usage_populated_bytes": 0, 
        "snap_usage_uncompressed_bytes": 0, 
        "snap_warn_level": 0, 
        "target_name": "iqn.2007-11.com.nimblestorage:myvol1-v00000000000004d3.00000001.000004d3", 
        "thinly_provisioned": true, 
        "upstream_cache_pinned": false, 
        "usage_valid": true, 
        "vol_state": "online", 
        "vol_usage_compressed_bytes": 0, 
        "vol_usage_uncompressed_bytes": 0, 
        "volcoll_id": "", 
        "volcoll_name": "", 
        "warn_level": 80
    }
}

Return specific range of rows from output:

Note: startRow is inclusive of the first row, which starts with “0”, and endRow is exclusive. For example, startRow=1 & endRow=3 will return the second and third rows of the API GET method.

GET https://<array_name>:5392/v1/volumes?startRow=1&endRow=3

Expected output:
```
{
    "data": [
        {
            "id": "0600000000000004d3000000000000000000000002", 
            "name": "myvol2"
        }, 
        {
            "id": "0600000000000004d3000000000000000000000003", 
            "name": "myvol3"
        }
    ], 
    "endRow": 3, 
    "startRow": 1, 
    "totalRows": 4
}
```

Select specific fields of interests from object set, and sort by a particular field (could be more than one field):

GET https://<array_name>:5392/v1/volumes/details?fields=id,name&sortBy=name

Expected output:

{
    "data": [
        {
            "name": "myvol1", 
            "size": 100
        }, 
        {
            "name": "myvol2", 
            "size": 100
        }, 
        {
            "name": "myvol3", 
            "size": 100
        }, 
        {
            "name": "myvol4", 
            "size": 100
        }
    ], 
    "endRow": 4, 
    "startRow": 0, 
    "totalRows": 4
}

Filter object set based on specific field:

GET https:// <array_name>:5392/v1/volumes?name=myvol1

Expected output:

{
    "data": [
        {
            "id": "0600000000000004d3000000000000000000000001", 
            "name": "myvol1"
        }
    ], 
    "endRow": 1, 
    "startRow": 0, 
    "totalRows": 1
}

For details, see cURL Code Sample.