Help Center> Web Application Firewall> API Reference> API> Managing Websites Protected by Cloud WAF> Obtaining Domain Name Route Information in Cloud Mode
View PDF

Obtaining Domain Name Route Information in Cloud Mode

Function

This API is used to obtain the domain name route information.

Debugging

You can use API Explorer to debug this API.

URI

GET /v1/{project_id}/waf/instance/{instance_id}/route

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

instance_id

Yes

String

Domain name ID
Table 2 Query parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID

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 (value of X-Subject-Token in the response header).

Content-Type

Yes

String

Content type

Default: application/json;charset=utf8

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Quantity

items

Array of RouteBody objects

Route information body
Table 5 RouteBody

Parameter

Type

Description

name

String

Name

servers

Array of RouteServerBody objects

Route information
Table 6 RouteServerBody

Parameter

Type

Description

back_protocol

String

Protocol

address

String

IP address

port

Integer

Port

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.