All Products
Search
Document Center

ApsaraDB RDS:DescribeParameters

Last Updated:Feb 29, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:DescribeParametersREAD
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

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
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-uf6wjk5xxxxxxx

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
Enginestring

The type of the database engine.

MySQL
EngineVersionstring

The version of the database engine.

5.5
ParamGroupInfoobject

The information about the parameter template.

ParameterGroupNamestring

The name of the parameter template.

mysql_innodb_8.0_basic_normal_high
ParameterGroupDescstring

The description of the parameter template.

sync_binlog=1000, innodb_flush_log_at_trx_commit=2, async
ParameterGroupTypestring

The type of the parameter template.

0
ParamGroupIdstring

The ID of the parameter template.

rpg-sys-01040401010200
ConfigParametersobject []

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.
ParameterDescriptionstring

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.
ParameterNamestring

The name of the parameter.

fill factor
ParameterValuestring

The value of the parameter.

50
RunningParametersobject []

The list of parameters that are in use.

ParameterDescriptionstring

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.
ParameterNamestring

The name of the parameter.

fill factor
ParameterValuestring

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 codeError codeError messageDescription
404InvalidDBInstance.NotFoundSpecified 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 timeSummary of changesOperation
2023-05-23The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.
2023-03-01The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 404