Use DescribeParameters to query cluster and tenant parameters - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud - ApsaraDB for OceanBase (Deprecated)

Queries the list of parameter information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oceanbase:DescribeParameters

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
Dimension	string	Yes	The parameter type. Valid values: CLUSTER and TENANT.	TENANT
DimensionValue	string	No	The resource identifier of the parameter type. You can leave this parameter empty for cluster parameters. For tenant parameters, specify the TenantId of the tenant.	ob2mr3oae0****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Parameters	array<object>	The parameter list.
	object	The response parameters.
Description	string	The description of the parameter.	弱读允许的最大时间延迟时间
ValueType	string	The value type of the parameter. Valid values: ENUM: numeric enumeration. RANGE: numeric range. TIME: time. STRING: string. ENUM_MULTIPLE: numeric enumeration with multiple selections. CAPACITY: storage capacity value (K, M, G).	CAPACITY
CurrentValue	string	The current value of the parameter.	600
NeedReboot	boolean	Indicates whether a restart is required after modifying this parameter. Valid values: true: A restart is required. false: A restart is not required.	false
Name	string	The parameter name.	connect_timeout
DefaultValue	string	The default value of the parameter.	600s
RejectedValue	array	The rejected value range of the parameter. The format is an array with two string elements that represent a range. The first element is the minimum value, and the second element is the maximum value.
	string	The rejected value range of the parameter.	1s
AcceptableValue	array	The acceptable value range of the parameter.
	string	The acceptable value range of the parameter.	2s
Readonly	boolean	Indicates whether the parameter is read-only.	false
Unit	string	The unit of the current parameter value.	s

Examples

Success response

JSON format

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Parameters": [
    {
      "Description": "弱读允许的最大时间延迟时间",
      "ValueType": "CAPACITY",
      "CurrentValue": "600",
      "NeedReboot": false,
      "Name": "connect_timeout",
      "DefaultValue": "600s",
      "RejectedValue": [
        "1s"
      ],
      "AcceptableValue": [
        "2s"
      ],
      "Readonly": false,
      "Unit": "s"
    }
  ]
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.