Nexfs Management API Documentation
Method Index
GetObjectDataStorage
Added To Nexfs Since Version
2.0
Status:
Current
Show an Objects data storage
Action: GetObjectDataStorage
Returns data storage usage details for an object
Permissions
The calling session must have the nexfs/GetObjectDataStorage role enabled.
Request Parameters
A request must be made to the Nexfs Management Console API using the GetObjectDataStorage action.
The request must be signed with a valid AWS V4-style signature, using an active temporary session security token.
Action
Must be set to GetObjectDataStorage
Path
The Nexfs Path to an existing file or object
Mode (Optional):
Mode=0 (Default): Includes estimated tier and thin provisioned usage.
Mode=1: Shows detailed tier and thin provisioned information.
Note: Generating detailed information may take additional time for large objects.
Request Body
The request has no body.
Response Syntax
HTTP/1.1 200 OK
Content-Type: application/json
{
"Path": "string",
"Size": integer,
"Tier1": integer,
"Tier2": integer,
"Tier3": integer, // Only in Mode 1
"Tier3 or Thin": integer, // Only in Mode 0
"Thin": integer // Only in Mode 1
}
Response Elements
If the action is successful, the service returns an HTTP 200 response.
The following data is returned in JSON format:
Field | Description |
Path | The Nexfs object path. |
Size | The full object size, including any thin provisioning. |
Tier1 | Object data comsuming Tier-1 storage. |
Tier2 | Object data comsuming Tier-2 storage. |
Tier3 | (Mode 1 only) Object data consuming Tier-3 storage. |
Tier3 or Thin | (Mode 0 only) Estimate for Tier-3, combined with thin provisioning. |
Thin | (Mode 1 only) Thin provisioned; consumes no storage. |
Errors
Also See Rest Error Responses
HTTP Status | Error Code | Description |
400 | BadRequest | The request was malformed (e.g., missing Path). |
400 | InvalidArgument | No file or object matches the specified Path. Request Object is a directory/folder |
401 | Unauthorized | The request cannot be authenticated. |
403 | Forbidden | The session does not have rights to perform the requested action. |
500 | InternalServerError | An internal error was encountered. |
507 | ServiceUnavailable | The Job Queue is full -try again later. |
Example Request
Authorization: AWS4-HMAC-SHA256 Credential=e01920da85cf44dfa1f670dc52073a28/20220823/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=d92d8e66b23619d5ea3c278b048bd2d1f63335928611c61b891db6a3e968ab02
host: nexfs.example.com
x-amz-date: 20220823T130753Z
Example Response
Mode 0 Example Response:
{
"Path": "/default_tenant/accountsbucket/accounts.xls",
"Size": 11000,
"Tier1": 1000,
"Tier2": 0,
"Tier3 or Thin": 10000,
}
Mode 1 Example Response:
{
"Path": "/default_tenant/accountsbucket/accounts.xls",
"Size": 11000,
"Tier1": 1000,
"Tier2": 0,
"Tier3": 8000,
"Thin": 2000
}