Files
doc-exports/docs/ddm/api-ref/en-us_topic_0000002510482745.html
wangdengke2 823df869a9 ddm_api
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2026-03-03 12:01:43 +00:00

16 KiB

Modifying Parameters of an Instance (a V3 API)

Function

This API is used to modify parameters of a DDM instance.

Constraints

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

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

instance_id

Yes

String

DDM instance ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Content-Type

Yes

String

MIME type of the request body. Value range:

  • application/json
  • application/json;charset=utf-8
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

values

Yes

Map<String,String>

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

  • key: parameter name. If a parameter name is left empty, its value is not to be changed.
  • value: indicates the parameter value.

Example Request

Changing the value of long_query_time to 2. The value indicates that the query is considered as a slow query if its execution duration is greater than or equal to 2 seconds.

PUT https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/configurations

{
  "values" : {
    "long_query_time" : "2"
  }
}

Response

  • Normal response
    Table 4 Response body parameters

    Parameter

    Type

    Description

    need_restart

    Boolean

    Whether the instance needs to be restarted

Status Codes

Error Codes

For details, see Error Codes.