Modify comprehensive protection for multiple volumes (v1)
Suggest changes
PUT /account/{accountId}/providers/cloudmanager_cbs/api/v1/panoramic-protection/working-environment/{workingEnvironmentId}/volume
Modifies comprehensive protection for multiple volumes. If the selected volume already has an existing replication relationship, you can use the API to modify the replication policy. Otherwise, the API can be used to create a replication relationship. It creates a cluster-peer relationship, establishes a storage VM-peer relationship, creates a DP volume, and then performs the SnapMirror update/initialize process. Similarly, if the selected volume already has an existing "backup to the cloud" relationship, the API enables you to modify the backup policy. Alternatively, if there is no existing relationship, the API can be used to create SnapMirror cloud relationship. It creates a bucket in the specified cloud provider and then performs a SnapMirror cloud update/initialize operation.
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 |
type |
string |
False |
|
backup-policy |
False |
||
state |
string |
False |
|
snapshot-policy |
string |
False |
Snapshot policy name |
architecture |
string |
False |
Type of storage architecture. Fan-out or Cascading |
replication |
False |
||
is-enabled |
True |
body
| Name | Type | Required | Description |
|---|---|---|---|
volume |
array[volume] |
True |