Query arbitration service parameters|V4.3.5| docs|Distributed Database

Query arbitration service parameters

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

Description

You can call this operation to query arbitration service parameters.

Call description

Prerequisites

You have the read-only permission on the arbitration service.

Request path

GET /api/v2/arbitration/services/parameterInfos

Request parameters

path:

Parameter	Type	Required	Example value	Description
name	String	No	foo	The name of the parameter.
version	String	No	4.2.0.0	The version of the OceanBase cluster.

Response parameters

Basic data structure

Parameter	Type	Description
data	Object	For more information, see the Information of an arbitration service parameter section in this topic.
successful	Boolean	Indicates whether the request was successful.
timestamp	Datetime	The timestamp when the server completed the request.
duration	Integer	The amount of time taken by the server to process the request, in milliseconds.
status	Integer	The 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.

Information about an arbitration service parameter

Parameter	Type	Description
id	Long	The ID of the parameter metadata.
name	String	The name of the parameter.
version	String	The version of the OceanBase cluster.
valueRange	Object	For more information, see the Value range section in this topic.
defaultValue	String	The default value.
recommendValue	String	The recommended value.
description	String	The description of the parameter.
needRestart	Boolean	Indicates whether the modification takes effect after a restart.
readonly	Boolean	Indicates whether the parameter is read-only.

Value range

Parameter	Type	Description
type	String	The type of the value range.
allowedValues	String	The allowed value range. This parameter takes effect if type is set to `ENUM`. Multiple values are separated with commas (,), for example, `TRUE,FALSE`.
maxValue	String	The maximum value.
minValue	String	The minimum value.

Examples

Sample request

GET /api/v2/arbitration/services/parameterInfos

Sample response

{
    "data": {
        "contents": [
            {
                "defaultValue": "0",
                "description": "The total number of CPU cores occupied by the arbitration service. If you set the parameter to 0, the system will automatically detect the number of CPU cores.",
                "id": 1,
                "name": "cpu_count",
                "needRestart": true,
                "readonly": false,
                "valueRange": {
                    "minValue": "0",
                    "type": "INT"
                },
                "version": "4.1.0"
            }
        ]
    },
    "duration": 7,
    "server": "6d952bd732",
    "status": 200,
    "successful": true,
    "timestamp": "2025-01-22T16:05:13.669+08:00",
    "traceId": "1de3e07877972022"
}