Obtaining Domain Name Route Information in Cloud Mode

Function

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

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

Request Parameters

**Table 2** 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 3** Response body parameters
Parameter	Type	Description
total	Integer	Quantity
items	Array of RouteBody objects	Route information body

**Table 4** RouteBody
Parameter	Type	Description
name	String	Name
servers	Array of RouteServerBody objects	Route information

**Table 5** RouteServerBody
Parameter	Type	Description
back_protocol	String	Protocol
address	String	IP address
port	Integer	Port

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error code message

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error code message

Status code: 500

**Table 8** 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.

Parent topic: Managing Websites Protected by Cloud WAF

Previous topic: Modifying the Protection Status for a Domain Name

Next topic: Querying a Domain Name Protected by Cloud WAF by ID

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot