All Products
Search
Document Center

ApsaraDB for OceanBase:DescribeParameters

Last Updated:Dec 02, 2024

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
oceanbase:DescribeParametersget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

498529

ob317v4uif****
DimensionstringYes

It is an online CLI tool that allows you to quickly retrieve and debug APIs. It can dynamically generate executable SDK code samples.

TENANT
DimensionValuestringNo

Alibaba Cloud CLI

ob2mr3oae0****

Response parameters

ParameterTypeDescriptionExample
object

The default value of the parameter.

RequestIdstring

The return result of the request.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Parametersarray<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.
Dataobject

The resource ID of the parameter type.
You can leave this parameter unspecified when you call this operation to query cluster parameters. In the case of tenant parameters, pass the tenant ID.

Descriptionstring

The description of the parameter.

The operation that you want to perform. Set the value to **DescribeParameters**.
ValueTypestring

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
CurrentValuestring

The ID of the OceanBase cluster.

600
NeedRebootboolean

The name of the parameter.

false
Namestring

The request ID.

connect_timeout
DefaultValuestring
http(s)://[Endpoint]/?Action=DescribeParameters
&InstanceId=ob317v4uif****
&Dimension=TENANT
&DimensionValue=ob2mr3oae0****
&Common request parameters
600s
RejectedValuearray

{ "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" ] } ] }

RejectedValueElementstring
EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C The maximum delay allowed in weak-consistency reads. CAPACITY 600 false connect_timeout 600s 1s 1s
1s
AcceptableValuearray

DescribeParameters

AcceptableValueElementstring

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 codeError codeError message
500InternalErrorThe request processing has failed due to some unknown error.

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

Change history

Change timeSummary of changesOperation
2023-08-21The Error code has changed. The response structure of the API has changedView Change Details
2023-05-17The Error code has changed. The response structure of the API has changedView Change Details