# ApiSnapshotCommand Data Model

Information about snapshot commands.

This object holds all the information a regular ApiCommand object provides, and adds specific information about the results of a snapshot command.

Depending on the type of the service where the snapshot command was run, a different result property will be populated.

Properties
name | data type | description
--- | --- | ---
hbaseResult | ApiHBaseSnapshotResult | Results for snapshot commands on HBase services.
hdfsResult | ApiHdfsSnapshotResult | Results for snapshot commands on Hdfs services.
ozoneResult | ApiOzoneSnapshotResult | Results for snapshot commands on Ozone services.

##### Properties inherited from ApiCommand

id | number | The command ID.
name | string | The command name.
startTime | string | The start time.
endTime | string | The end time, if the command is finished.
active | boolean | Whether the command is currently active.
success | boolean | If the command is finished, whether it was successful.
resultMessage | string | If the command is finished, the result message.
resultDataUrl | string | URL to the command's downloadable result data, if any exists.
clusterRef | ApiClusterRef | Reference to the cluster (for cluster commands only).
serviceRef | ApiServiceRef | Reference to the service (for service commands only).
roleRef | ApiRoleRef | Reference to the role (for role commands only).
hostRef | ApiHostRef | Reference to the host (for host commands only).
parent | ApiCommand | Reference to the parent command, if any.
children | ApiCommandList | List of child commands. Only available in the full view. The list contains only the summary view of the children.
canRetry | boolean | If the command can be retried. Available since V11

