Feature description
The interface used to obtain the tenant parameter list.
Call instructions
Interface constraints
The caller needs to authenticate through the OCP application service.
Request path
GET /api/v2/ob/clusters/{id}/tenants/{tenantId}/parameters
Request parameters
path:
Parameter |
Type |
Required |
Example Value |
Description |
|---|---|---|---|---|
| id | Integer | Yes | 100 | The cluster ID in OCP for the target tenant. |
| tenantId | Integer | Yes | 21 | The tenant ID in OCP for the target tenant. |
Return result
Basic data structure
Parameter |
Type |
Description |
|---|---|---|
| data | Array | The tenant parameter list. For more information, see TenantParameter data structure. |
| successful | Boolean | Indicates whether the request was successful. |
| timestamp | Datetime | The timestamp when the server completed the request. |
| duration | Integer | The time taken by the server to process the request in milliseconds. |
| status | Integer | The HTTP status code that conforms to the HTTP status specification. |
| traceId | String | The Trace ID of the request, which is used to troubleshoot issues. |
| server | String | The address of the application service that responded to the request. |
TenantParameter data structure
Parameter |
Type |
Description |
|---|---|---|
| name | String | The parameter name. |
| compatibleType | String | The compatible type. Valid values: |
| readonly | Boolean | Indicates whether the parameter is read-only. |
| defaultValue | String | The default value. |
| currentValue | String | The current value. |
| description | String | The parameter description. |
| valueRange | Object | For more information, see ValueRange data structure. |
ValueRange data structure
Parameter |
Type |
Description |
|---|---|---|
| type | String | The parameter type. |
| allowedValues | String | The list of allowed values. |
| maxValue | String | The maximum value of the parameter. |
| minValue | String | The minimum value of the parameter. |
Example
Request example
GET /api/v2/ob/clusters/100/tenants/21/parameters
Response example
{
"data": {
"contents": [
{
"currentValue": "ON",
"defaultValue": "ON",
"description": "Specifies whether to enable auto-commit.",
"name": "autocommit",
"readonly": false,
"valueRange": {
"allowedValues": "OFF,ON",
"type": "ENUM"
}
},
{
"currentValue": "ON",
"defaultValue": "ON",
"description": "Specifies whether to allow aggregation pushdown.",
"name": "ob_enable_aggregation_pushdown",
"readonly": false,
"valueRange": {
"allowedValues": "OFF,ON",
"type": "ENUM"
}
}
]
},
"duration": 219,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-06T01:49:16.946+08:00",
"traceId": "00a58024130d474b"
}