Retrieves the storage capacity information for your S3 storage component.
Endpoint
POST /storage_component/get_capacity
Request structure
Not applicable.
Response structure
{
"storageCapacities": {
"additionalProp1": {
"totalBytes": 0,
"usedBytes": 0,
"availableBytes": 0,
"warnThreshold": 0
},
"additionalProp2": {
"totalBytes": 0,
"usedBytes": 0,
"availableBytes": 0,
"warnThreshold": 0
},
"additionalProp3": {
"totalBytes": 0,
"usedBytes": 0,
"availableBytes": 0,
"warnThreshold": 0
}
}
}
|
Parameter |
Type |
Description |
|---|---|---|
| additionalProp | String | The name of your S3 component. |
| totalBytes | Integer | The total number of bytes available on your S3 component. |
| usedBytes | Integer | The total number of bytes that have been used on your S3 component. |
| availableBytes | Integer | The total number of unused bytes on your S3 component. |
| warnThreshold | Integer | The percentage of total capacity usage at which point a warning message is generated. |
Return codes
|
Status code |
HTTP name |
Description |
|---|---|---|
| 200 | OK | The request was executed successfully. |
| 401 | Unauthorized | Access was denied because credentials are not valid. |
| 405 | Method Not Allowed | The specified HTTP method is not allowed for a storage component. Resend using POST. |