Queries parameters that you configure for an instance or a database.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDrdsParams

The operation that you want to perform. Set the value to DescribeDrdsParams.

DrdsInstanceId String Yes DescribeDrdsParams

The ID of the PolarDB-X 1.0 instance.

ParamLevel String Yes INSTANCE

The type of nodes whose parameters you want to query. Valid values:

  • INSTANCE: the instance level.
  • DB: the database level.
RegionId String No cn-hangzhou

The ID of the region where the PolarDB-X 1.0 instance is created.

DbName String No drds_test

The name of the database.

Response parameters

Parameter Type Example Description
List Array of List

Indicates information about parameters.

DbName String drds_test

Indicates the name of the database.

NeedRestart Boolean true

Indicates whether a restart is required.

ParamDefaultValue String 1000

Indicates the default value of a parameter.

ParamDesc String The threshold value for slow SQL queries (unit: ms)

Indicates the description of the parameter.

ParamEnglishName String SLOW_SQL_TIME

Indicates the name of the parameter.

ParamLevel String INSTANCE

Indicates the parameter level.

ParamName String SLOW_SQL_TIME

Indicates the name of the parameter.

ParamRanges String [1000-900000]

Indicates the value range of the parameter.

ParamType String CONFIG

Indicates the type of the parameter.

ParamValue String 1000

Indicates the value of the parameter.

ParamVariableName String slowSqlTime

Indicates the name of the variable.

RequestId String 2F7F8080-9132-4279-85D0-B7E5C4305162

Indicates the ID of the request.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://drds.cn-hangzhou.aliyuncs.com/?Action=DescribeDrdsParams
&DrdsInstanceId=DescribeDrdsParams
&ParamLevel=INSTANCE
&<Common request parameters>

Sample success responses

XML format 

<DescribeDrdsParamsReponse>
  <RequestId>2F7F8080-9132-4279-85D0-B7E5C4305162</RequestId>
  <List>
        <ParamRanges>[1000-900000]</ParamRanges>
        <ParamLevel>INSTANCE</ParamLevel>
        <ParamVariableName>slowSqlTime</ParamVariableName>
        <ParamEnglishName>SLOW_SQL_TIME</ParamEnglishName>
        <ParamValue>1000</ParamValue>
        <ParamDefaultValue>1000</ParamDefaultValue>
        <NeedRestart>true</NeedRestart>
        <DbName>drds_test</DbName>
        <ParamName>SLOW_SQL_TIME</ParamName>
        <ParamType>CONFIG</ParamType>
        <ParamDesc>The threshold value for slow SQL queries (unit: ms)</ParamDesc>
  </List>
  <Success>true</Success>
</DescribeDrdsParamsReponse>

JSON format 

{"RequestId":"2F7F8080-9132-4279-85D0-B7E5C4305162","List":[{"ParamRanges":"[1000-900000]","ParamLevel":"INSTANCE","ParamVariableName":"slowSqlTime","ParamEnglishName":"SLOW_SQL_TIME","ParamValue":"1000","ParamDefaultValue":"1000","NeedRestart":"true","DbName":"drds_test","ParamName":"SLOW_SQL_TIME","ParamType":"CONFIG","ParamDesc":"The threshold value for slow SQL queries (unit: ms)"}],"Success":"true"}

Error codes

HttpCode Error code Error message Description
500 InternalError The request processing has failed due to some unknown error. The error message returned because an internal error has occurred.

For a list of error codes, visit the API Error Center.