Edit a mirror
Edit a mirror.
Request
Security
| Any | Super User | System Admin | Security Admin | Operator |
|---|---|---|---|---|
| superUser | systemAdmin |
HTTP method
POST /manager/api/{apiResponseType}/1.0/editMirror.adm HTTP/1.1 Host:{manager.dsnet}
id={mirrorId}&name={mirrorName}
Curl method
curl -u {admin}:{password} -k
”https://{manager.dsnet}/manager/api/json/1.0/editMirror.adm“ -d
”id={mirrorId}&name={mirrorName}“
Parameters
| Parameter | Type | Usage | Default | Description |
|---|---|---|---|---|
| id | Long | Required |
ID of mirror to edit. This ID is same as is returned by the dsNet Manager after creating a mirror. |
|
| name | String | Required |
New name to set for mirror. |
|
| description | String | Optional |
New description to set for the mirror. |
|
| writeThreshold | Integer | Optional | 1 | If set to one (1), only one of the two vaults that make up the mirror need to respond with a "success" for a given write operation on the mirror. Otherwise, with a write threshold of two (2), both vaults need to respond with a "success" for a given write operation on the mirror. |
| synchronousOperations | Map[{operation}] | Optional |
read=false write=false multipart=true delete=true |
Contains mirror operations and a flag that represents whether they should be synchronous operations (true) or not (false). Synchronous operations attempt to acknowledge that both sides are completed before returning. Operations include read, write, multipart, delete. |
| protectionState | String | Optional | disabled | Possible values are: disabled, or enabled. Note: To support backwards compatibility with ClevOS 3.12.0, this
request accepts the value
Compliance for the Status parameter in
addition to Retention. The protection state Retention and
Compliance are used interchangeably. |
| minimumRetentionPeriod | Long | Optional | 0 days | Accepts value in days. Minimum value should be ≥ 0 days. This parameter is only valid if protection state is set to enabled. Note: This is for vault mode only.
|
| maximumRetentionPeriod | Long | Optional | 36159 days | Accepts value in days. Maximum value should be ≤ 2,147,483,647 days. This parameter is only valid if protection state is set to enabled. Note: This is for vault mode
only.
|
| defaultRetentionPeriod | Long | Optional | 730 days | Accepts value in days. The default must be ≥mininumumRetentionPeriod and
≤maximumRetentionPeriod retention period. This parameter is only valid if protection state is set to enabled. Either defaultRetentionPeriod or defaultPermanentRetentionDurationEnabled should be specified, but not both. Note: This is for vault mode only.
|
| permanentRetentionEnabled | Boolean | Optional | false | This
allows objects to have permanent retention. This parameter is only valid if protection state is set to enabled. Note: This is vault mode only.
|
| defaultPermanentRetentionDurationEnabled | Boolean | Optional | false |
When set to true, objects written into this mirror without a specific retention period will have permanent retention. This parameter is only valid if protection state is set to enabled. Either defaultRetentionPeriod or defaultPermanentRetentionDurationEnabled should be specified, but not both. Note: This is vault mode only.
|
| organizationId | Long | Optional | The ID of the organization for the mirror. |
Response
Returns success or failure status.
HTTP response codes
- When using an incorrect mirror ID, the request responds with the 422 HTTP status code and the The given mirror id is invalid HTTP status message.
JSON response example
{
”responseStatus“: ”ok“,
”responseHeader“: {
”status“: ”ok“,
”now“: 1399577922741,
”requestId“: ”U2vdQsCoDkMAACkJCP0AAAAI“
},
”responseData“: {}
}