Help Center/ Intelligent EdgeFabric/ API Reference/ API/ Rule Management/ Querying All Errors of a Rule
Updated on 2023-11-23 GMT+08:00
View PDF
Share

Querying All Errors of a Rule

Function

This API is used to query all errors of a specified rule.

URI

GET /v2/{project_id}/routemgr/rules/{rule_id}/errors?{limit=xxx,offset=xxx}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

rule_id

Yes

String

Rule ID.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Maximum number of records that can be returned.

offset

No

Integer

Offset. The records after this offset will be queried.

Request

Table 3 Parameters in the request header

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format).

The default value application/json is recommended.

X-Auth-Token

Yes

String

User token. The token 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 the user token.

Response

When the status code is 200, the response parameters are as follows:

Table 4 Parameters in the response body

Parameter

Type

Description

count

Long

Number of errors that meet the conditions.

errors

Array of Error objects

Error list.
Table 5 Error

Parameter

Type

Description

detail

String

Error details.

ief_instance_id

String

Platinum edition instance ID. This parameter is left blank for a professional edition instance.

project_id

String

Project ID.

rule_id

String

Rule ID.

time

String

Time when an error occurs.

When the status code is 401, the response parameters are as follows.

Table 6 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_message

String

Error message.

When the status code is 500, the response parameters are as follows:

Table 7 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_message

String

Error message.

Example Request

None

Example Response

None

Status Codes

Status Code

Description

200

Query succeeded.

401

Error response.

500

Error response.

Error Codes

For details, see Error Codes.

Parent topic: Rule Management