DescribeParameters - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the parameter settings of an instance.

Operation Description

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

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
rds:DescribeParameters	READ	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCzxxxxx
DBInstanceId	string	Yes	The ID of the instance.	rm-uf6wjk5xxxxxxx

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Engine	string	The type of the database engine.	MySQL
EngineVersion	string	The database engine version of the instance.	5.5
ConfigParameters	object []	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.
ParameterDescription	string	The description of the parameter.	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	string	The name of the parameter.	fill factor
ParameterValue	string	The value of the parameter.	50
RunningParameters	object []	The list of parameters that are in use.
ParameterDescription	string	The description of the parameter.	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	string	The name of the parameter.	fill factor
ParameterValue	string	The value of the parameter.	0

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Engine": "MySQL",
  "EngineVersion": "5.5",
  "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.\n",
        "ParameterName": "fill factor",
        "ParameterValue": "50"
      }
    ]
  },
  "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.\n",
        "ParameterName": "fill factor",
        "ParameterValue": "0"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	The RDS instance cannot be found, is deleted, or does not support the operation.

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

Change history

Change time

Summary of changes

Operation

2023-05-23

The error codes of the API operation change.,The response structure of the API operation changes.

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 404
Output Parameters	The response structure of the API operation changes.

2023-03-01

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Added Error Codes: 404