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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition 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. Constraints N/A Range N/A Default Value N/A |
Content-Type |
Yes |
String |
Definition Content type. Constraints N/A Range application/json Default Value N/A |
X-Language |
No |
String |
Definition Request language type. Constraints N/A Range
Default Value en-us |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
source_configuration_id |
Yes |
String |
Definition ID of the source parameter template for comparison. To obtain this value, see Querying a StarRocks Instance. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
differences |
Array of ParamGroupParameterDifferences objects |
Definition Differences between parameters in the source and target parameter templates. Range N/A |
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot