Enable comprehensive panoramic protection for multiple volumes (v1)
Suggest changes
POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/panoramic-protection/working-environment/{workingEnvironmentId}/volume
Enables comprehensive panoramic protection for multiple volumes. Based on the backup workflow chosen, Cascading or Fan-Out, the API creates a replication relationship with a volume in the secondary cluster and then creates a backup to cloud relationship with a cloud or StorageGRID object store. While setting up the replication relationship, the API verifies whether a cluster peering relationship is set up between primary and secondary clusters. If there is no relationship, it creates a cluster peering relationship, storage VM peering, and a DP volume on the secondary cluster. Once the replication setup is complete, the API performs a SnapMirror Create and Initialize operation. For creating a backup to cloud, it first creates a bucket to which the backup is transferred, and then a SnapMirror cloud relationship is created and initialized.
Token usage: NetApp Console user token.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
accountId |
string |
path |
True |
Account ID |
workingEnvironmentId |
string |
path |
True |
System ID |
authorization |
string |
header |
True |
User token |
X-Agent-Id |
string |
header |
True |
Request identifier |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
volume |
array[volume] |
True |
Example request
{
"volume": [
{}
]
}Response
Status: 202, Default response| Name | Type | Required | Description |
|---|---|---|---|
job-id |
string |
False |
Example response
{
"job-id": "string"
}Definitions
See Definitions
rule
| Name | Type | Required | Description |
|---|---|---|---|
label |
string |
False |
|
retention |
string |
False |
backup-policy
| Name | Type | Required | Description |
|---|---|---|---|
name |
string |
False |
Required input |
rule |
array[rule] |
False |
|
archive-after-days |
string |
False |
|
object-lock |
string |
False |
replication
| Name | Type | Required | Description |
|---|---|---|---|
working-environment-id |
string |
False |
|
working-environment-name |
string |
False |
|
svm |
string |
False |
|
policy-name |
string |
False |
|
prefix |
string |
False |
|
suffix |
string |
False |
|
destination-aggregates |
array[string] |
False |
is-enabled
| Name | Type | Required | Description |
|---|---|---|---|
local-snapshot |
boolean |
False |
|
replication |
boolean |
False |
|
cloud-backup |
boolean |
False |
volume
| Name | Type | Required | Description |
|---|---|---|---|
volume-id |
string |
True |
|
volume-name |
string |
False |
|
workload |
string |
False |
Workload type of the volume. Currently only SQL, VOLUMES, VMWARE, ORACLE, HYPERV, K8S, KVM workloads are supported |
architecture |
string |
False |
Type of storage architecture. Fan-out or Cascading |
mode |
string |
False |
|
type |
string |
False |
|
backup-policy |
False |
||
snapshot-policy |
string |
False |
Snapshot policy name |
replication |
False |
||
is-enabled |
True |
body
| Name | Type | Required | Description |
|---|---|---|---|
volume |
array[volume] |
True |