You can call the DescribeParameters operation to query the parameter settings of an instance.

Before you call this operation, make sure that the instance runs one of the following database engines:

  • MySQL 5.5, MySQL 5.6, MySQL 5.7, or MySQL 8.0
  • SQL Server 2008 R2
  • PostgreSQL 10, PostgreSQL 11, PostgreSQL 12, PostgreSQL 13, PostgreSQL 14, or PostgreSQL 15
  • MariaDB 10.3

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 DescribeParameters

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

ClientToken String No ETnLKlblzczshOTUbOCzxxxxx

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the generated token is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the instance.

Response parameters

Parameter Type Example Description
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

Engine String MySQL

The database engine that the instance runs.

EngineVersion String 5.5

The database engine version of the instance.

ConfigParameters Array of DBInstanceParameter

The list of parameters that are being synchronized. After you modify and submit the parameter settings, you must wait for the parameter modifications to be synchronized to the instance. After the synchronization, you can delete the parameters from the list.

DBInstanceParameter
ParameterDescription String This parameter sets the default fill factor value at the server scope. A fill factor is provided to optimize index data storage and performance.

The description of the parameter.

ParameterName String fill factor

The name of the parameter.

ParameterValue String 50

The value of the parameter.

RunningParameters Array of DBInstanceParameter

The list of parameters that are in use.

DBInstanceParameter
ParameterDescription String This parameter sets the default fill factor value at the server scope. A fill factor is provided to optimize index data storage and performance.

The description of the parameter.

ParameterName String fill factor

The name of the parameter.

ParameterValue String 0

The value of the parameter.

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=DescribeParameters
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeParametersResponse>
	<ConfigParameters>
		<DBInstanceParameter>
			<ParameterDescription> This parameter sets the default fill factor value at the server scope. A fill factor is provided to optimize index data storage and performance. </ParameterDescription>
			<ParameterName>fill factor</ParameterName>
			<ParameterValue>50</ParameterValue>
		</DBInstanceParameter>
	</ConfigParameters>
	<Engine>mssql</Engine>
	<EngineVersion>2008r2</EngineVersion>
	<RunningParameters>
		<DBInstanceParameter>
			<ParameterDescription> This parameter sets the default fill factor value at the server scope. A fill factor is provided to optimize index data storage and performance. </ParameterDescription>
			<ParameterName>fill factor</ParameterName>
			<ParameterValue>0</ParameterValue>
		</DBInstanceParameter>
	</RunningParameters>
	<RequestId>2A748162-8040-4D6B-813E-6910C8C033F1</RequestId>
</DescribeParametersResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ConfigParameters" : {
    "DBInstanceParameter" : [ {
      "ParameterDescription": "This parameter sets the default fill factor value at the server scope. A fill factor is provided to optimize index data storage and performance.",
      "ParameterName" : "fill factor",
      "ParameterValue" : "50"
    } ]
  },
  "Engine" : "mssql",
  "EngineVersion" : "2008r2",
  "RunningParameters" : {
    "DBInstanceParameter" : [ {
      "ParameterDescription": "This parameter sets the default fill factor value at the server scope. A fill factor is provided to optimize index data storage and performance.",
      "ParameterName" : "fill factor",
      "ParameterValue" : "0"
    } ]
  },
  "RequestId" : "2A748162-8040-4D6B-813E-6910C8C033F1"
}

Error codes

For a list of error codes, see Service error codes.