Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ DB Instance Management/ Applying for a Private Domain Name
Updated on 2026-01-05 GMT+08:00
View PDF
Share

Applying for a Private Domain Name

Function

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:createDns

write

-

-

-

-

Constraints

This API is available for the PostgreSQL and SQL Server DB engines.

URI

  • URI format

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

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

dns_type

Yes

String

Definition

Domain name type.

Constraints

N/A

Range

private: private domain name, which is valid only in a VPC.

Default Value

N/A

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 Parameters

    Parameter

    Type

    Description

    job_id

    String

    Definition

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

    Range

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

Status Code

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management