Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Parameter Management/ Resetting a Custom Parameter Template
Updated on 2025-12-09 GMT+08:00
View PDF
Share

Resetting a Custom Parameter Template

Function

This API is used to reset a custom parameter template.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:param:reset

write

-

-

-

-

URI

  • URI format

    PUT /v3/{project_id}/configurations/{config_id}/reset

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    The value cannot be empty.

    Range

    N/A

    Default Value

    N/A

    config_id

    Yes

    String

    Definition

    Parameter template ID.

    Constraints

    The value can only be the ID of a custom parameter template.

    Range

    N/A

    Default Value

    N/A

Request

None

Example Request

Reset a custom parameter template.

PUT https://{Endpoint}/v3/54623db08b174c858ba779d2aa7923a3/configurations/3bc1e9cc0d34404b9225ed7a58fb284epr01/reset

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    config_name

    String

    Definition

    Parameter template name.

    Range

    N/A

    need_restart

    Boolean

    Definition

    Whether a reboot is required.

    Range

    This field is not used currently. The default value is false.
  • Example normal response 
    {
  "config_name": "paramTemplate-4a66",
  "need_restart": false
}
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.

Parent topic: Parameter Management