Nexfs Management API Documentation
Method Index
GetObjectInfo
Added To Nexfs Since Version
2.0
Status:
Current
Retrieving Nexfs Object Information
Action: GetObjectInfo
Retrieve information about a Nexfs object
Permissions
To request object information, the requesting session must have the nexfs/GetInfoObjects role enabled.
Request Parameters
A request must be made to the Nexfs Management Console API using the GetObjectInfo action.
The request must be signed with a valid AWS V4-style signature, using an active temporary session security token.
Action
GetObjectInfo
Path
The Nexfs Path to an existing File or Object
Request Body
The request does not include a request body.
Response Syntax
HTTP/1.1 200 OK
Content-Type: application/json
{
"Path": "string",
"Inode": "string",
"Size": integer,
"Owner": "string",
"DataPartSize": integer,
"GFSID": "string",
"GFSCID": "string",
"LockedToTier": integer,
"MinTiered": integer,
"MaxTiered": integer,
"SmartProtected": true | false,
"AllocatedChunks": integer,
"MultiPart": true | false
}
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. |
Inode | The object's Nexfs inode. |
Size | The object's size (in bytes). |
Owner | The object's owner. |
DataPartSize | The object's part (chunk) size. |
GFSID | The object's Nexfs unique ID. |
GFSCID | The object's current version unique ID. |
LockedToTier | Specifies if the object is locked to a data tier. |
MinTiered | The lowest data tier consumed by the object. |
MaxTiered | The highest data tier consumed by the object. |
SmartProtected | true if the object is actively smart protected; otherwise false. |
AllocatedChunks | The number of allocated chunks. |
MultiPart | true if the object was created as a multipart upload; otherwise false. |
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. |
Example Request
GET http://nexfs.example.com:9200/nexfsconsoleapi?Action=GetObjectInfo&Path=/default_tenant/accountsbucket/accounts.xls
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
{
"Path": "/default_tenant/accountsbucket/accounts.xls",
"Inode": "12312311223",
"Size": 13760,
"Owner": "frank",
"DataPartSize": 1024000,
"GFSID": "0a544e5a-33c4-11f0-aa98-00224d5064b6",
"GFSCID": "abb31dee-33c4-11f0-aa98-00224d5064b6",
"LockedToTier": 0,
"MinTiered": 1,
"MaxTiered": 3,
"SmartProtected": true,
"AllocatedChunks": 1,
"MultiPart": false
}