Asynchronously Modifying Instance Configuration Parameters

Function

This API is used to modify the configuration parameters of a DCS instance to optimize DCS performance as required.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance 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: 200

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	ID of a configuration update task.

Status code: 204

No parameter is modified and no asynchronous task is performed. The operation completes.

Status code: 400

**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.

Status code: 500

**Table 6** 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

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

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

Example Responses

Status code: 200

Successfully sent the asynchronous parameter modification request.

{
  "job_id" : "8abf6e1e7bceacf6017bcf3d9e880188"
}

Status Codes

Status Code	Description
200	Successfully sent the asynchronous parameter modification request.
204	No parameter is modified and no asynchronous task is performed. The operation completes.
400	Invalid request.
500	Internal service error.