Jump to

• Request
• Response

GetReplicationTargetProgress

get

/20171215/replicationTargets/actions/replicationTargetProgress

Get ReplicationTarget's progress in a remote region.

Request

Supported Media Types

• application/json

Query Parameters

• lastSnapshotNum: string
  Minimum Value: 0

  The `objectNum` of the start point of the snapshot during replication operations.
• newSnapshotNum: string
  Minimum Value: 1

  The `objectNum` of the end point of the snapshot during replication operations.
• replicationNum: string
  Minimum Value: 1

  The `objectNum` of the associated replication.
• replicationTargetId(required): string
  Minimum Length: 1

  Maximum Length: 255

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

  Default Value: none
• sourceProgressPercentage(required): integer
  Minimum Value: 0

  Maximum Value: 100

  The `progressPercentage` of the associated replication source job.

  Default Value: 0

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

Get ReplicationTarget's progress and combined progress from remote region.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request.

Body ()

Root Schema : ReplicationTargetProgress

Type: object

The progress percentage of target job and source-target combined progress percentage.

Show Source

• combinedProgressPercentage(required): integer
  Minimum Value: 0

  Maximum Value: 100

  The average Progress percentage between the source job and target job.
• lastSnapshotNum(required): string
  Minimum Length: 1

  Maximum Length: 255

  The num of the last snapshot which was completely applied to the target file system.
• newSnapshotNum(required): string
  Minimum Length: 1

  Maximum Length: 255

  The num of the new snapshot which is currently being applied to the target file system.
• replicationId(required): string
  Minimum Length: 1

  Maximum Length: 255

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

  Maximum Length: 255

  The [OCID](/Content/General/Concepts/identifiers.htm) of replicationTarget.
• targetProgressPercentage(required): integer
  Minimum Value: 0

  Maximum Value: 100

  The Progress percentage of the target job.

{
    "description":"The progress percentage of target job and source-target combined progress percentage.",
    "x-example":"{  \"targetProgressPercentage\": 50,  \"combinedProgressPercentage\": 55,  \"lastSnapshotNum\": \"1357923\",  \"newSnapshotNum\": \"984624\",  \"replicationId\": \"ocid1.fssreplication.oc1..<var>&lt;unique_ID&gt;</var>\"  \"replicationTargetId\": \"ocid1.fssreplicationtarget.oc1..<var>&lt;unique_ID&gt;</var>\" } ",
    "properties":{
        "targetProgressPercentage":{
            "description":"The Progress percentage of the target job.",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "combinedProgressPercentage":{
            "description":"The average Progress percentage between the source job and target job.",
            "maximum":100,
            "minimum":0,
            "type":"integer"
        },
        "lastSnapshotNum":{
            "description":"The num of the last snapshot which was completely applied to the target file system. ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "newSnapshotNum":{
            "description":"The num of the new snapshot which is currently being applied to the target file system. ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "replicationId":{
            "description":"The [OCID](/Content/General/Concepts/identifiers.htm) of replication.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "replicationTargetId":{
            "description":"The [OCID](/Content/General/Concepts/identifiers.htm) of replicationTarget.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        }
    },
    "required":[
        "replicationId",
        "replicationTargetId",
        "targetProgressPercentage",
        "combinedProgressPercentage",
        "lastSnapshotNum",
        "newSnapshotNum"
    ],
    "type":"object"
}

400 Response

Bad Request

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"
}

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"
}

409 Response

Conflict

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