Updated on 2023-11-21 GMT+08:00

Comparing Parameter Templates

Function

This API is used to compare two parameter templates.

Constraints

This API supports the following types of instances:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx

This API only compares parameter templates with one of the same node type and DB engine to learn about configurations of the current template.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

source_configuration_id

Yes

String

ID of the source parameter template to be compared.

target_configuration_id

Yes

String

ID of the destination parameter template for comparison.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

differences

Array of Table 5 objects

Differences between parameters.

Table 5 DiffDetails

Parameter

Type

Description

parameter_name

String

Parameter name.

source_value

String

Parameter value in the source parameter template.

target_value

String

Parameter value in the destination parameter template.

Example Requests

  • URI example
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/comparison 
  • Comparing a source parameter template with the target parameter template
    { 
      "source_configuration_id" : "0764fdcd949b411ba76c2b762b80c212pr06", 
      "target_configuration_id" : "fa42c57bb62844e490052f2ff9d5a264pr06" 
    }

Example Responses

Status code: 202

Accepted

{ 
  "differences" : [ { 
    "parameter_name" : "batch_size_fail_threshold_in_kb", 
    "source_value" : "1000", 
    "target_value" : "5000" 
  } ] 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.