Updated on 2025-08-06 GMT+08:00

Applying for a Domain Name

Function

This API is used to apply for a domain name for a specified cluster.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/dns

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Domain name to be created.

Range

N/A

type

Yes

String

Definition

Domain name type.

Range

public

private

ttl

Yes

Integer

Definition

Caching duration of the SOA record set, in seconds. The default value is 300, in seconds.

Range

300 to 2147483647

Response Parameters

Status code: 200

The domain name is successfully applied for.

None

Example Requests

Apply for the public domain name demo (SOA cache duration is 300s).

POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7/dns

{
  "name" : "demo",
  "type" : "public",
  "ttl" : 300
}

Example Responses

None

Status Codes

Status Code

Description

200

The domain name is successfully applied for.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.