Help Center/ Document Database Service/ API Reference (Ally Region)/ APIs V3.0 (Recommended)/ Parameter Configuration/ Checking Whether a Parameter Template Name Is Unique
Updated on 2026-01-08 GMT+08:00
View PDF
Share

Checking Whether a Parameter Template Name Is Unique

API Description

This API is used to check whether a parameter template name is unique.

URI

  • URI format

    GET https://{Endpoint}/v3/{project_id}/configurations/name-validation

Table 1 Path parameters

Parameter

Type

IN

Mandatory

Description

project_id

string

path

Yes

Project ID of a tenant in a region. Obtain the project ID by following the instructions in Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token
Table 3 Request body parameters

Parameter

Type

Mandatory

Description

name

String

Yes

Parameter template name.
  • Example request

    None

Response Parameters

  • Parameter description
    Table 4 Response body parameters

    Parameter

    Type

    Description

    is_existed

    Boolean

    Whether a parameter template name already exists.

    • true: The parameter group name already exists.
    • false: The parameter group name does not exist.
  • Example response 
    { 
  "is_existed" : false 
}

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Parameter Configuration