SnapshotsResource Resource

Available since API v6. Only available with Cloudera Manager Enterprise Edition.

POST /clusters/{clusterName}/services/{serviceName}/snapshots

Request Parameters
name type description default
clusterName path n/a
serviceName path n/a
directCopy query n/a
externalAccount query n/a
numMappers query n/a
schdulerPoolName query n/a
Request Body
media type data type
application/json ApiHBaseSnapshot (JSON)
Response Body
media type data type description
application/json ApiCommand (JSON)

POST /clusters/{clusterName}/services/{serviceName}/snapshots

Creates one or more snapshot policies.

Request Parameters
name type description default
clusterName path n/a
serviceName path n/a
Request Body
media type data type
application/json ApiAdhocSnapshot (JSON)
Response Body
media type data type description
application/json ApiCommand (JSON) List of newly added policies.

GET /clusters/{clusterName}/services/{serviceName}/snapshots/policies

Returns information for all snapshot policies.

Request Parameters
name type description default
clusterName path n/a
serviceName path n/a
view query The view to materialize. summary
Response Body
media type data type description
application/json ApiSnapshotPolicyList (JSON) List of snapshot policies.

POST /clusters/{clusterName}/services/{serviceName}/snapshots/policies

Creates one or more snapshot policies.

Request Parameters
name type description default
clusterName path n/a
serviceName path n/a
Request Body
media type data type description
application/json ApiSnapshotPolicyList (JSON) List of the snapshot policies to create.
Response Body
media type data type description
application/json ApiSnapshotPolicyList (JSON) List of newly added policies.

DELETE /clusters/{clusterName}/services/{serviceName}/snapshots/policies/{policyName}

Deletes an existing snapshot policy.

Request Parameters
name type description default
clusterName path n/a
policyName path Name of an existing snapshot policy. n/a
serviceName path n/a
Response Body
media type data type description
application/json ApiSnapshotPolicy (JSON) The deleted snapshot policy.

GET /clusters/{clusterName}/services/{serviceName}/snapshots/policies/{policyName}

Returns information for a specific snapshot policy.

Request Parameters
name type description default
clusterName path n/a
policyName path Name of an existing snapshot policy. n/a
serviceName path n/a
view query The view to materialize. summary
Response Body
media type data type description
application/json ApiSnapshotPolicy (JSON) Snapshot policy.

PUT /clusters/{clusterName}/services/{serviceName}/snapshots/policies/{policyName}

Updates an existing snapshot policy.

Request Parameters
name type description default
clusterName path n/a
policyName path Name of an existing snapshot policy. n/a
serviceName path n/a
Request Body
media type data type description
application/json ApiSnapshotPolicy (JSON) Modified policy.
Response Body
media type data type description
application/json ApiSnapshotPolicy (JSON) The snapshot policy after the update.

GET /clusters/{clusterName}/services/{serviceName}/snapshots/policies/{policyName}/history

Returns a list of commands triggered by a snapshot policy.

Request Parameters
name type description default
clusterName path n/a
policyName path Name of an existing snapshot policy. n/a
serviceName path n/a
limit query Maximum number of commands to retrieve. 20
offset query Index of first command to retrieve. 0
view query The view to materialize. summary
Response Body
media type data type description
application/json ApiSnapshotCommandList (JSON) List of commands for the policy.