View the list of currently running instance database parameters

Last Updated: Sep 19, 2017

Description

This interface returns an instance’s current parameter configuration to the user.

Request parameters

Name Type Required? Description
Action String Yes Required parameter. Value: DescribeParameters.
DBInstanceId String Yes Instance ID.

Return parameters

Name Type Description
<Public Return Parameters> None For details, see Public parameters.
Engine String Database type.
EngineVersion String Database version.
RunningParameters List<DBInstanceParameter> A list of currently running parameters, in the format of {parameter1,parameter2,parameter3, …}.
ConfigParameters List<DBInstanceParameter> A list of parameters being synchronized, in the format of {parameter1,parameter2,parameter3,…}.

DBInstance parameters

Name Type Description
ParameterName String Parameter name.
ParameterValue String Parameter value.
ParameterDescription String Parameter description.

Example

  • Request example

    1. https://rds.aliyuncs.com/?Action=DescribeParameters
    2. &DBInstanceId=riauvjz6zajfiq6ba1370329449201
    3. &<Public Request Parameters>
  • Return example

    XML format:

    1. < DescribeParametersResponse>
    2. <RequestId>2A748162-8040-4D6B-813E-6910C8C033F1</RequestId>
    3. <Engine>mssql</ Engine >
    4. <EngineVersion>2008r2</ EngineVersion >
    5. <RunningParameters>
    6. <DBInstanceParameter>
    7. <ParameterDescription>This option sets the default fill factor value for the server range.A fill factor is provided to optimize index data storage and performance</ParameterDescription>
    8. <ParameterName>fill factor</ParameterName>
    9. <ParameterValue>0</ParameterValue>
    10. </DBInstanceParameter>
    11. </RunningParameters>
    12. <ConfigParameters>
    13. <DBInstanceParameter>
    14. <ParameterDescription>This option sets the default fill factor value for the server range.A fill factor is provided to optimize index data storage and performance</ParameterDescription>
    15. <ParameterName>fill factor</ParameterName>
    16. <ParameterValue>50</ParameterValue>
    17. </DBInstanceParameter>
    18. </ConfigParameters>
    19. </DescribeParametersResponse>

    JSON format:

    1. {
    2. "ConfigParameters": {
    3. "DBInstanceParameter": [
    4. {
    5. "ParameterDescription": "This option sets the default fill factor value for the server range.A fill factor is provided to optimize index data storage and performance.",
    6. "ParameterName": "fill factor",
    7. "ParameterValue": "50"
    8. }
    9. ]
    10. },
    11. "Engine": "mssql",
    12. "EngineVersion": "2008r2",
    13. "RunningParameters": {
    14. "DBInstanceParameter": [
    15. {
    16. "ParameterDescription": "This option sets the default fill factor value for the server range.A fill factor is provided to optimize index data storage and performance.",
    17. "ParameterName": "fill factor",
    18. "ParameterValue": "0"
    19. }
    20. ]
    21. },
    22. "RequestId": "2A748162-8040-4D6B-813E-6910C8C033F1"
    23. }
Thank you! We've received your feedback.