Using the replication REST APIs for Db2

Important: IBM Cloud Pak for Data Version 4.6 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.6 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

Replication provides an interactive API console that enables you to view and try the product REST API calls before using them to automate or script replication health checks or setup tasks.

About this task

The replication REST APIs give you the flexibility to develop your own applications to use the replication feature, for example to tailor a specific type of user interface to your business requirements. You can use the APIs to perform the following functions among others:

Health

Monitor the health of the replication environment

Replication set

Create, update, delete, list, start, stop, add or remove a table
Start or stop replication for a table
Add schema-level subscriptions to a set, remove them from a set, and start or stop schema-level subscriptions
Monitor a replication set, get historical metric data

Source

Enable replication, activate replication, check for requirements, check for SSL certificate, validate connectivity, check or update credentials

Target

Initialize, check requirements, validate connectivity, trust and exchange certificates, update credentials, monitor calls

Procedure

Launch the console in a web browser.

https://hostname:port/api/explorer

Where hostname is the hostname of the cluster where the source database is running, and port is the external port number of the replication REST API server.

To find the REST external port number, run the following command:

oc get svc -n ${PROJECT_CPD_INSTANCE} | grep qrep

The results should be similar to the following example:

[root@api.db2u-dr4.cp.fyre.ibm.com ~]# oc get svc | grep db2
c-db2oltp-1630636239936781-db2u                ClusterIP   172.30.56.242    <none>        50000/TCP,50001/TCP,25000/TCP,25001/TCP,25002/TCP,25003/TCP,25004/TCP,25005/TCP   33d
c-db2oltp-1630636239936781-db2u-engn-svc       NodePort    172.30.33.105    <none>        50000:30350/TCP,50001:31715/TCP                                                   33d
c-db2oltp-1630636239936781-db2u-internal       ClusterIP   None             <none>        50000/TCP,9443/TCP,50052/TCP                                                      33d
c-db2oltp-1630636239936781-etcd                ClusterIP   None             <none>        2379/TCP,2380/TCP                                                                 33d
c-db2oltp-1630636239936781-qrep-mq-svc         NodePort    172.30.91.42     <none>        1414:31535/TCP,1415:31667/TCP                                                     33d
c-db2oltp-1630636239936781-qrep-rest-svc       NodePort    172.30.89.122    <none>        9444:31313/TCP

Look for the c-instance-ID-qrep-rest-svc entry. The value in the right column contains the replication port number, which in this example is 9444:31313/TCP. The 31313 portion is the replication port number.

Click one of the API categories to open it.
Click the icon to enter a user ID and password that is authorized to run commands on the replication source system and access the source database.

The Implementation Notes field describes the purpose of the API call. The Response Messages field displays the return code from the call that you can use in your application or script.
To view the usage information and responses from the API call, click Try it out!
This image shows the button in the Health section:

The UI generates the following information:
Curl command
The API request is shown as a Curl command that you can copy into a command shell or script.
Note: If you want to run the curl command outside of the API console, specify the following options:

User authentication (-u or --user)

If you do not have a CA-signed certificate installed in your environment, insecure option (-k or --insecure)

For additional help, run the curl -- help command.
Request URL

The URL that is used when a web client makes a request to a server for a resource.

Response Body

The Java code that is returned from the API call and that you can incorporate into your applications.

Response Code

The response code that is returned from the API call.

Response Headers

An HTTP header that can be used in an HTTP response and that does not relate to the content of the message.
For APIs that require you to provide input parameters in a defined format, the console displays sample parameter values such as dbHost, dbPort, or dbName. For example, the following images shows example values for a source database connection: