Passa al contenuto principale

CloudStorageUserResponse

Successful response with one CloudStorageUser

errorintegerrequired

Always 0 in a successful response

Constant value: 0
messagestring | nullnullablerequired

Always null in a successful response

data objectrequired

User of a cloud storage, with its quotas and the space used

cloud_storage_user_idintegerrequired
cloud_storage_idintegerrequired

Id of the cloud storage (GET /api/v3/cloud-storages/{cloud_storage_id})

purchase_idinteger | nullnullablerequired

Id of the purchase of the user (GET /api/v3/purchases/{purchase_id}): the cloud storage purchase, or the own purchase of an ADDITIONAL user

typestring | nullnullablerequired

Type of the user: PRIMARY (main user), ADDITIONAL (additional user, with its own purchase), or DISASTER_RECOVERY, TEMPLATE_VM and SELF_CLOUD for the users managed by those services

usernamestring | nullnullablerequired
passwordstring | nullnullablerequired

Password of the user; null without the cloudstorage:secrets scope

pathstring | nullnullablerequired

Home path of the user on the storage

soft_quota_gbfloatnullablerequired

Soft quota of the user, in GB (1 GB = 1024 MB): it can be exceeded, up to the hard quota, for a grace period

hard_quota_gbfloatnullablerequired

Hard quota of the user, in GB (1 GB = 1024 MB): the limit that the used space cannot exceed

used_space_bytesinteger | nullnullablerequired

Space used by the user at the last sync of the cloud storage, in bytes; null before the first sync

allocated_space_bytesinteger | nullnullablerequired

Space allocated to the user, that is its hard quota at the last sync of the cloud storage, in bytes; null before the first sync

grace_period_secondsinteger | nullnullablerequired

Grace period left to go back under the soft quota, in seconds, saved the last time the user was found over quota; 0 if never. Only PRIMARY users are checked: 0 for the ADDITIONAL ones, null for the users of the services

last_alertdate-timenullablerequired

Date of the last email that warned the customer that the user is over its soft quota, sent at most once a week and only for PRIMARY users; null if it was not over quota at the last check

activeboolean | nullnullablerequired

Whether the user is active: deleted users are not returned

metarequired

Always null: only the paginated lists have a meta

Constant value: null
CloudStorageUserResponse
{
"error": 0,
"message": "string",
"data": {
"cloud_storage_user_id": 0,
"cloud_storage_id": 0,
"purchase_id": 0,
"type": "string",
"username": "string",
"password": "string",
"path": "string",
"soft_quota_gb": 0,
"hard_quota_gb": 0,
"used_space_bytes": 0,
"allocated_space_bytes": 0,
"grace_period_seconds": 0,
"last_alert": "2024-07-29T15:51:28.071Z",
"active": true
}
}