REST API Reference Version 5.2.1.0Search

Read

GET v1/snapshot_collections

Query parameters

Parameter Type
startRow NsUnsignedLong
endRow NsUnsignedLong
sortBy NsString
iSortBy NsString
pageSize NsUnsignedInt
id NsObjectID
name NsVolSnapName
description NsDescription
volcoll_name NsObjectName
volcoll_id NsObjectID
origin_name NsObjectName
is_replica NsBoolean
is_complete NsBoolean
is_manual NsBoolean
is_external_trigger NsBoolean
is_unmanaged NsBoolean
repl_status NsSnapReplStatus
repl_start_time NsTime
repl_complete_time NsTime
repl_bytes_transferred NsUnsignedLong
creation_time NsTime
last_modified NsTime
online_status NsOnlineStatus
replicate NsBoolean
start_online NsBoolean
allow_writes NsBoolean
disable_appsync NsBoolean
snap_verify NsBoolean
skip_db_consistency_check NsBoolean
sched_id NsObjectID
sched_name NsObjectName
invoke_on_upstream_partner NsBoolean
agent_type NsAgentType

GET v1/snapshot_collections/detail

Query parameters

Parameter Type
startRow NsUnsignedLong
endRow NsUnsignedLong
sortBy NsString
iSortBy NsString
fields NsCommaSeparatedList
pageSize NsUnsignedInt
id NsObjectID
name NsVolSnapName
description NsDescription
volcoll_name NsObjectName
volcoll_id NsObjectID
origin_name NsObjectName
is_replica NsBoolean
is_complete NsBoolean
is_manual NsBoolean
is_external_trigger NsBoolean
is_unmanaged NsBoolean
repl_status NsSnapReplStatus
repl_start_time NsTime
repl_complete_time NsTime
repl_bytes_transferred NsUnsignedLong
creation_time NsTime
last_modified NsTime
online_status NsOnlineStatus
replicate NsBoolean
start_online NsBoolean
allow_writes NsBoolean
disable_appsync NsBoolean
snap_verify NsBoolean
skip_db_consistency_check NsBoolean
sched_id NsObjectID
sched_name NsObjectName
invoke_on_upstream_partner NsBoolean
agent_type NsAgentType

GET v1/snapshot_collections/id

Query parameters

Parameter Type
fields NsCommaSeparatedList

Description

Read information about specified snapshot collection.

Normal Response Codes

200 206

HTTP Error Codes

400 401 403 404 500 503

Detail Codes

SM_complex_type_query_param

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_start_row_beyond_end_row

SM_start_row_beyond_total_rows

SM_unexpected_query_param

SM_unsupported_query_operator

SM_version_name

Response

