Nexfs Management API Documentation
Method Index
TierObject
Added To Nexfs Since Version
2.0
Status:
Current
Move an Objects data to a storage tier
Action: TierObject
Submit a job that moves an object’s data to a specified storage tier
Permissions
The calling session must have the nexfs/tierobjects role enabled.
Request Parameters
A request must be made to the Nexfs Management Console API using the TierObject 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 TierObject
Path
The Nexfs Path to an existing file or object
Target
The destination storage tier for the data. Currently, the only support value is 3
Request Body
The request has no body.
Response Syntax
HTTP/1.1 200 OK
Content-Type: application/json
{
"Path": "string",
"JobID": integer,
"TargetTier": "string"
}
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. |
JobID | The JobID assigned to the request |
TargetTier | The destination storage tier for the object data |
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
{
"Path": "/default_tenant/accountsbucket/accounts.xls",
"JobID": 12312311223,
"Tier": "3"
}