Help Center/ Cloud Firewall/ API Reference (Ankara Region)/ API/ Domain Parse and Domain Set Management/ Querying the IP Address for Domain Name Resolution
Updated on 2024-12-05 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the IP Address for Domain Name Resolution

Function

This API is used to test the validity of a domain name.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/domain/parse/{domain_name}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

domain_name

Yes

String

Domain name
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

fw_instance_id

No

String

Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

address_type

No

Integer

Specifies the address type. The value can be 0 (IPv4) or 1 (IPv6).

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

Array of strings

Domain name ID list

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

Minimum: 8

Maximum: 36

error_msg

String

Description

Minimum: 2

Maximum: 512

Example Requests

Check whether the ceshi.com domain name in the project whose ID is 5c69cf330cda42369cbd726ee1bc5e76 is valid.

https://{Endpoint}/v1/5c69cf330cda42369cbd726ee1bc5e76/domain/parse/ceshi.com

Example Responses

Status code: 200

Return value of a domain name validity query

{
  "data" : [ "192.168.88.85", "192.168.88.50", "192.168.88.22", "192.168.88.87", "192.168.88.86", "192.168.5.1", "192.168.88.88", "192.168.88.90", "192.168.88.83", "192.168.88.84" ]
}

Status code: 400

Bad Request

{
  "error_code" : "CFW.00109004",
  "error_msg" : "http to external service error"
}

Status Codes

Status Code

Description

200

Return value of a domain name validity query

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.