Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Parameter Configuration/ Checking Whether the Parameter Template Name Exists
Updated on 2025-08-11 GMT+08:00

Checking Whether the Parameter Template Name Exists

Function

This API is used to check whether the parameter template name exists. Before calling this API:

URI

GET /v3/{project_id}/configurations/name-validation?name={name}

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

name

Yes

String

Definition

Parameter template name.

Constraints

N/A

Range

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

Default Value

N/A

Request Parameters

None

Response Parameters

Table 2 Parameter description

Parameter

Type

Description

exist

Boolean

Definition

Verification result.

Range

  • true: The name already exists.
  • false: The name does not exist.

Example Request

Checking whether the parameter template name exists

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/configurations/name-validation?name=paramTemplate-a9f3

Example Response

Check result returned.
{ 
  "exist" : false 
}

Status Codes

Error Codes

For details, see Error Codes.