Updated on 2025-05-13 GMT+08:00

Modifying Configuration Parameters

Function

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

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/instances/{instance_id}/configs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID.

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

redis_config

No

Array of RedisConfig objects

Array of configuration items of the DCS instance.

Table 3 RedisConfig

Parameter

Mandatory

Type

Description

param_value

Yes

String

Value of the configuration item.

param_name

Yes

String

Configuration item name.

param_id

Yes

String

Configuration item ID.

Response Parameters

Status code: 204

DCS instance configurations modified successfully.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Example Requests

Modifying the instance configuration parameters. For example, set the timeout parameter (maximum amount of idle time after which a client connection is terminated) to 1000 seconds.

PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/configs

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

Example Responses

None

Status Codes

Status Code

Description

204

DCS instance configurations modified successfully.

400

Invalid request.

500

Internal service error.

Error Codes

See Error Codes.