list-snapshot-policy-jobs¶

Description¶

Lists jobs triggered by a snapshot policy.

Synopsis¶

  list-snapshot-policy-jobs
--cluster-crn <value>
--name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-crn (string)

CRN of the cluster where the snapshot policy is.

--name (string)

The name of the snapshot policy whose snapshot history will be retrieved.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

jobs -> (array)

The list of snapshot jobs that ran for the snapshot policy.

item -> (object)

Detailed information about a snapshot job.

id -> (integer)

The id of the snapshot command.

name -> (string)

The name of the snapshot command.

startTime -> (datetime)

The start time of the snapshot command.

endTime -> (datetime)

The end time of the snapshot command.

schedule -> (object)

Defines the schedule of a snapshot policy.

minuteOfHour -> (integer)

Minute of the hour that hourly, daily, weekly, monthly and yearly snapshots will be created. Valid values are 0 to 59.

hourOfDay -> (integer)

Hour of the day that daily, weekly, monthly and yearly snapshots will be created. Valid values are 0 to 23.

dayOfWeek -> (integer)

Day of the week that weekly snapshots will be created. Valid values are 1 to 7, 1 representing Sunday.

dayOfMonth -> (integer)

Day of the month that monthly and yearly snapshots will be created. Valid values are 1 to 31. Additionally 0 to -30 can be used to specify offsets from the last day of the month.

monthOfYear -> (integer)

Month of the year that yearly snapshots will be created. Valid values are 1 to 12, 1 representing January.

hoursForHourly -> (array)

Hours of the day that hourly snapshots will be created. Valid values are 0 to 23. If this list is null or empty, then hourly snapshots are created for every hour.

item -> (integer)

snapshotRetentionCount -> (object)

Defines the number of snapshots to be retained for snapshot policies.

hourlySnapshots -> (integer)

The number of hourly snapshots to be retained.

dailySnapshots -> (integer)

The number of daily snapshots to be retained.

weeklySnapshots -> (integer)

The number of weekly snapshots to be retained.

monthlySnapshots -> (integer)

The number of monthly snapshots to be retained.

yearlySnapshots -> (integer)

The number of yearly snapshots to be retained.

state -> (string)

The state of the snapshot created by the snapshot command.

resultMessage -> (string)

The result message for a finished command.

resultDataUrl -> (string)

The URL to the command’s downloadable result data.

snapshotName -> (string)

The name of the snapshot.

clusterId -> (string)

The crn of the cluster where the snapshot is.

hbaseResult -> (object)

The detailed results of a snapshot command.

processedEntityCount -> (integer)

The number of processed entities. Processed tables for HBase, paths for HDFS snapshots.

unprocessedEntityCount -> (integer)

The number of unprocessed entities. Unprocessed tables for HBase, paths for HDFS snapshots.

createdSnapshotCount -> (integer)

The number of snapshots created.

deletedSnapshotCount -> (integer)

The number of snapshots deleted.

creationErrorCount -> (integer)

The number of errors encountered when creating snapshots.

deletionErrorCount -> (integer)

The number of errors encountered when deleting snapshots.

processedEntities -> (array)

The list of processed entities. Processed tables for HBase, paths for HDFS snapshots.

item -> (string)

unprocessedEntities -> (array)

The list of unprocessed entities. Unprocessed tables for HBase, paths for HDFS snapshots.

item -> (string)

createdSnapshots -> (array)

The list of snapshots created.

item -> (object)

Detailed description about a snapshot.

snapshotName -> (string)

The name of the snapshot.

path -> (string)

The snapshotted HDFS path/HBase table.

snapshotPath -> (string)

The fully qualified path of the snapshot.

storage -> (string)

The location where the HBase shapshot is stored.

creationTime -> (datetime)

The creation time of the snapshot.

deletedSnapshots -> (array)

The list of snapshots deleted.

item -> (object)

Detailed description about a snapshot.

snapshotName -> (string)

The name of the snapshot.

path -> (string)

The snapshotted HDFS path/HBase table.

snapshotPath -> (string)

The fully qualified path of the snapshot.

storage -> (string)

The location where the HBase shapshot is stored.

creationTime -> (datetime)

The creation time of the snapshot.

creationErrors -> (array)

The list of errors encountered when creating snapshots.

item -> (object)

Detailed description about a snapshot operation error.

snapshotName -> (string)

The name of the snapshot.

path -> (string)

The HDFS path/HBase table name for which the snapshot error occurred.

error -> (string)

The description of the error.

deletionErrors -> (array)

The list of errors encountered when deleting snapshots.

item -> (object)

Detailed description about a snapshot operation error.

snapshotName -> (string)

The name of the snapshot.

path -> (string)

The HDFS path/HBase table name for which the snapshot error occurred.

error -> (string)

The description of the error.

hdfsResult -> (object)

The detailed results of a snapshot command.

processedEntityCount -> (integer)

The number of processed entities. Processed tables for HBase, paths for HDFS snapshots.

unprocessedEntityCount -> (integer)

The number of unprocessed entities. Unprocessed tables for HBase, paths for HDFS snapshots.

createdSnapshotCount -> (integer)

The number of snapshots created.

deletedSnapshotCount -> (integer)

The number of snapshots deleted.

creationErrorCount -> (integer)

The number of errors encountered when creating snapshots.

deletionErrorCount -> (integer)

The number of errors encountered when deleting snapshots.

processedEntities -> (array)

The list of processed entities. Processed tables for HBase, paths for HDFS snapshots.

item -> (string)

unprocessedEntities -> (array)

The list of unprocessed entities. Unprocessed tables for HBase, paths for HDFS snapshots.

item -> (string)

createdSnapshots -> (array)

The list of snapshots created.

item -> (object)

Detailed description about a snapshot.

snapshotName -> (string)

The name of the snapshot.

path -> (string)

The snapshotted HDFS path/HBase table.

snapshotPath -> (string)

The fully qualified path of the snapshot.

storage -> (string)

The location where the HBase shapshot is stored.

creationTime -> (datetime)

The creation time of the snapshot.

deletedSnapshots -> (array)

The list of snapshots deleted.

item -> (object)

Detailed description about a snapshot.

snapshotName -> (string)

The name of the snapshot.

path -> (string)

The snapshotted HDFS path/HBase table.

snapshotPath -> (string)

The fully qualified path of the snapshot.

storage -> (string)

The location where the HBase shapshot is stored.

creationTime -> (datetime)

The creation time of the snapshot.

creationErrors -> (array)

The list of errors encountered when creating snapshots.

item -> (object)

Detailed description about a snapshot operation error.

snapshotName -> (string)

The name of the snapshot.

path -> (string)

The HDFS path/HBase table name for which the snapshot error occurred.

error -> (string)

The description of the error.

deletionErrors -> (array)

The list of errors encountered when deleting snapshots.

item -> (object)

Detailed description about a snapshot operation error.

snapshotName -> (string)

The name of the snapshot.

path -> (string)

The HDFS path/HBase table name for which the snapshot error occurred.

error -> (string)

The description of the error.

estimatedExpiration -> (datetime)

The estimated expiration time of the snapshot created by the snapshot command.

errorResponses -> (array)

List of snapshot policy errors.

item -> (object)

API error.

code -> (integer)

Error code.

message -> (string)

Error message.

status -> (string)

Error status.

clusterUrl -> (string)

Cluster URL.

requestId -> (string)

Request ID.

Form Factors¶

public