Get a ReplicationProfile by ID.

Request

Security

ApiKeyAuth

Path

replicationProfileIdstring, non-emptyrequired

The ID of the ReplicationProfile.

curl -i -X GET \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/23.0.0/continuous-data-apis-dct-23.0.0/replication-profiles/{replicationProfileId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

idstring

The ReplicationProfile ID.

namestring

The ReplicationProfile name.

replication_modestring

The ReplicationProfile mode.

Enum:"ENGINE_DATA_REPLICATION""MASKED_DATA_DISTRIBUTION""CONTINUOUS_VAULT"

engine_idstring

The ID of the engine that the ReplicationProfile belongs to.

target_engine_idstring

The ID of the replication target engine.

target_hoststring

Hostname of the replication target engine.

target_portinteger, [ 0 .. 65535 ]

Target TCP port number for the Delphix Session Protocol.

Default:8415

descriptionstring, <= 4096 characters

The ReplicationProfile description.

last_execution_statusstringread-only

The status of the last execution of the ReplicationProfile.

Enum:"RUNNING""COMPLETED""SUSPENDED""CANCELED""FAILED"

last_execution_status_timestampstring, (date-time)read-only

The timestamp of the last execution status.

schedulestring, [ 1 .. 256 ] characters

Replication schedule in the form of a quartz-formatted string.

replication_tagstring

Globally unique identifier for this ReplicationProfile.

tagsArray of objects(Tag)

The tags that are applied to this ReplicationProfile.

enable_tag_replicationboolean

Indicates whether tag replication from primary object to replica object is enabled or disabled for this ReplicationProfile.

bandwidth_limitinteger, >= 0

Bandwidth limit (MB/s) for replication network traffic. A value of 0 means no limit.

Default:0

number_of_connectionsinteger, [ 1 .. 16 ]

Total number of transport connections to use.

Default:1

encryptedboolean

Encrypt replication network traffic.

Default:false

automatic_replicationboolean

Indication whether the replication spec schedule is enabled or not.

Default:false

use_system_socks_settingboolean

Connect to the replication target host via the system-wide SOCKS proxy.

Default:false

vdb_idsArray of strings

The VDBs that are replicated by this ReplicationProfile.

dsource_idsArray of strings

The dSources that are replicated by this ReplicationProfile.

cdb_idsArray of strings

The CDBs that are replicated by this ReplicationProfile.

vcdb_idsArray of strings

The vCDBs that are replicated by this ReplicationProfile.

group_idsArray of strings

The groups that are replicated by this ReplicationProfile.

replicate_entire_engineboolean

Whether to replicate the entire engine. This is mutually exclusive with the vdb_ids, dsource_ids, cdb_ids, vcdb_ids, and group_ids properties.

data_layout_idsArray of stringsread-only

The data-layouts that are replicated by this ReplicationProfile.

typestringdeprecated

The ReplicationProfile type.

replication_objectsArray of stringsdeprecated

The objects that are replicated by this ReplicationProfile.

Response

{
  "id": "string",
  "name": "string",
  "replication_mode": "ENGINE_DATA_REPLICATION",
  "engine_id": "string",
  "target_engine_id": "string",
  "target_host": "string",
  "target_port": 8415,
  "type": "string",
  "description": "string",
  "last_execution_status": "RUNNING",
  "last_execution_status_timestamp": "2019-08-24T14:15:22Z",
  "schedule": "string",
  "replication_tag": "string",
  "replication_objects": [
    "string"
  ],
  "tags": [
    { … }
  ],
  "enable_tag_replication": true,
  "bandwidth_limit": 0,
  "number_of_connections": 1,
  "encrypted": false,
  "automatic_replication": false,
  "use_system_socks_setting": false,
  "vdb_ids": [
    "string"
  ],
  "dsource_ids": [
    "string"
  ],
  "cdb_ids": [
    "string"
  ],
  "vcdb_ids": [
    "string"
  ],
  "group_ids": [
    "string"
  ],
  "replicate_entire_engine": true,
  "data_layout_ids": [
    "string"
  ]
}