Inventory

Backup Storage Inventory

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 0.6
name The name. For more information, see Resource Property. 0.6
description The description. For more information, see Resource Property. Yes 0.6
url The URL. For more information, see URL. 0.6
totalCapacity The total disk capacity. Unit: byte. For more information, see Capacity. 0.6
availableCapacity The available disk capacity. Unit: byte. For more information, see Capacity. 0.6
type The backup dotage type.
  • Ceph
  • ImageStoreBackupStorage
  • VCenter
  • SftpBackupStorage
 0.6
state The state. For more information, see State.
  • Enabled
  • Disabled
 0.6
status The status. For more information, see Status.
  • Connecting
  • Connected
  • Disconnected
 0.6
attachedZoneUuids The UUIDs of zones to which the backup storage is attached. 0.6
createDate The creation date. For more information, see Resource Property. 0.6
lastOpDate The last operation date. For more information, see Resource Property. 0.6

Sample

{
    "inventories": {
            "attachedClusterUuids": [
                "967a353c2893409dab9312cf3033a98c"
            ],
            "availableCapacity": 163634831360,
            "availablePhysicalCapacity": 186066427904,
            "createDate": "Oct 30, 2017 3:05:29 PM",
            "description": "",
            "lastOpDate": "Oct 31, 2017 10:41:26 AM",
            "mountPath": "/Cloud_ps",
            "name": "LS-1",
            "state": "Enabled",
            "status": "Connected",
            "systemUsedCapacity": 9330311168,
            "totalCapacity": 205177397248,
            "totalPhysicalCapacity": 205177397248,
            "type": "LocalStorage",
            "url": "/Cloud_ps",
            "uuid": "037bd212f7a1488da4f94360ccfaf6ab",
            "zoneUuid": "e59b71e99d8a4ea1952b578388b8cd1d"
        }
}

Image Replication Group Inventory

Name Description Optional Valid Value Starting Version
uuid The UUID. For more information, see Resource Property. 3.5.0
name The name. For more information, see Resource Property. 3.5.0
description The description. For more information, see Resource Property. Yes 3.5.0
state The state.
  • Enabled
  • Disabled
 3.5.0
backupStorageRefs The backup storage group list. 3.5.0
groupBy Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. Yes 3.5.0
createDate The create date. For more information, see Resource Property. 3.5.0
lastOpDate The last operation date. For more information, see Resource Property. 3.5.0
userTags The user tags. For more information, see CreateUserTag. Yes 3.5.0
systemTags The system tags. For more information, see CreateSystemTag. Yes 3.5.0
Sample
{
  "inventories": [
    {
      "uuid": "31cbc4dad8da3ca6a6e3df5c1d5f233e",
      "name": "test"
    }
  ]
}

URL

A URL is a string that contains information needed by backup storage to control storage systems. Although its name is URL, the exact format of the string is up to backup storage types and is not necessary to strictly follow the URL convention. This gives flexibilities to plugins to encode information that may not be able to fit in the URL format.

SFTP Backup Storage URL

For an SFTP back storage (also known as backup storage), the URL is an absolute path of a directory in a file system, such as /storage/sftp.

Capacity

ZStack Cloud monitors disk capacities of backup storages to select one suitable backup storage for creating volumes. Different backup storage plugins may report different disk capacities. The capacity of a backup storage is calculated according to the following formulas:
totalCapacity = backup storage's total capacity
availableCapacity = totalCapacity - sum (images' actual sizes)

State

A backup storages has the following two states:
  • Enabled:

    Indicates that images can be registered, backed up, and downloaded.

  • Disabled:

    Indicates that images cannot be registered, backed up, or downloaded. Especially, if an image is only stored on a disabled backup storage, and if the image is not downloaded to image caches of primary storage, this image cannot be used to create VM instances.

Status

The status of a backup storage reflects the command channel status between a ZStack Cloud management node and a backup storage.
  • Connecting:

    Indicates that a ZStack Cloud management node is trying to establish a command channel between the node itself and a backup storage. At this stage, you cannot perform any operation on the backup storage.

  • Connected:

    Indicates that the command channel between a ZStack Cloud management node and a backup storage is established successfully. At this stage, you can perform related operations on the backup storage.

  • Disconnected:

    Indicates that the command channel between a ZStack Cloud management node and a backup storage is lost. At this stage, you cannot perform any operation on the backup storage.

When a ZStack Cloud management node starts, the management node will try to establish command channels to backup storages. When the management node is running, it will periodically send ping commands to the backup storages to check the health status of command channels. Once a backup storage fails to respond, or a ping command times out, the status of the backup storage will be changed to Disconnected.

The status transition diagram of a backup storage is shown in Status Transition Diagram of Backup Storage.

Figure 1. Status Transition Diagram of Backup Storage