Query parameters of a tenant

Last Updated：2025-03-26 07:47:21 Updated

Description

You can call this operation to query parameters of a tenant.

Call description

Prerequisite

You have passed the authentication for the OCP application service.

Request path

GET /api/v2/ob/clusters/{id}/tenants/{tenantId}/parameters

Path parameters

Parameter	Type	Required	Example value	Description
id	Integer	Yes	100	The ID of the OceanBase cluster to which the tenant belongs.
tenantId	Integer	Yes	200	The ID of the tenant.

Response parameters

Basic data structure

Parameter	Type	Description
data	Array	The TenantParameter array.
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	An HTTP status code.
traceId	String	The trace ID of the request. This trace ID is used for troubleshooting.
server	String	The address of the application server that responded to the request.

Data structure of TenantParameter

Parameter	Type	Description
name	String	The name of the parameter.
compatibleType	String	The compatibility mode. Valid values: * ORACLE * MYSQL
readonly	Boolean	Indicates whether the parameter was read-only.
defaultValue	String	The default value.
currentValue	String	The current value.
description	String	The description of the parameter.
valueRange	Object	The data structure of valueRange.

Data structure of valueRange

Parameter	Type	Description
type	String	The type of the parameter.
allowedValues	String	The allowed values of the parameter.
maxValue	String	The maximum value of the parameter.
minValue	String	The minimum value of the parameter.

Examples

Sample request

GET /api/v2/ob/clusters/100/tenants/21/parameters

Sample response

{
    "data": {
        "contents": [
            {
                "currentValue": "ON",
                "defaultValue": "ON",
                "description": "Indicates whether automatic commit was enabled.",
                "name": "autocommit",
                "readonly": false,
                "valueRange": {
                    "allowedValues": "OFF,ON",
                    "type": "ENUM"
                }
            },
            ......
            ......
            ......
            {
                "currentValue": "ON",
                "defaultValue": "ON",
                "description": "Indicates whether aggregation operations were allowed to be pushed down.",
                "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"
}