DescribeDrdsParams - PolarDB - Alibaba Cloud Documentation Center

Invokes the DescribeDrdsParams operation to query the query parameter list.

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

drds:DescribeDrdsParams

get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
DrdsInstanceId	string	Yes	The instance ID.	DescribeDrdsParams
ParamLevel	string	Yes	The parameter level. Valid values: INSTANCE: instance level DB: database level.	INSTANCE
DbName	string	No	The database name.	drds_test

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the query was successful.	true
RequestId	string	The request ID.	2F7F8080-9132-4279-85D0-B7E5C4305162
List	array<object>	The parameter list.
	object
ParamDefaultValue	string	The default value of the parameter.	1000
ParamLevel	string	The parameter level.	INSTANCE
ParamName	string	The parameter name.	慢SQL阈值
ParamType	string	The parameter type.	CONFIG
ParamValue	string	The parameter value.	1000
NeedRestart	boolean	Indicates whether a restart is required.	true
ParamRanges	string	The valid value range of the parameter.	[1000-900000]
DbName	string	The database name.	drds_test
ParamEnglishName	string	The English name of the parameter.	SLOW_SQL_TIME
ParamDesc	string	The parameter description.	慢SQL阈值（单位：ms）
ParamVariableName	string	The variable name of the parameter.	slowSqlTime

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "2F7F8080-9132-4279-85D0-B7E5C4305162",
  "List": [
    {
      "ParamDefaultValue": "1000",
      "ParamLevel": "INSTANCE",
      "ParamName": "慢SQL阈值",
      "ParamType": "CONFIG",
      "ParamValue": "1000",
      "NeedRestart": true,
      "ParamRanges": "[1000-900000]",
      "DbName": "drds_test",
      "ParamEnglishName": "SLOW_SQL_TIME",
      "ParamDesc": "慢SQL阈值（单位：ms）",
      "ParamVariableName": "slowSqlTime"
    }
  ]
}

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.