Read
GET v1/volume_collections
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| id | NsObjectID |
| prottmpl_id | NsObjectID |
| name | NsObjectName |
| full_name | NsObjectName |
| search_name | NsSearchName |
| description | NsDescription |
| pol_owner_name | NsGroupName |
| app_sync | NsAppSyncType |
| app_server | NsObjectName |
| app_id | NsAppIdType |
| app_cluster_name | NsObjectName |
| app_service_name | NsObjectName |
| vcenter_hostname | NsObjectName |
| vcenter_username | NsObjectName |
| vcenter_password | NsFlexiblePassword |
| creation_time | NsTime |
| last_modified_time | NsTime |
| snapcoll_count | NsUnsignedLong |
| is_standalone_volcoll | NsBoolean |
| is_handing_over | NsBoolean |
| handover_replication_partner | NsObjectName |
GET v1/volume_collections/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| fields | NsCommaSeparatedList |
| id | NsObjectID |
| prottmpl_id | NsObjectID |
| name | NsObjectName |
| full_name | NsObjectName |
| search_name | NsSearchName |
| description | NsDescription |
| pol_owner_name | NsGroupName |
| app_sync | NsAppSyncType |
| app_server | NsObjectName |
| app_id | NsAppIdType |
| app_cluster_name | NsObjectName |
| app_service_name | NsObjectName |
| vcenter_hostname | NsObjectName |
| vcenter_username | NsObjectName |
| vcenter_password | NsFlexiblePassword |
| creation_time | NsTime |
| last_modified_time | NsTime |
| snapcoll_count | NsUnsignedLong |
| is_standalone_volcoll | NsBoolean |
| is_handing_over | NsBoolean |
| handover_replication_partner | NsObjectName |
Description
Read a set of volume collections or a single volume collection.
Normal Response Codes
200
HTTP Error Codes
400 401 404 500 503
Detail Error Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for volume collection. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| prottmpl_id | NsObjectID | string | Identifier of the protection template whose attributes will be used to create this volume collection. This attribute is only used for input when creating a volume collection and is not outputed. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsObjectName | string | Name of volume collection. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| full_name | NsObjectName | string | Fully qualified name of volume collection. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| search_name | NsSearchName | string | Name of volume collection used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'. | |
| description | NsDescription | string | Text description of volume collection. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | |
| pol_owner_name | NsGroupName | string | Owner group. String of up to 64 alphanumeric characters, - is allowed after first character. Example: 'g1-exchange'. | |
| app_sync | NsAppSyncType | string enum | Application Synchronization. Possible values: 'none', 'vss', 'vmware'. | |
| app_server | NsObjectName | string | Application server hostname. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| app_id | NsAppIdType | string enum | Application ID running on the server. Application ID can only be specified if application synchronization is \"vss\". Possible values: 'inval', 'exchange', 'sql2005', 'sql2008', 'sql2012', 'exchange_dag', 'sql2014'. | |
| app_cluster_name | NsObjectName | string | If the application is running within a Windows cluster environment, this is the cluster name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| app_service_name | NsObjectName | string | If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| vcenter_hostname | NsObjectName | string | VMware vCenter hostname. Custom port number can be specified with vCenter hostname using \":\". String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| vcenter_username | NsObjectName | string | Application VMware vCenter username. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| vcenter_password | NsFlexiblePassword | string | Application VMware vCenter password. A password with few constraints. A string of up to 255 characters. Example: 'password_25-24'. | |
| creation_time | NsTime | number | Time when this volume collection was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_modified_time | NsTime | number | Time when this volume collection was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| volume_list | NsVolumeList | Array of NsVolumeSummary | List of volumes associated with volume collection. List of volumes associated with a volume collection. | |
| cache_pinned_volume_list | NsVolumeList | Array of NsVolumeSummary | List of cache pinned volumes associated with volume collection. List of volumes associated with a volume collection. | |
| last_snapcoll | NsSnapcollSummary | object | Last snapshot collection on this volume collection. Select fields containing snapshot collection information. | |
| snapcoll_count | NsUnsignedLong | number | Count of snapshot collections associated with volume collection. Unsigned 64-bit integer. Example: 1234. | |
| schedule_list | NsScheduleList | Array of NsSchedule | List of snapshot schedules associated with volume collection. List of snapshot schedules associated with a volume collection or protection template. | |
| is_standalone_volcoll | NsBoolean | boolean | Indicates whether this is a standalone volume collection. Possible values: 'true', 'false'. | |
| is_handing_over | NsBoolean | boolean | Indicates whether a handover operation is in progress on this volume collection. Possible values: 'true', 'false'. | |
| handover_replication_partner | NsObjectName | string | Replication partner to which ownership is being transferred as part of handover operation. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. |
JSON Response