Updated on 2025-07-29 GMT+08:00

Deleting a Parameter Template

Function

This API is used to delete a specified parameter template. Before calling this API:

Constraints

  • This API is only available for TaurusDB.
  • Default parameter templates cannot be deleted.

URI

DELETE /v3/{project_id}/configurations/{configuration_id}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

configuration_id

Yes

String

Definition

Parameter template ID. To obtain this value, see Querying Parameter Templates.

Constraints

N/A

Range

The value contains 36 characters, starting with a UUID and ending with pr07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

configuration_id

String

Definition

Parameter template ID.

Range

The value is the same as the parameter template ID in the request.

configuration_name

String

Definition

Parameter template name.

Range

The template name can contain 1 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), underscores (_), and periods (.) are allowed.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Deleting a parameter template

DELETE https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/configurations/43570e0de32e40c5a15f831aa5ce4176pr07

Example Response

Status code: 200

Success.

{
  "configuration_id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07",
  "configuration_name" : "myparameter"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.