DescribeParameters - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the information of cluster or tenant parameters.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	498529	ob317v4uif****
Dimension	string	Yes	It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples.	TENANT
DimensionValue	string	No	Alibaba Cloud CLI	ob2mr3oae0****

Response parameters

Parameter	Type	Description	Example
	object	The default value of the parameter.
RequestId	string	The return result of the request.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Parameters	object []	Indicates whether a restart is required for changes to the parameter to take effect. Valid values: true: A restart is required. false: A restart is not required.
Description	string	The description of the parameter.	The operation that you want to perform. Set the value to DescribeParameters.
ValueType	string	The invalid value range of the parameter. It is an array with two string elements, which represents a range. The first element represents the minimum value and the second element represents the maximum value.	CAPACITY
CurrentValue	string	The ID of the OceanBase cluster.	600
NeedReboot	boolean	The name of the parameter.	false
Name	string	The request ID.	connect_timeout
DefaultValue	string	`http(s)://[Endpoint]/?Action=DescribeParameters &InstanceId=ob317v4uif** &Dimension=TENANT &DimensionValue=ob2mr3oae0** &Common request parameters`	600s
RejectedValue	array	{ "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C", "Parameters": [ { "Description": "The maximum delay allowed in weak-consistency reads.", "ValueType": "CAPACITY", "CurrentValue": "600", "NeedReboot": false, "Name": "connect_timeout", "DefaultValue": "600s", "RejectedValue": [ "1s" ], "AcceptableValue": [ "1s" ] } ] }
	string	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C The maximum delay allowed in weak-consistency reads. CAPACITY 600 false connect_timeout 600s 1s 1s	1s
AcceptableValue	array	DescribeParameters
	string	ob317v4uif****	1s

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Parameters": [
    {
      "Description": "The operation that you want to perform.   \nSet the value to **DescribeParameters**. ",
      "ValueType": "CAPACITY",
      "CurrentValue": "600",
      "NeedReboot": false,
      "Name": "connect_timeout",
      "DefaultValue": "600s",
      "RejectedValue": [
        "1s"
      ],
      "AcceptableValue": [
        "1s"
      ],
      "Readonly": true
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
500	InternalError	The request processing has failed due to some unknown error.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-08-21

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.

2023-05-17

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.