Example

    {
      "hbaseResult" : {
        "processedTableCount" : 12345,
        "processedTables" : [ "...", "..." ],
        "unprocessedTableCount" : 12345,
        "unprocessedTables" : [ "...", "..." ],
        "createdSnapshotCount" : 12345,
        "createdSnapshots" : [ {
          "snapshotName" : "...",
          "tableName" : "...",
          "creationTime" : "...",
          "storage" : "LOCAL",
          "storageLocation" : "..."
        }, {
          "snapshotName" : "...",
          "tableName" : "...",
          "creationTime" : "...",
          "storage" : "REMOTE_S3",
          "storageLocation" : "..."
        } ],
        "deletedSnapshotCount" : 12345,
        "deletedSnapshots" : [ {
          "snapshotName" : "...",
          "tableName" : "...",
          "creationTime" : "...",
          "storage" : "REMOTE_S3",
          "storageLocation" : "..."
        }, {
          "snapshotName" : "...",
          "tableName" : "...",
          "creationTime" : "...",
          "storage" : "REMOTE_S3",
          "storageLocation" : "..."
        } ],
        "creationErrorCount" : 12345,
        "creationErrors" : [ {
          "tableName" : "...",
          "snapshotName" : "...",
          "storage" : "REMOTE_S3",
          "storageLocation" : "...",
          "error" : "..."
        }, {
          "tableName" : "...",
          "snapshotName" : "...",
          "storage" : "REMOTE_S3",
          "storageLocation" : "...",
          "error" : "..."
        } ],
        "deletionErrorCount" : 12345,
        "deletionErrors" : [ {
          "tableName" : "...",
          "snapshotName" : "...",
          "storage" : "LOCAL",
          "storageLocation" : "...",
          "error" : "..."
        }, {
          "tableName" : "...",
          "snapshotName" : "...",
          "storage" : "REMOTE_S3",
          "storageLocation" : "...",
          "error" : "..."
        } ]
      },
      "hdfsResult" : {
        "processedPathCount" : 12345,
        "processedPaths" : [ "...", "..." ],
        "unprocessedPathCount" : 12345,
        "unprocessedPaths" : [ "...", "..." ],
        "createdSnapshotCount" : 12345,
        "createdSnapshots" : [ {
          "path" : "...",
          "snapshotName" : "...",
          "snapshotPath" : "...",
          "creationTime" : "..."
        }, {
          "path" : "...",
          "snapshotName" : "...",
          "snapshotPath" : "...",
          "creationTime" : "..."
        } ],
        "deletedSnapshotCount" : 12345,
        "deletedSnapshots" : [ {
          "path" : "...",
          "snapshotName" : "...",
          "snapshotPath" : "...",
          "creationTime" : "..."
        }, {
          "path" : "...",
          "snapshotName" : "...",
          "snapshotPath" : "...",
          "creationTime" : "..."
        } ],
        "creationErrorCount" : 12345,
        "creationErrors" : [ {
          "path" : "...",
          "snapshotName" : "...",
          "error" : "..."
        }, {
          "path" : "...",
          "snapshotName" : "...",
          "error" : "..."
        } ],
        "deletionErrorCount" : 12345,
        "deletionErrors" : [ {
          "path" : "...",
          "snapshotName" : "...",
          "error" : "..."
        }, {
          "path" : "...",
          "snapshotName" : "...",
          "error" : "..."
        } ]
      },
      "ozoneResult" : {
        "processedBucketCount" : 12345,
        "processedBuckets" : [ "...", "..." ],
        "unprocessedBucketCount" : 12345,
        "unprocessedBuckets" : [ "...", "..." ],
        "createdSnapshotCount" : 12345,
        "createdSnapshots" : [ {
          "snapshotRef" : { },
          "creationTime" : 12345
        }, {
          "snapshotRef" : { },
          "creationTime" : 12345
        } ],
        "deletedSnapshotCount" : 12345,
        "deletedSnapshots" : [ {
          "snapshotRef" : { },
          "creationTime" : 12345
        }, {
          "snapshotRef" : { },
          "creationTime" : 12345
        } ],
        "creationErrorCount" : 12345,
        "creationErrors" : [ {
          "snapshotRef" : { },
          "error" : "..."
        }, {
          "snapshotRef" : { },
          "error" : "..."
        } ],
        "deletionErrorCount" : 12345,
        "deletionErrors" : [ {
          "snapshotRef" : { },
          "error" : "..."
        }, {
          "snapshotRef" : { },
          "error" : "..."
        } ]
      },
      "id" : 12345,
      "name" : "...",
      "startTime" : "...",
      "endTime" : "...",
      "active" : true,
      "success" : true,
      "resultMessage" : "...",
      "resultDataUrl" : "...",
      "clusterRef" : {
        "clusterName" : "...",
        "displayName" : "..."
      },
      "serviceRef" : {
        "peerName" : "...",
        "clusterName" : "...",
        "clusterDisplayName" : "...",
        "serviceName" : "...",
        "serviceDisplayName" : "...",
        "serviceType" : "..."
      },
      "roleRef" : {
        "clusterName" : "...",
        "serviceName" : "...",
        "roleName" : "...",
        "healthSummary" : "BAD",
        "roleStatus" : "STOPPING"
      },
      "hostRef" : {
        "hostId" : "...",
        "hostname" : "..."
      },
      "parent" : {
        "id" : 12345,
        "name" : "...",
        "startTime" : "...",
        "endTime" : "...",
        "active" : true,
        "success" : true,
        "resultMessage" : "...",
        "resultDataUrl" : "...",
        "clusterRef" : {
          "clusterName" : "...",
          "displayName" : "..."
        },
        "serviceRef" : {
          "peerName" : "...",
          "clusterName" : "...",
          "clusterDisplayName" : "...",
          "serviceName" : "...",
          "serviceDisplayName" : "...",
          "serviceType" : "..."
        },
        "roleRef" : {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "BAD",
          "roleStatus" : "UNKNOWN"
        },
        "hostRef" : {
          "hostId" : "...",
          "hostname" : "..."
        },
        "parent" : { },
        "children" : {
          "items" : [ { }, { } ]
        },
        "canRetry" : true
      },
      "children" : {
        "items" : [ {
          "id" : 12345,
          "name" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "active" : true,
          "success" : true,
          "resultMessage" : "...",
          "resultDataUrl" : "...",
          "clusterRef" : { },
          "serviceRef" : { },
          "roleRef" : { },
          "hostRef" : { },
          "parent" : { },
          "children" : { },
          "canRetry" : true
        }, {
          "id" : 12345,
          "name" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "active" : true,
          "success" : true,
          "resultMessage" : "...",
          "resultDataUrl" : "...",
          "clusterRef" : { },
          "serviceRef" : { },
          "roleRef" : { },
          "hostRef" : { },
          "parent" : { },
          "children" : { },
          "canRetry" : true
        } ]
      },
      "canRetry" : true
    }