Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Parameter Template Management/ Deleting a Parameter Template
Updated on 2024-09-11 GMT+08:00
View PDF
Share

Deleting a Parameter Template

Function

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

Constraints

  • This API is suitable only for GaussDB(for MySQL) instances.
  • 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

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

configuration_id

Yes

String

Parameter template 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 the IAM API used to obtain a user token.

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

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

configuration_id

String

Parameter template ID.

configuration_name

String

Parameter template name.

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.