Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ Parameter Configuration/ Checking Whether a Parameter Template Name Is Unique
Updated on 2025-07-04 GMT+08:00

Checking Whether a Parameter Template Name Is Unique

Function

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

URI

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

Table 1 Path parameters

Name

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query parameters

Name

Mandatory

Type

Description

name

Yes

String

Definition

The parameter template name.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Name

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token obtained from IAM. For details, see Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Name

Type

Description

is_existed

Boolean

Definition

Whether a parameter template name already exists.

Range

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

Example Request

GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/configurations/name-validation?name=paramTemplate-a9f3

Example Response

{ 
  "is_existed" : false 
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.