Jump to

• Request
• Response

ReplicationTargetGet

get

/20171215/replicationTargets/actions/replicationTargetGet

Gets the specified replication target's information.

Request

Supported Media Types

• application/json

Query Parameters

• replicationTargetId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The [OCID](/Content/General/Concepts/identifiers.htm) of the replication target.

  Default Value: none

Header Parameters

• opc-request-id: string
  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

• application/json

200 Response

The replication target was retrieved.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  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 : 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

• applyingReplicationProgress: integer(int64)
  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.
• availabilityDomain: string
  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`
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the replication.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
• deltaProgress: integer(int64)
  Minimum Value: 0

  Maximum Value: 100

  Percentage progress of the current replication cycle.
• deltaStatus: string
  Allowed Values: [ "IDLE", "CAPTURING", "APPLYING", "SERVICE_ERROR", "USER_ERROR", "FAILED", "TRANSFERRING" ]

  The current state of the snapshot during replication operations.
• displayName(required): string
  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: object 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"}
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The [OCID](/Content/General/Concepts/identifiers.htm) of the replication.
• lastSnapshotId: string
  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.
• lifecycleDetails: string
  Additional information about the current `lifecycleState`.
• lifecycleState(required): string
  Allowed Values: [ "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED" ]

  The current state of this replication.
• recoveryPointTime: string(date-time)
  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`
• replicationId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The [OCID](/Content/General/Concepts/identifiers.htm) of replication.
• sourceId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The [OCID](/Content/General/Concepts/identifiers.htm) of source filesystem.
• systemTags: object systemTags
  Additional Properties Allowed: additionalProperties

  Not used by File Systems but required for SPLAT tag integration.
• targetId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The [OCID](/Content/General/Concepts/identifiers.htm) of target filesystem.
• timeCreated(required): string(date-time)
  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`

{
    "x-obmcs-splat":{
        "resourceKind":"replication-targets",
        "adLocality":"ad-local",
        "taggable":true,
        "activeLifecycleStates":[
            "ACTIVE"
        ],
        "deletedLifecycleStates":[
            "DELETED"
        ],
        "getOperationId":"GetReplicationTarget",
        "listResourcesOperationId":"ListReplicationTargets",
        "ocidEntityType":"fssreplicationtarget",
        "useSurrogateKeyForCreation":true,
        "getBySurrogateKeyUri":"/20171215/replicationTargets/splat-request",
        "searchMetadata":{
            "resourceSchemaVersion":1,
            "resourceType":"FssReplicationTarget",
            "scope":"customer"
        }
    },
    "description":"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). ",
    "x-example":"{  \"availabilityDomain\": \"pWEh:PHX-AD-2\",  \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",  \"id\": \"string\",  \"lifecycleState\": \"ACTIVE\",  \"name\": \"replication-1\",  \"timeCreated\": \"2021-01-10T22:37:23.706Z\"  \"sourceId\" : \"ocid1.filesystem.oc1..<var>&lt;unique_ID&gt;</var>\"  \"targetId\" : \"ocid1.filesystem.oc1..<var>&lt;unique_ID&gt;</var>\"  \"replicationTargetId\" : \"ocid1.replicationtarget.oc1..<var>&lt;unique_ID&gt;</var>\" } ",
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain the replication resource is in. May be unset as a blank or NULL value.  Example: `Uocm:PHX-AD-1` ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "compartmentId":{
            "description":"The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the replication.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "id":{
            "description":"The [OCID](/Content/General/Concepts/identifiers.htm) of the replication.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of this replication.",
            "enum":[
                "CREATING",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "FAILED"
            ],
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. This name is same as the replication display name for the associated resource. Example: `My Replication` ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "timeCreated":{
            "description":"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` ",
            "format":"date-time",
            "type":"string"
        },
        "sourceId":{
            "description":"The [OCID](/Content/General/Concepts/identifiers.htm) of source filesystem.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "targetId":{
            "description":"The [OCID](/Content/General/Concepts/identifiers.htm) of target filesystem.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "replicationId":{
            "description":"The [OCID](/Content/General/Concepts/identifiers.htm) of replication.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "lastSnapshotId":{
            "description":"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. ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "recoveryPointTime":{
            "description":"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` ",
            "format":"date-time",
            "type":"string"
        },
        "deltaStatus":{
            "description":"The current state of the snapshot during replication operations.",
            "enum":[
                "IDLE",
                "CAPTURING",
                "APPLYING",
                "SERVICE_ERROR",
                "USER_ERROR",
                "FAILED",
                "TRANSFERRING"
            ],
            "type":"string"
        },
        "applyingReplicationProgress":{
            "description":"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. ",
            "type":"integer",
            "format":"int64",
            "maximum":100,
            "minimum":0
        },
        "deltaProgress":{
            "description":"Percentage progress of the current replication cycle. ",
            "type":"integer",
            "format":"int64",
            "maximum":100,
            "minimum":0
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{\"CostCenter\": \"42\"}` ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported. "
                }
            }
        },
        "systemTags":{
            "description":"Not used by File Systems but required for SPLAT tag integration.",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}` ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string type is supported. "
                }
            }
        },
        "lifecycleDetails":{
            "description":"Additional information about the current `lifecycleState`.",
            "type":"string"
        }
    },
    "required":[
        "compartmentId",
        "displayName",
        "id",
        "lifecycleState",
        "timeCreated",
        "sourceId",
        "targetId",
        "replicationId"
    ],
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

{
    "type":"object",
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{\"CostCenter\": \"42\"}` ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported. "
        }
    }
}

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

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

{
    "description":"Not used by File Systems but required for SPLAT tag integration.",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}` ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string type is supported. "
        }
    }
}

Not used by File Systems but required for SPLAT tag integration.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{\"CostCenter\": \"42\"}` ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported. "
    }
}

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

• object additionalProperties
  The value of the tag. Only string type is supported.

{
    "type":"object",
    "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}` ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string type is supported. "
    }
}

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.

401 Response

Unauthorized

Headers

• opc-request-id: string
  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

• code(required): string
  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).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

• opc-request-id: string
  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

• code(required): string
  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).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  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

• code(required): string
  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).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  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

• code(required): string
  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).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  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

• code(required): string
  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).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top