Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ Parameter Configuration/ Checking Whether a Parameter Template Name Is Unique
Updated on 2024-11-29 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 /v3/{project_id}/configurations/name-validation

Table 1 Path parameters

Name

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

Table 2 Query parameters

Name

Mandatory

Type

Description

name

Yes

String

The parameter template name.

Request Parameters

Table 3 Request header parameters

Name

Mandatory

Type

Description

X-Auth-Token

Yes

String

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Name

Type

Description

is_existed

Boolean

Whether a parameter template name already exists.

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

Status code: 400

Table 5 Response body parameters

Name

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Name

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: default

Table 7 Response body parameters

Name

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

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.