Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Comparing Parameters

Updated on 2025-02-26 GMT+08:00

Online Debugging

CLI Examples

View PDF

Comparing Parameters

Function

This API is used to compare instance parameters with those in the default template. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

POST /v3/{project_id}/configurations/starrocks/comparison

**Table 1** URI parameter
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. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Values: en-us zh-cn
Content-Type	Yes	String	Content type. Value: application/json

**Table 3** Request body parameter
Parameter	Mandatory	Type	Description
source_configuration_id	Yes	String	ID of the source parameter template for comparison. To obtain this value, see Querying a StarRocks Instance.

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
differences	Array of ParamGroupParameterDifferences objects	Differences between parameters in the source and target parameter templates.

**Table 5** ParamGroupParameterDifferences
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 target parameter template.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/comparison

{
  "source_configuration_id" : "a2069d40256f40078c52d90d6a91ee63pr17",
}

Example Response

Status code: 200

Differences between parameters.

{
  "differences" : [ {
    "parameter_name" : "alter_tablet_worker_count",
    "source_value" : "4",
    "target_value" : "3"
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: HTAP (Standard Edition)

Previous topic: Enabling Assign Requests to Row and Column Store Nodes for a StarRocks Instance

Next topic: Upgrading the Kernel Version of a StarRocks Instance

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot