This topic describes how to query the parameters of a specified tenant by using an API.
API details
Authentication is required if a password is set. For more information, see API hybrid encryption.
Request path
GET /api/v1/tenant/:name/parameter/:parameter
Response parameters
Parameter |
Type |
Description |
|---|---|---|
| successful | bool | Whether the request was successful. |
| timestamp | time.Time | The timestamp when the server completed the request. |
| duration | int | The time taken by the server to process the request, in milliseconds. |
| status | int | An encoding that complies with the HTTP Status specification. |
| traceId | string | The trace ID of the request. |
| data | GvObParameter | The returned parameter information. For details, see Data structure of GvObParameter below. |
| error | ApiError | The error generated by the request contains the following information:
|
The data structure of GvObParameter:
Parameter |
Type |
Description |
|---|---|---|
| name | string | Parameter name. |
| value | string | The value of the parameter. |
| data_type | string | The data type of the parameter. |
| info | string | Parameter information. |
| edit_level | string | The modification level of the parameter. |
Examples
Request example
GET 10.10.10.1:2886/api/v1/tenant/t1/parameter/max_partition_num
Response example
{
"successful": true,
"timestamp": "2024-10-14T15:19:46.214458368+08:00",
"duration": 25,
"status": 200,
"traceId": "7fed9977fe59a58f",
"data": {
"name": "max_partition_num",
"value": "8192",
"data_type": "",
"info": "set max partition num in mysql mode",
"edit_level": "DYNAMIC_EFFECTIVE"
}
}
References
You can call the API not only from the command line but also by using SDK methods.
For information about how to request the API using obshell-sdk-python, see Query parameters of a specified tenant in Query tenant parameters.
For information about how to request the API using obshell-sdk-go, see Query parameters of a specified tenant in Query tenant parameters.