Parameter Type JSON Type Description Deprecated
id NsObjectID string Identifier for snapshot collection. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
name NsVolSnapName string Name of snapshot collection. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints.  
description NsDescription string Text description of snapshot collection. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.  
volcoll_name NsObjectName string Volume collection name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
volcoll_id NsObjectID string Parent volume collection ID. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
origin_name NsObjectName string Origination group name/ID. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
is_replica NsBoolean boolean Mark or unmark specified snapshot collection for replication. When marking for replication, the snapshot collection must have been created by an existing replicating protection schedule and no newer snapshot collection for this volume collection should have already started to replicate. Often used to replicate a snapshot collection from previously downstream partner to another partner. Possible values: 'true', 'false'.  
is_complete NsBoolean boolean Is complete. Possible values: 'true', 'false'.  
is_manual NsBoolean boolean Is manual. Possible values: 'true', 'false'.  
is_external_trigger NsBoolean boolean Is externally triggered. Possible values: 'true', 'false'.  
is_unmanaged NsBoolean boolean Is snapshot collection unmanaged, so that it will not be automatically deleted. Possible values: 'true', 'false'.  
repl_status NsSnapReplStatus string enum Replication status. Possible values: 'complete', 'in_progress', 'pending'.  
repl_start_time NsTime number Replication start time. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
repl_complete_time NsTime number Replication complete time. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
repl_bytes_transferred NsUnsignedLong number Number of bytes transferred after replication completes. Unsigned 64-bit integer. Example: 1234.  
creation_time NsTime number Time when this snapshot collection was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
last_modified NsTime number Time when this snapshot collection was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
online_status NsOnlineStatus string enum Online status of snapcoll. This is based on the online status of the individual snapshots. Online status based on that of the constituent entities. Possible values: 'online', 'offline' or 'partial'.  
vol_snap_attr_list NsVolumeSnapshotAttributeList Array of NsVolumeSnapshotAttribute List of snapshot attributes for snapshots being created as part of snapshot collection creation. List of volumes with per snapshot attributes.  
snapshots_list NsSnapshotListFromSnapshotCollections Array of NsSnapshotFromSnapshotCollections List of snapshots in the snapshot collection. Snapshot list as presented in snapshot collections object set.  
replicate NsBoolean boolean True if this snapshot collection has been marked for replication. Possible values: 'true', 'false'.  
start_online NsBoolean boolean Start with snapshot set online. Possible values: 'true', 'false'.  
allow_writes NsBoolean boolean Allow applications to write to created snapshot(s). Mandatory and must be set to 'true' for VSS application synchronized snapshots. Possible values: 'true', 'false'.  
disable_appsync NsBoolean boolean Do not perform application synchronization for this snapshot, create a crash-consistent snapshot instead. Possible values: 'true', 'false'.  
snap_verify NsBoolean boolean Run verification tool on this snapshot. This option can only be used with a volume collection that has application synchronization. Possible values: 'true', 'false'.  
skip_db_consistency_check NsBoolean boolean Skip consistency check for database files on this snapshot. This option only applies to volume collections with application synchronization set to VSS, application ID set to MS Exchange 2010 or later with Database Availability Group (DAG), snap_verify option set to true, and disable_appsync option set to false. Possible values: 'true', 'false'.  
sched_id NsObjectID string ID of protection schedule of snapshot collection. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
sched_name NsObjectName string Name of protection schedule of snapshot collection. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
invoke_on_upstream_partner NsBoolean boolean Invoke snapshot request on upstream partner. Possible values: 'true', 'false'.  
agent_type NsAgentType string enum External management agent type for snapshots being created as part of snapshot collection. Possible values: 'none', 'smis', 'vvol', 'openstack', 'openstackv2'.  
metadata NsKeyValues Array of NsKeyValue Key-value pairs that augment a snapshot collection's attributes. List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed.  

JSON Response 

            

{
   "data" : {
      "repl_bytes_transferred" : 0,
      "repl_status" : null,
      "is_complete" : true,
      "repl_start_time" : 0,
      "replicate" : false,
      "volcoll_id" : "0700000000000004d3000000000000000000000008",
      "metadata" : null,
      "creation_time" : 1474184344,
      "id" : "0500000000000004d3000000000000000000000001",
      "repl_complete_time" : 0,
      "is_replica" : false,
      "volcoll_name" : "volcoll0.930662683702138",
      "sched_id" : "",
      "is_unmanaged" : true,
      "last_modified" : 1474184344,
      "name" : "snapcoll0.686780041343251",
      "description" : "a5ZGBdAHYqw52e7S4TV0MCLva5h2fBh5MkqsFboJknzIJoH3w81IcGwcjoX2XG78",
      "origin_name" : "g1a1",
      "sched_name" : "",
      "is_manual" : true,
      "online_status" : "offline",
      "snapshots_list" : [
         {
            "snap_name" : "snapcoll0.686780041343251",
            "snapcoll_id" : "0500000000000004d3000000000000000000000001",
            "schedule_name" : "",
            "name" : "snapcoll0.686780041343251",
            "vol_id" : "0600000000000004d3000000000000000000000005",
            "snap_id" : "0400000000000004d3000000000000000600000001",
            "vol_name" : "vol10.885505421466682",
            "id" : "0400000000000004d3000000000000000600000001",
            "snapcoll_name" : "snapcoll0.686780041343251",
            "schedule_id" : ""
         },
         {
            "snap_name" : "snapcoll0.686780041343251",
            "snapcoll_id" : "0500000000000004d3000000000000000000000001",
            "schedule_name" : "",
            "name" : "snapcoll0.686780041343251",
            "vol_id" : "0600000000000004d3000000000000000000000006",
            "snap_id" : "0400000000000004d3000000000000000700000001",
            "vol_name" : "vol20.264981083050092",
            "id" : "0400000000000004d3000000000000000700000001",
            "snapcoll_name" : "snapcoll0.686780041343251",
            "schedule_id" : ""
         }
      ],
      "is_external_trigger" : false
   }
}
Parent topic: snapshot_collections