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

Querying the Domain Name of a DB Instance

Function

This API is used to query the domain name of a DB instance.

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

Constraints

This API is available only for RDS for PostgreSQL.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/dns

  • Parameter description
    Table 1 Parameters

    Parameter

    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

    Instance ID.

    dns_type

    Yes

    Domain type. Only private domains are supported.

Request

  • Parameter description

    None

  • URI example

    GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/ instances/c90928717dc747e2a20099894a87c468in01/dns?dns_type=private

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    instance_id

    String

    Instance ID.

    dns_name

    String

    Domain name of the instance.

    dns_type

    String

    Domain type. Value: private.

    ipv4_address

    String

    Virtual IP address bound to the instance domain name.

    status

    String

    Domain status.

  • Example normal response
    {
        "instance_id": "2de6315e7197418fbf2fdaed59d65da1in03",
        "dns_name": "2de6315e7197418fbf2fdaed59d65da1in03.internal.cn-xianhz-1.mysql.rds-dev.myhuaweicloud.com",
        "dns_type": "private",
        "ipv4_address": "192.168.6.105",
        "status": "normal"
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.