List vaults

Lists existing vaults.

Note: The List Vaults API does not contain all vault configuration parameters. The View System Configuration API or View System API can be used instead. These APIs include a complete collection of vault and configuration data.

Request

Edit online

Security

Edit online

Table 1. Roles capable of executing the List Vaults API method
Any	Super User	System Admin	Security Admin	Operator
any

HTTP method

Edit online

GET /manager/api/{apiResponseType}/1.0/listVaults.adm HTTP/1.1 Host:{manager.dsnet}

Curl method

Edit online

curl -u {admin}:{password} -k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/listVaults.adm“

Parameters

Edit online

None

Response

Edit online

A configuration and usage summary for all existing vaults.

JSON response example

Edit online

{
  ”responseStatus“:”ok“,
  ”responseHeader“:{
    ”status“:”ok“,
    ”now“:{milliseconds from the UNIX epoch},
    ”requestId“:”Ux@azsCoDkMAADCgJqEAAABK“
  },
  ”responseData“:{
  ”vaults“:[
    {
      ”allottedSize“:6193152,
      ”estimateUsableTotalLogicalSizeFromStorage“:5833656500223,
      ”threshold“:2,
      ”usableSize“:5833656500223,
      ”uuid“:”84b52c83-5021-4f55-9db0-53130302b4d4“,
      ”regionFormatEnabled“:true,
      ”allowedIps“:[
        {
          ”allowedIp“:”10.10.13.11“
        },
        {
          ”allowedIp“:”192.168.14.203“
        }
      ],
      ”id“:68,
      ”width“:3,
      ”type“:”object“,
      ”alertLevel“:null,
      ”estimateUsableUsedLogicalSizeFromStorage“:4087129,
      ”description“:”Stores backups of internal statistic data“,
      ”segmentSize“:4194304,
      ”allotmentUsage“:10828652544,
      ”creationDate“:”Tue, 11 Mar 2014 20:59:18 +0000“,
      "timestamp":"1448934321000",
      ”privacyEnabled“:true,
      ”writeThreshold“:2,
      ”usedLogicalSizeFromStorage“:6130695,
      ”name“:”csinternal-mgmt-sp1“,
      ”storagePools“:[
        {
          ”storagePool“:{
            ”usedLogicalSizeFromStorage“:6130695,
            ”estimateUsableUsedLogicalSizeFromStorage“:4087129,
            ”name“:”sp1“,
            ”usedPhysicalSizeFromStorage“:6193152,
            ”id“:84,
            ”allottedSize“:6193152,
            ”estimateUsableTotalLogicalSizeFromStorage“:5833656500223,
            ”usableSize“:5833656500223,
            ”generations“:[
              {
                ”generation“:{
                  ”sequence“:0
                }
              }
            ]
          }
        }
      ],
      ”numGenerations“:1,
      ”usedPhysicalSizeFromStorage“:6193152,
      ”readThreshold“:null
    }
  ]
}

Parameters

Edit online

Table 2. Response parameters for List Vaults (listVaults) API method
Parameter	Type	Description
vaults	array	Vaults in the system.
id	Long	Vault ID in the system.
uuid	String	Universally Unique Identifier of vault.
name	String	Vault Name.
description	String	Vault Description.
creationDate	date	Date when vault was created in Manager.
type	String	Vault type, usually object in all cases.
width	Integer	Number of devices that are needed to fully store objects in vault.
threshold	Integer	Number of devices that are needed to store objects with proper redundancy in vault.
readThreshold	Integer	Number of devices that are needed to attempt a successful read from this vault.
writeThreshold	Integer	Number of devices that are needed to complete a successful write to this vault.
alertLevel	Integer	Alert level for vault.
regionFormatEnabled	Boolean	Region format is enabled or disabled on vault.
privacyEnabled	Boolean	SecureSlice is enabled or disabled on vault.
protectionState	String	Possible values are–disabled, or retention. Note: To support backwards compatibility with ClevOS 3.12.0, the response returns the protection state `Compliance` for all buckets that were created with a `Status` of either `Retention` or `Compliance`. The protection state `Retention` and `Compliance` are used interchangeably.
minimumRetentionPeriod	Long	Accepts value in days. Minimum value should be ≥ 1 day.
maximumRetentionPeriod	Long	Accepts value in days. Maximum value should be ≤ 25567 days.
defaultRetentionPeriod	Long	Accepts value in days. The default must be ≥mininumumRetentionPeriod and ≤maximumRetentionPeriod retention period.
numGenerations	Integer	Number of generations in vault.
allottedSize	Integer	Total amount of disk space that is used by this vault across the system.
usableSize	Integer	Estimate of how much available usable capacity on this vault.
segmentSize	Integer	Size of part of object that is written to vault.
usedPhysicalSizeFromStorage	Integer	Raw capacity that is used across all Slicestor appliances to hold data in vault. It does include file system overhead of storing data.
usedLogicalSizeFromStorage	Integer	Capacity currently being used across all the Slicestor appliances.
estimateUsableUsedLogicalSizeFromStorage	Integer	Calculated estimate of usable capacity currently being stored on vault It does not include file system overhead of storing data.
estimateUsableTotalLogicalSizeFromStorage	Integer	Identical to usable Size.
allowedIps	array	IP addresses with write access to this vault.
allowedIp	String	IP address with write access to this vault.
softQuota	Long	Soft quota size in bytes.
hardQuota	Long	Hard quota size in bytes.
allotmentQuota	Long	Allotment quota in bytes.
allotmentUsage	Long	Amount of raw space that is used on allotment.
storagePools	array	Storage pools in vault. It generally contains just one storage pool, but when a pool is merged, more than one storage pool is listed.
storagePool	object	Key for each storage pool.
id	Long	Storage pool ID.
name	String	Storage pool name.
allottedSize	Integer	Total capacity that is used by this vault across the system.
usableSize	Integer	Estimate of usable capacity of this vault.
usedPhysicalSizeFromStorage	Integer	Raw capacity that is used across all Slicestor appliances to hold data for vault. It does include file system overhead of storing data.
usedLogicalSizeFromStorage	Integer	Capacity that is used across all Slicestor appliances.
estimateUsableUsedLogicalSizeFromStorage	Integer	Estimate of used capacity currently on vault.
estimateUsableTotalLogicalSizeFromStorage	Integer	Identical to usable Size.
estimateObjectCount	Integer	Estimate of vault object count that includes all objects, versions of objects, and fanout copies of objects. Note: In addition to objects, this count includes index root nodes such as name or multipart index, and might include a few other temporary internal structures that are created by the core software.
generations	array	Generations that are associated with vault.
generation	Integer
timestamp	Long	UNIX time when vault was created.
objectExpirationEnabled	Boolean	Object Expiration is enabled or disabled on vault.
staticWebsiteHostingEnabled	Boolean	Static Website Hosting is enabled or disabled on vault.

Note: These parameters match the ones in the outer array if the vault is on only one pool: allottedSize, usableSize, usedPhysicalSizeFromStorage, usedLogicalSizeFromStorage, estimateUsableUsedLogicalSizeFromStorage, estimateUsableTotalLogicalSizeFromStorage, generations.