DescribeParameters - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the parameter settings of an instance.

Operation description

Applicable engines

MySQL
PostgreSQL
SQL Server
MariaDB

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
rds:DescribeParameters	READ	DBInstance 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 instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-uf6wjk5xxxxxxx

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Engine	string	The type of the database engine.	MySQL
EngineVersion	string	The version of the database engine.	5.5
ParamGroupInfo	object	The information about the parameter template.
ParameterGroupName	string	The name of the parameter template.	mysql_innodb_8.0_basic_normal_high
ParameterGroupDesc	string	The description of the parameter template.	sync_binlog=1000, innodb_flush_log_at_trx_commit=2, async
ParameterGroupType	string	The type of the parameter template.	0
ParamGroupId	string	The ID of the parameter template.	rpg-sys-01040401010200
ConfigParameters	object []	The list of parameters that are being synchronized. Note After you modify and submit the parameters, you must wait for the parameters 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",
  "ParamGroupInfo": {
    "ParameterGroupName": "mysql_innodb_8.0_basic_normal_high",
    "ParameterGroupDesc": "sync_binlog=1000, innodb_flush_log_at_trx_commit=2, async",
    "ParameterGroupType": "0",
    "ParamGroupId": "rpg-sys-01040401010200"
  },
  "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 code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 404
Output Parameters	The response structure of the API has changed.

2023-03-01

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Added Error Codes: 404