/v1/tree-delete/jobs/{id} | Qumulo Documentation

Endpoint

/v1/tree-delete/jobs/{id}

GET

Get status of directory-tree deletion on the specified directory. If the job has finished, returns 404. Also returns 404 if there was never a job on the given object

Parameters

Name	Description	Required
`id`	Job ID	Yes

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "tree_delete_job_status",
  "type": "object",
  "properties": {
    "id": {
      "description": "The ID of the directory being deleted.",
      "type": "string"
    },
    "create_time": {
      "description": "The time the job was created. It may not have started at that time if the system was processing other jobs.",
      "type": "string"
    },
    "mode": {
      "type": "string",
      "enum": [
        "IN_PLACE",
        "PORTAL_DELETION",
        "PORTAL_EVICTION"
      ],
      "description": "The tree delete mode this job is running in.:\n * `IN_PLACE` - TREE_DELETE_IN_PLACE,\n * `PORTAL_DELETION` - TREE_DELETE_PORTAL_DELETION,\n * `PORTAL_EVICTION` - TREE_DELETE_PORTAL_EVICTION"
    },
    "initial_path": {
      "description": "The path of the directory at the time the job was started.",
      "type": "string"
    },
    "initial_capacity": {
      "description": "Initial bytes (data and metadata) used by the tree being deleted.",
      "type": "string"
    },
    "initial_directories": {
      "description": "Initial number of directories in the tree being deleted.",
      "type": "string"
    },
    "initial_files": {
      "description": "Initial number of non-directory files in the tree being deleted.",
      "type": "string"
    },
    "remaining_capacity": {
      "description": "Remaining bytes (data and metadata) used by the tree being deleted.",
      "type": "string"
    },
    "remaining_directories": {
      "description": "Remaining number of directories in the tree being deleted.",
      "type": "string"
    },
    "remaining_files": {
      "description": "Remaining number of non-directory files in the tree being deleted.",
      "type": "string"
    },
    "last_error_message": {
      "description": "The message from the last error that caused this job to be aborted.",
      "type": "string"
    }
  }
}

DELETE

Cancel directory-tree deletion on the specified directory. If the job has finished, returns 404. Also returns 404 if there was never a job on the given object

Parameters

Name	Description	Required
`id`	Job ID	Yes

Response

Codes

Code	Description
200	Return value on success