Deleting a replication set

You can remove one or more replication sets that are no longer being replicated.

Before you begin

This task is done on the cluster host for the replication source. Ensure that you collect the following information before you run the API call:

  • The basic authorization token of the source on the cluster host.1
  • The host name of the replication source database.
  • The external port number of the replication source database.2
  • The replication set name (rsName).3
  • The consistency group name (cgName).
You need this information to run the needed Replication REST API calls.
1 You need to create a basic authorization token to run a cURL request. To create your token, run this command:
echo <source_db_username>:<source_db_password> | base64
2 You can retrieve the external port number of the replication source database by running the following command:
oc get svc | grep <db2_instance_id> | grep db2u-engn-svc | grep 50001 | sed 's/.*50001://' | sed 's/\/TCP.*//')
3 You can find the replication set name (rsName) and consistency group name (cgName) by running the following command:
curl --insecure -X GET --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Basic <your_authorization_token> 
'https://<source_hostname>:<source_rest_port>/dr/v1/replicationset'

About this task

Removing a replication set does not affect other replication sets in the replication configuration.

Procedure

  1. Delete the replication set from your replication configuration: 
    curl --insecure -X DELETE --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Basic <your_authorization_token>' 
'https://<source_hostname>:<source_rest_port>/dr/v1/replicationset/<replication_set_name>/<consistency_group_name>'
    This API call returns a job number (id).
    {
  "id": <job_number>,
  "url": "https://<source_hostname>:<source_rest_external_port>/dr/v1/target/progress/<job_number>"
}
  2. Include the job number in the following API call to check the progress of the replication set deletion: 
    curl --insecure -X GET --header 'Accept: application/json' --header 'Authorization: Basic <your_authorization_token>' 
'https://<source_hostname>:<source_rest_port>/dr/v1/replicationset/progress/<job_number>'

Results

The deletion of the replication set is complete when a response message that contains "executionState": "COMPLETED", "overallJobResult": "PASS" is returned. Until these values are returned, examine the error code, message, and resolution in the response.
The following table lists the possible HTTP status codes and response messages for the replication set deletion API call. It also includes sample code to show the response syntax.
HTTP Status Code Reason Response Model
202 Job was created to delete the replication set. The user request returns a job (id) and URL as the API call starts (sample value):

{
  "id": 10,
  "url": "https://dr-source1.ibm.com:31023/dr/v1/replicationset/progress/10"
}
The user request returns a successful response for the completion of the API call (sample value)::
{
  "id": 10,
  "url": "https://dr-source1.ibm.com:31023/dr/v1/replicationset/progress/10",
  "executionState": "COMPLETED",
  "overallJobResult": "PASS",
  "jobStatusList": [
    {
      "jobKey": "cgDeletionSetup",
      "jobDescription": "Setup objects for consistency group deletion.",
      "execState": "COMPLETED",
      "jobResult": "PASS",
      "values": [],
      "errors": []
    },
    {
      "jobKey": "stopRepCg",
      "jobDescription": "Stop the send queue",
      "execState": "COMPLETED",
      "jobResult": "PASS",
      "values": [],
      "errors": []
    },
    {
      "jobKey": "stopSrcChl",
      "jobDescription": "Stop the source channels",
      "execState": "COMPLETED",
      "jobResult": "PASS",
      "values": [],
      "errors": []
    },
    {
      "jobKey": "deleteTgtQmObj",
      "jobDescription": "Delete target queue manager objects",
      "execState": "COMPLETED",
      "jobResult": "PASS",
      "values": [],
      "errors": []
    },
    {
      "jobKey": "deleteSrcQmObj",
      "jobDescription": "Delete source queue manager objects",
      "execState": "COMPLETED",
      "jobResult": "PASS",
      "values": [],
      "errors": []
    },
    {
      "jobKey": "deleteSchemaSubs",
      "jobDescription": "Delete the schema sub from the consistency group.",
      "execState": "COMPLETED",
      "jobResult": "PASS",
      "values": [],
      "errors": []
    },
    {
      "jobKey": "deleteTable",
      "jobDescription": "Delete the table from the consistency group.",
      "execState": "COMPLETED",
      "jobResult": "PASS",
      "values": [],
      "errors": []
    },
    {
      "jobKey": "deleteCg",
      "jobDescription": "Delete the consistency group",
      "execState": "COMPLETED",
      "jobResult": "PASS",
      "values": [],
      "errors": []
    }
  ]
}
4xx Client request error The user request was not fulfilled due to malformed request syntax or other client issues:
{
  "errorCode": "string",
  "errorMessage": "string",
  "errorResolution": "string"
}
5xx Server error The user request appeared valid, but was not fulfilled due to an issue with the server:
{
  "errorCode": "string",
  "errorMessage": "string",
  "errorResolution": "string"
}

Example

The following example shows the command syntax for deleting a replication set from a replication configuration. See step 1: 
curl --insecure -X DELETE --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Basic ZHNhZG06MDNRVWlMczFhcmoxb3ky' 
'https://dr-source1.ibm.com:31023/dr/v1/replicationset/DEMOREPLSET1/DEMORE0001'
The following example shows the command syntax for checking the progress of the replication set deletion by including the job number 10. See step 2:
curl --insecure -X GET --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Basic ZHNhZG06MDNRVWlMczFhcmoxb3ky'
'https://dr-source1.ibm.com:31023/dr/v1/replicationset/progress/10'