ReplicationTargetFail

post

/20171215/replicationTargets/actions/replicationTargetFail

Update ReplicationTarget to FAILED state in a remote region. This API is called as part of Replication Lifecycle Management.

Request

Supported Media Types
Query Parameters
Header Parameters
  • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Back to Top

Response

Supported Media Types

200 Response

Set ReplicationTarget to FAILED state.
Headers
Body ()
Root Schema : ReplicationTarget
Type: object
Replication targets are associated with a primary resource called a [`Replication`](#/en/iaas/latest/Replication) located in another availability domain in the same or different region. The replication retrieves the delta of data between two snapshots of a source file system and sends it to the associated `ReplicationTarget`, which applies it to the target file system. All operations (except `DELETE`) must be done using the associated replication resource. Deleting a `ReplicationTarget` allows the target file system to be exported. Deleting a `ReplicationTarget` does not delete the associated `Replication` resource, but places it in a `FAILED` state. For more information, see [File System Replication](/iaas/Content/File/Tasks/FSreplication.htm).
Show Source
  • Minimum Value: 0
    Maximum Value: 100
    Percentage progress of the snapshot which is currently being applied to the target region. If no application is in progress then this value is 100. Value is 0 before the initial snapshot is applied.
  • Minimum Length: 1
    Maximum Length: 255
    The availability domain the replication resource is in. May be unset as a blank or NULL value. Example: `Uocm:PHX-AD-1`
  • Minimum Length: 1
    Maximum Length: 255
    The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the replication.
  • definedTags
    Additional Properties Allowed: additionalProperties
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
  • Minimum Value: 0
    Maximum Value: 100
    Percentage progress of the current replication cycle.
  • Allowed Values: [ "IDLE", "CAPTURING", "APPLYING", "SERVICE_ERROR", "USER_ERROR", "FAILED", "TRANSFERRING" ]
    The current state of the snapshot during replication operations.
  • Minimum Length: 1
    Maximum Length: 255
    A user-friendly name. This name is same as the replication display name for the associated resource. Example: `My Replication`
  • freeformTags
    Additional Properties Allowed: additionalProperties
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
  • Minimum Length: 1
    Maximum Length: 255
    The [OCID](/Content/General/Concepts/identifiers.htm) of the replication.
  • Minimum Length: 1
    Maximum Length: 255
    The [OCID](/Content/General/Concepts/identifiers.htm) of the last snapshot snapshot which was completely applied to the target file system. Empty while the initial snapshot is being applied.
  • Additional information about the current `lifecycleState`.
  • Allowed Values: [ "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED" ]
    The current state of this replication.
  • The snapshotTime of the most recent recoverable replication snapshot in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2021-04-04T20:01:29.100Z`
  • Minimum Length: 1
    Maximum Length: 255
    The [OCID](/Content/General/Concepts/identifiers.htm) of replication.
  • Minimum Length: 1
    Maximum Length: 255
    The [OCID](/Content/General/Concepts/identifiers.htm) of source filesystem.
  • systemTags
    Additional Properties Allowed: additionalProperties
    Not used by File Systems but required for SPLAT tag integration.
  • Minimum Length: 1
    Maximum Length: 255
    The [OCID](/Content/General/Concepts/identifiers.htm) of target filesystem.
  • The date and time the replication target was created in target region. in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2021-01-04T20:01:29.100Z`
Nested Schema : definedTags
Type: object
Additional Properties Allowed
Show Source
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
Nested Schema : freeformTags
Type: object
Additional Properties Allowed
Show Source
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
Nested Schema : systemTags
Type: object
Additional Properties Allowed
Show Source
Not used by File Systems but required for SPLAT tag integration.
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
Nested Schema : additionalProperties
Type: object
The value of the tag. Only the String type is supported.
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`
Nested Schema : additionalProperties
Type: object
The value of the tag. Only string type is supported.

400 Response

Bad Request
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

401 Response

Unauthorized
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

404 Response

Not Found
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

409 Response

Conflict
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

429 Response

Too Many Requests
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

500 Response

Internal Server Error
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

Default Response

An error has occurred.
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.
Back to Top