• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. API v1
  5. Parameter Configuration
  6. Restoring Parameters to Their Default Values

Restoring Parameters to Their Default Values

Function

This API is used to restore a DB instance's parameter group to the default parameter group.

URI

  • URI format

    PATH: /rds/{versionId}/{project_id}/instances/{instanceId}/parameters/default

    Method: PUT

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    versionId

    Yes

    Specifies the API version. It is case-sensitive and the value is v1.

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    instanceId

    Yes

    Specifies the ID of the queried DB instance.

  • Restrictions

    If a parameter of the primary DB instance is restored to the default value, the corresponding parameter of the standby DB instance is restored to the default setting simultaneously. You cannot restore the parameters of the standby DB instance to their default values. You can restore the parameters of read replicas to their default values.

Request

{}

Normal Response

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Description

    shouldRestart

    String

    Indicates whether the parameter needs to be restarted for the modifications to take effect.

    • The value 1 indicates that the parameter needs to be restarted for the modifications to take effect.
    • The value 0 indicates that the parameter does not need to be restarted for the modifications to take effect

    setParameteResult

    String

    Indicates the parameter modification result.

    • The value 1 indicates that the modifications are successful on the primary DB instance but failed on the standby DB instance.
    • 0 indicates that the modifications are successful on every DB instance.
  • Response example
    { 
         "shouldRestart": "1",
         "setParameteResult": "0"
    }

Abnormal Response

For details, see Abnormal Request Results.