DescribeParametersHistory - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the modification history 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
oceanbase:DescribeParametersHistory	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
Dimension	string	Yes	The type of the parameter. Valid values: CLUSTER and TENANT.	TENANT
DimensionValue	string	No	The resource ID of the parameter type. You can leave this parameter unspecified when you call this operation to query the modification history of cluster parameters. In the case of tenant parameters, pass the tenant ID.	ob2mr3oae0****
StartTime	string	Yes	The start time of the time range for querying the parameter modification history.	2021-06-13 15:40:43
EndTime	string	Yes	The end time for the query of parameter modification history.	2021-09-13 15:40:43
PageSize	integer	Yes	The number of rows to return on each page. Maximum value: 100 Default value: 10	10
PageNumber	integer	Yes	The number of the page to return. Start value: 1 Default value: 1	1

Response parameters

Parameter	Type	Description	Example
	object	The return result of the request.
RequestId	string	The request ID.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Respond	array<object>	The list of parameter modification records.
Data	object	The return result of the request.
TotalCount	integer	The number of parameter modification records.	2
PageNumber	integer	The number of returned entries on each page.	Default value: 10.
Parameters	array<object>	The parameter modification history.
Parameters	object	The return result of the request.
Status	string	The modification status. Valid values: APPLIED: The modification was successful. SCHEDULING: The modification was to be made.	APPLIED
OldValue	string	The parameter value before modification.	300
UpdateTime	string	The time when the parameter modification took effect.	2021-09-14 10:57:44
CreateTime	string	The time when the parameter modification was initiated.	2021-09-14 10:57:44
DimensionValue	string	The resource ID of the parameter type. When you called this operation to query the modification history of cluster parameters, the value is DEFAULT_DIMENSION_VALUE. When you called this operation to query the modification history of tenant parameters, the value is the tenant ID.	DEFAULT_DIMENSION_VALUE
Name	string	The name of the parameter.	connect_timeout
NewValue	string	The value of the parameter after the modification.	200

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "Respond": [
    {
      "TotalCount": 2,
      "PageNumber": 0,
      "Parameters": [
        {
          "Status": "APPLIED",
          "OldValue": "300",
          "UpdateTime": "2021-09-14 10:57:44",
          "CreateTime": "2021-09-14 10:57:44",
          "DimensionValue": "DEFAULT_DIMENSION_VALUE",
          "Name": "connect_timeout",
          "NewValue": "200"
        }
      ]
    }
  ]
}

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
2024-10-29	The Error code has changed. The response structure of the API has changed	View Change Details