Comparing Parameter Templates

API Description

This API is used to compare two parameter templates.

Restrictions

Only parameter templates of the same version and type can be compared. For example, a mongos parameter template of cluster 4.0 can be compared only with a mongos parameter template of cluster 4.0.

URI

URI format
POST https://{Endpoint}/v3/{project_id}/configurations/comparison

**Table 1** Path parameters
Parameter	Type	IN	Mandatory	Description
project_id	string	path	Yes	Project ID of a tenant in a region. Obtain the project ID by following the instructions in Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	User token

**Table 3** Request body parameters
Name	Type	Mandatory	Description
source_configuration_id	String	Yes	ID of the source parameter template to be compared.
target_configuration_id	String	Yes	ID of the target parameter template to be compared.

Example request

{
  "source_configuration_id" : "0764fdcd949b411ba76c2b762b80c212pr02",
  "target_configuration_id" : "fa42c57bb62844e490052f2ff9d5a264pr02"
}

Response Parameters

**Table 4** Response body parameters
Name	Type	Description
differences	Array of Table 5-5 objects	Set of differences between parameters.
source_configuration	Array of Table 6 objects	ID and name of a source parameter template.
target_configuration	Array of Table 6 objects	ID and name of a target parameter template.

**Table 5** DiffDetails
Name	Type	Description
parameter_name	String	Parameter name.
source_value	String	Parameter value in the source parameter template.
target_value	String	Parameter value in the target parameter template.

**Table 6** DiffConfigurationAttr
Parameter	Type	Description
id	String	Parameter template ID.
name	String	Parameter template name.

Example response

{
    "source_configuration": {
        "id": "941f8b7292904a4bb079a74fcf846b46pr02",
        "name": "mongodb_9f9fdc67-67e"
    },
    "target_configuration": {
        "id": "0764fdcd949b411ba76c2b762b80c212pr02",
        "name": "Default-DDS-4.0-Replica"
    },
    "differences": [
        {
            "parameter_name": "connPoolMaxConnsPerHost",
            "source_value": "600",
            "target_value": "601"
        },
        {
            "parameter_name": "connPoolMaxShardedConnsPerHost",
            "source_value": "600",
            "target_value": "601"
        },
        {
            "parameter_name": "cursorTimeoutMillis",
            "source_value": "600000",
            "target_value": "600001"
        },
        {
            "parameter_name": "userCacheInvalidationIntervalSecs",
            "source_value": "30",
            "target_value": "31"
        }
    ]
}