Updated on 2024-06-07 GMT+08:00

Applying for a Private Domain Name

Function

This API is used to bind a private domain name to a specified DB instance.

  • Before calling an API, you need to understand the API in Authentication.

Constraints

This API supports PostgreSQL only.

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/create-dns

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Table 2 Parameter description

Name

Mandatory

Type

Description

dns_type

Yes

String

Specifies the domain name type. Currently, only private is supported.

Example Request

Apply for a private domain name.
POST https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/create-dns

{
     "dns_type": "private"
}

Response

  • Normal response
    Table 3 Parameter description

    Name

    Type

    Description

    job_id

    String

    Indicates the ID of the task for applying for a private domain name.

  • Normal response
    {
        "job_id": "b9e057a0-f0fb-4987-9d21-f3a7550b32e7"
    }

Status Code

Error Code

For details, see Error Codes.