Perform an action on a volume with SnapMirror replication
Suggest changes
PATCH /account/{accountId}/providers/cloudmanager_cbs/api/v1/replication/working-environment/{workingEnvironmentId}/relationship
Performs an action on a volume that has SnapMirror replication enabled. Using this API, you will be able to perform a SnapMirror relationship update, delete, pause, resync, reverse-resync, abort, and resume functionality on a replicated volume.
Token usage: NetApp Console user token.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
update-backup-inventory |
boolean |
query |
False |
Updates snapshot information in the database after a transfer to the object store. Default value is false.
|
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 |
|---|---|---|---|
relationships |
array[relationships] |
False |
Example request
{
"relationships": [
{
"working-environment-id": "string",
"relationship-id": "string",
"mode": "string",
"source-volume-id": "string",
"source-snapshot": "string"
}
]
}Response
Status: 202, Default response| Name | Type | Required | Description |
|---|---|---|---|
job-id |
string |
False |
Example response
{
"job-id": "string"
}Definitions
See Definitions
relationships
| Name | Type | Required | Description |
|---|---|---|---|
working-environment-id |
string |
True |
System ID (replication ONTAP cluster) where the relationship resides |
relationship-id |
string |
True |
|
mode |
string |
True |
Action to perform on replicated volume |
create-snapshot |
boolean |
False |
Boolean variable describing whether to create a snapshot on the source volume. |
source-volume-id |
string |
False |
ID of the source volume |
source-snapshot |
string |
False |
Snapshot name to be transferred when mode is UPDATE. This parameter is optional and is exclusive to create-snapshot being true. |
body
| Name | Type | Required | Description |
|---|---|---|---|
relationships |
array[relationships] |
False |