Help Center/ Huawei Cloud Flexus_Huawei Cloud Flexus RDS/ API Reference/ API v3/ Parameter Management/ Modifying Parameters of a Specified DB Instance
Updated on 2024-09-04 GMT+08:00
View PDF
Share

Modifying Parameters of a Specified DB Instance

Function

This API is used to modify parameters in the parameter template of a specified DB instance.

URI

  • URI format

    PUT /v3/{project_id}/instances/{instance_id}/configurations

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Explanation:

    Project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    Constraints:

    N/A

    Value range:

    N/A

    Default value:

    N/A

    instance_id

    Yes

    String

    Explanation:

    Instance ID.

    Constraints:

    N/A

    Value range:

    N/A

    Default value:

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

values

Yes

Map<String,String>

Explanation:

Parameter values defined by users based on a default parameter template.

Constraints:

N/A

Value range:

  • key: parameter name, for example, div_precision_increment or connect_timeout. If this parameter is not specified, no parameter value is to be changed.
  • value: parameter value, for example, 6 or 20. If key is not empty, the parameter value cannot be empty, either.

Default value:

N/A

Example Request

Modify parameters of a specified instance. 
https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations
{
  "values" : { 
    "max_connections" : "10", 
    "autocommit" : "OFF",
    "binlog_checksum" : "CRC32",
    "innodb_purge_threads" : "4"
  } 
}

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    job_id

    String

    Explanation:

    Task ID.

    Value range:

    N/A

    restart_required

    Boolean

    Explanation:

    Whether a reboot is required.

    Value range:

    • true: A reboot is required.
    • false: A reboot is not required.

    ignored_params

    List

    Explanation:

    All parameters that are ignored and fail to be modified in the request parameter values.

    If a parameter does not exist, the modification will fail. The names of all ignored parameters are returned by ignored_params.

    Value range:

    N/A
  • Example normal response 
    { 
  "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94",
  "restart_required" : "false",
  "ignored_params": []
}
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Parent topic: Parameter Management