distributed-cache-service/api-ref/source/parameter_management_apis/modifying_configuration_parameters.rst
proposalbot 3a9c34d473 Changes to dcs_api-ref from docs/doc-exports#490 (DMS API-REF Initial Version
I

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2022-12-09 15:00:55 +00:00

3.2 KiB

original_name

dcs-api-0312017.html

Modifying Configuration Parameters

Function

You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.

URI

PUT /v1.0/{project_id}/instances/{instance_id}/configs

Table 1 <dcs-api-0312017__table139152015133712> describes the parameters.

Table 1 Parameter description
Parameter Type Mandatory Description
project_id String Yes Project ID.
instance_id String Yes ID of the instance to be modified.

Request

Request parameters

Table 2 <dcs-api-0312017__table16620132063713> describes the request parameters.

Table 2 Parameter description
Parameter Type Mandatory Description
redis_config Array Yes Array of configuration items of the DCS instance.
Table 3 redis_config parameter description
Parameter Type Mandatory Description
param_id String Yes Configuration item ID.
param_name String Yes Configuration item name.
param_value String Yes Value of the configuration item.

For possible values of parameters in Table 3 <dcs-api-0312017__table35215230340>, see Table 4 <dcs-api-0312015__table1439111281351>.

Example request

  • Request URL:

    PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/configs
  • Example:

    {
        "redis_config": [
            {
                "param_id": "1",
                "param_name": "timeout",
                "param_value": "100"
            }
        ]
    }

Response

Response parameters

None

Example response

None

Status Code

Table 4 <dcs-api-0312017__table17459195018122> describes the status code of successful operations. For details about other status codes, see Table 1 <dcs-api-0312043__table5210141351517>.

Table 4 Status code
Status Code Description
204 DCS instance configurations modified successfully.