Get all volume-collections details by Nimble / Alletra 6K
GET {{baseUrl}}/api/v1/storage-systems/device-type2/:systemId/volume-collections?limit=<integer>&offset=<integer>&filter=<string>&sort=<string>&select=<string>
Get all volume-collections details by Nimble / Alletra 6K
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | string | Number of items to return at a time | |
offset | string | The offset of the first item in the collection to return | |
filter | string | Lucene query to filter volume-collection by Key. | |
sort | string | oData query to sort volume-collection resource by Key. | |
select | string | Query to select only the required parameters, separated by . if nested |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"app_cluster_name":"\u003cstring\u003e","app_id":"\u003cstring\u003e","app_server":"\u003cstring\u003e","app_service_name":"\u003cstring\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","prottmpl_id":"\u003cstring\u003e","replication_type":"\u003cstring\u003e","synchronous_replication_state":"\u003cstring\u003e","synchronous_replication_type":"\u003cstring\u003e","agent_hostname":"\u003cstring\u003e","app_sync":"\u003cstring\u003e","associated_links":[{"resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"cache_pinned_volume_list":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","vol_id":"\u003cstring\u003e","vol_name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","vol_id":"\u003cstring\u003e","vol_name":"\u003cstring\u003e"}],"consoleUri":"\u003cstring\u003e","creation_time":"\u003clong\u003e","customerId":"\u003cstring\u003e","description":"\u003cstring\u003e","full_name":"\u003cstring\u003e","generation":"\u003cinteger\u003e","handover_replication_partner":"\u003cstring\u003e","is_handing_over":"\u003cboolean\u003e","is_mfa_protected":"\u003cboolean\u003e","is_standalone_volcoll":"\u003cboolean\u003e","lag_time":"\u003clong\u003e","last_replicated_snapcoll":{},"last_snapcoll":{},"metadata":[{"key":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"key":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"pol_owner_name":"\u003cstring\u003e","protection_type":"\u003cstring\u003e","repl_bytes_transferred":"\u003clong\u003e","repl_priority":"\u003cstring\u003e","replication_partner":["\u003cstring\u003e","\u003cstring\u003e"],"resourceUri":"\u003cstring\u003e","schedule_list":[{"active":"\u003cboolean\u003e","at_time":"\u003clong\u003e","days":"\u003cstring\u003e","disable_appsync":"\u003cboolean\u003e","downstream_partner":"\u003cstring\u003e","downstream_partner_id":"\u003cstring\u003e","downstream_partner_name":"\u003cstring\u003e","id":"\u003cstring\u003e","mfa_protected":"\u003cboolean\u003e","name":"\u003cstring\u003e","num_retain":"\u003clong\u003e","num_retain_replica":"\u003clong\u003e","period":"\u003clong\u003e","period_unit":"\u003cstring\u003e","repl_alert_thres":"\u003clong\u003e","replicate_every":"\u003clong\u003e","schedule_id":"\u003cstring\u003e","schedule_name":"\u003cstring\u003e","schedule_type":"\u003cstring\u003e","skip_db_consistency_check":"\u003cboolean\u003e","snap_verify":"\u003cboolean\u003e","until_time":"\u003clong\u003e"},{"active":"\u003cboolean\u003e","at_time":"\u003clong\u003e","days":"\u003cstring\u003e","disable_appsync":"\u003cboolean\u003e","downstream_partner":"\u003cstring\u003e","downstream_partner_id":"\u003cstring\u003e","downstream_partner_name":"\u003cstring\u003e","id":"\u003cstring\u003e","mfa_protected":"\u003cboolean\u003e","name":"\u003cstring\u003e","num_retain":"\u003clong\u003e","num_retain_replica":"\u003clong\u003e","period":"\u003clong\u003e","period_unit":"\u003cstring\u003e","repl_alert_thres":"\u003clong\u003e","replicate_every":"\u003clong\u003e","schedule_id":"\u003cstring\u003e","schedule_name":"\u003cstring\u003e","schedule_type":"\u003cstring\u003e","skip_db_consistency_check":"\u003cboolean\u003e","snap_verify":"\u003cboolean\u003e","until_time":"\u003clong\u003e"}],"search_name":"\u003cstring\u003e","snapcoll_count":"\u003clong\u003e","srep_last_sync":"\u003clong\u003e","srep_resync_percent":"\u003clong\u003e","total_repl_bytes":"\u003clong\u003e","type":"\u003cstring\u003e","vcenter_hostname":"\u003cstring\u003e","vcenter_username":"\u003cstring\u003e","volume_count":"\u003clong\u003e","volume_list":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","vol_id":"\u003cstring\u003e","vol_name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","vol_id":"\u003cstring\u003e","vol_name":"\u003cstring\u003e"}]},{"app_cluster_name":"\u003cstring\u003e","app_id":"\u003cstring\u003e","app_server":"\u003cstring\u003e","app_service_name":"\u003cstring\u003e","id":"\u003cstring\u003e","name":"\u003cstring\u003e","prottmpl_id":"\u003cstring\u003e","replication_type":"\u003cstring\u003e","synchronous_replication_state":"\u003cstring\u003e","synchronous_replication_type":"\u003cstring\u003e","agent_hostname":"\u003cstring\u003e","app_sync":"\u003cstring\u003e","associated_links":[{"resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"cache_pinned_volume_list":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","vol_id":"\u003cstring\u003e","vol_name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","vol_id":"\u003cstring\u003e","vol_name":"\u003cstring\u003e"}],"consoleUri":"\u003cstring\u003e","creation_time":"\u003clong\u003e","customerId":"\u003cstring\u003e","description":"\u003cstring\u003e","full_name":"\u003cstring\u003e","generation":"\u003cinteger\u003e","handover_replication_partner":"\u003cstring\u003e","is_handing_over":"\u003cboolean\u003e","is_mfa_protected":"\u003cboolean\u003e","is_standalone_volcoll":"\u003cboolean\u003e","lag_time":"\u003clong\u003e","last_replicated_snapcoll":{},"last_snapcoll":{},"metadata":[{"key":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"key":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"pol_owner_name":"\u003cstring\u003e","protection_type":"\u003cstring\u003e","repl_bytes_transferred":"\u003clong\u003e","repl_priority":"\u003cstring\u003e","replication_partner":["\u003cstring\u003e","\u003cstring\u003e"],"resourceUri":"\u003cstring\u003e","schedule_list":[{"active":"\u003cboolean\u003e","at_time":"\u003clong\u003e","days":"\u003cstring\u003e","disable_appsync":"\u003cboolean\u003e","downstream_partner":"\u003cstring\u003e","downstream_partner_id":"\u003cstring\u003e","downstream_partner_name":"\u003cstring\u003e","id":"\u003cstring\u003e","mfa_protected":"\u003cboolean\u003e","name":"\u003cstring\u003e","num_retain":"\u003clong\u003e","num_retain_replica":"\u003clong\u003e","period":"\u003clong\u003e","period_unit":"\u003cstring\u003e","repl_alert_thres":"\u003clong\u003e","replicate_every":"\u003clong\u003e","schedule_id":"\u003cstring\u003e","schedule_name":"\u003cstring\u003e","schedule_type":"\u003cstring\u003e","skip_db_consistency_check":"\u003cboolean\u003e","snap_verify":"\u003cboolean\u003e","until_time":"\u003clong\u003e"},{"active":"\u003cboolean\u003e","at_time":"\u003clong\u003e","days":"\u003cstring\u003e","disable_appsync":"\u003cboolean\u003e","downstream_partner":"\u003cstring\u003e","downstream_partner_id":"\u003cstring\u003e","downstream_partner_name":"\u003cstring\u003e","id":"\u003cstring\u003e","mfa_protected":"\u003cboolean\u003e","name":"\u003cstring\u003e","num_retain":"\u003clong\u003e","num_retain_replica":"\u003clong\u003e","period":"\u003clong\u003e","period_unit":"\u003cstring\u003e","repl_alert_thres":"\u003clong\u003e","replicate_every":"\u003clong\u003e","schedule_id":"\u003cstring\u003e","schedule_name":"\u003cstring\u003e","schedule_type":"\u003cstring\u003e","skip_db_consistency_check":"\u003cboolean\u003e","snap_verify":"\u003cboolean\u003e","until_time":"\u003clong\u003e"}],"search_name":"\u003cstring\u003e","snapcoll_count":"\u003clong\u003e","srep_last_sync":"\u003clong\u003e","srep_resync_percent":"\u003clong\u003e","total_repl_bytes":"\u003clong\u003e","type":"\u003cstring\u003e","vcenter_hostname":"\u003cstring\u003e","vcenter_username":"\u003cstring\u003e","volume_count":"\u003clong\u003e","volume_list":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","vol_id":"\u003cstring\u003e","vol_name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","vol_id":"\u003cstring\u003e","vol_name":"\u003cstring\u003e"}]}],"pageLimit":"\u003cinteger\u003e","pageOffset":"\u003cinteger\u003e","requestUri":"\u003cstring\u003e","total":"\u003clong\u003e"}