API Actions: GetReplicationsList

Supported in product version 11.10 and above

This method returns a list of Replications defined in your cloudbasic installation.

Request Syntax: 

POST /api/GetReplicationsList HTTP/1.1
Host: use.your.host.name:82
X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
Content-Type: application/xml
X-Amz-Date: 20171115T202130Z
Authorization: AWS4-HMAC-SHA256 Credential= UQOPWUVNBALABCABCABC/20171115/us-east-1/cloudbasic/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-content-sha256;x-amz-date, Signature=995374189c189e8e68ed3de82c1764ca11971711fb5179eeab2b19edd883dd74

Request Parameters

None

Request Headers

This implementation uses only request headers that are common to all operations. For more information please see the section Common Request Headers

Response Syntax:

XML 

HTTP/1.1 200
status: 200

<?xml version="1.0" encoding="utf-8"?>
<GetReplicationsListResponse>
	<Replications>
		<Replication>
			<GUID>301fb401-7595-44d8-8309-1cf3224f38b0</ReplicationId>
			<Source>Data Source=YourDataSource1;Initial Catalog=YourInitialCatalog1;Persist Security Info=False;User ID=YourID;Password=******;Connect Timeout=12800;Encrypt=True;TrustServerCertificate=True</Source>
			<Destination>Data Source=YourDataDest1;Initial Catalog=YourCatalog1;Persist Security Info=False;User ID=YourID;Password=******;Connect Timeout=12800;Encrypt=True;TrustServerCertificate=True</Destination>
			<IsEnabled>true</IsEnabled>
			<LastSuccessfullTransfer>Wednesday, May 23, 2018 6:03:14 AM</LastSuccessfullTransfer>
		</Replication>
		<Replication>
			<GUID>d41fb59f-50bf-4937-b7c2-5e5a2c77fa17</ReplicationId>
			<Source>Data Source=YourDataSource2;Initial Catalog=YourInitialCatalog2;Persist Security Info=False;User ID=YourID;Password=******;Connect Timeout=12800;Encrypt=True;TrustServerCertificate=True</Source>
			<Destination>Data Source=YourDataDest2;Initial Catalog=YourCatalog2;Persist Security Info=False;User ID=YourID;Password=******;Connect Timeout=12800;Encrypt=True;TrustServerCertificate=True</Destination>
			<IsEnabled>false</IsEnabled>
			<LastSuccessfullTransfer>Wednesday, May 23, 2018 2:06:26 AM</LastSuccessfullTransfer>
		</Replication>
		<Replication>
			<GUID>952aaee3-ab5b-4f2d-8bca-e9aa09c54a5c</ReplicationId>
			<Source>Data Source=YourDataSource3;Initial Catalog=YourInitialCatalog3;Persist Security Info=False;User ID=YourID;Password=******;Connect Timeout=12800;Encrypt=True;TrustServerCertificate=True</Source>
			<Destination>Data Source=YourDataDest3;Initial Catalog=YourCatalog3;Persist Security Info=False;User ID=YourID;Password=******;Connect Timeout=12800;Encrypt=True;TrustServerCertificate=True</Destination>
			<IsEnabled>false</IsEnabled>
			<LastSuccessfullTransfer>Wednesday, May 23, 2018 2:06:57 AM</LastSuccessfullTransfer>
		</Replication>
	</Replications>
</GetReplicationsListResponse>

JSON 

HTTP/1.1 200
status: 200
{
	"replications": [
		{
			"guid": "301fb401-7595-44d8-8309-1cf3224f38b0",
			"source": "Data Source=YourDataSource1;Initial Catalog=YourInitialCatalog1;Persist Security Info=False;User ID=YourID;Password=******;Connect Timeout=12800;Encrypt=True;TrustServerCertificate=True",
			"destination": "Data Source=YourDataDest1;Initial Catalog=YourCatalog1;Persist Security Info=False;User ID=YourID;Password=******;Connect Timeout=12800;Encrypt=True;TrustServerCertificate=True",
			"isEnabled": "true",
			"lastSuccessfullTransfer": "Wednesday, May 23, 2018 6:03:14 AM"
		},
		{
			"guid": "d41fb59f-50bf-4937-b7c2-5e5a2c77fa17",
			"source": "Data Source=YourDataSource2;Initial Catalog=YourInitialCatalog2;Persist Security Info=False;User ID=YourID;Password=******;Connect Timeout=12800;Encrypt=True;TrustServerCertificate=True",
			"destination": "Data Source=YourDataDest2;Initial Catalog=YourCatalog2;Persist Security Info=False;User ID=YourID;Password=******;Connect Timeout=12800;Encrypt=True;TrustServerCertificate=True",
			"isEnabled": "false",
			"lastSuccessfullTransfer": "Wednesday, May 23, 2018 2:06:26 AM"
		},
		{
			"guid": "952aaee3-ab5b-4f2d-8bca-e9aa09c54a5c",
			"source": "Data Source=YourDataSource3;Initial Catalog=YourInitialCatalog3;Persist Security Info=False;User ID=YourID;Password=******;Connect Timeout=12800;Encrypt=True;TrustServerCertificate=True",
			"destination": "Data Source=YourDataDest3;Initial Catalog=YourCatalog3;Persist Security Info=False;User ID=YourID;Password=******;Connect Timeout=12800;Encrypt=True;TrustServerCertificate=True",
			"isEnabled": "false",
			"lastSuccessfullTransfer": "Wednesday, May 23, 2018 2:06:57 AM"
		}
	]
}

Response Parameters

Parameter Description Optional
Replication It contains the information for each Replication. No
GUID This is a GUID that uniquely identifies the Replication listed. No
Source A valid connection string to the source database instance. No
Destination A valid connection string to the destination database instance. No
IsEnabled Indicates whether the replication is enabled for execution or not. No
LastSuccessfullTransfer The date and time when the replication was last completed successfully. No

Error Response Syntax:

XML 

HTTP/1.1 400
status: 400

<?xml version="1.0" encoding="utf-8"?>
<ErrorResponse> 
	<RequestId>request-id</RequestId> 
	<Errors> 
		<Error> Error occurred while retrieving </Error> 
	</Errors> 
</ErrorResponse>

JSON 

HTTP/1.1 400
status: 400

{
    "errors": [
        "Error occurred while retrieving"
    ],
    "requestId": "26"
}