Get Rule Analysis Activity Status

Get Rule Analysis Activity Status
Get the runtime status of a firewall rule analysis activity.

Returns the runtime details of the firewall rule analysis activity.

Request
URI
GET
https://{api_host}/firewall/rule-analysis/activities/{id}/status
COPY
Path Parameters
string
id
Required  

ID of rule analysis activity

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ActivityDetails of type(s) application/json
This response body class contains all of the following: Activity , InlineActivityDetails1 
{
    "_create_user": "string",
    "_create_time": 0,
    "_last_modified_user": "string",
    "_last_modified_time": 0,
    "_revision": 0,
    "_resource_type": "string",
    "_system_owned": false,
    "id": "string",
    "display_name": "string",
    "description": "string",
    "site_ids": [
        "string"
    ],
    "activity_type": "string",
    "status": "string",
    "start_time": 0,
    "end_time": 0,
    "progress": 0,
    "cancelable": false,
    "is_stale": false,
    "is_last_successful": false,
    "cancelled_by": "string",
    "cancellation_time": 0,
    "anomalies_summary": [
        {
            "anomaly_type": "string",
            "count": 0
        }
    ],
    "rules_analyzed_count": 0,
    "rules_ignored_count": 0,
    "failure_reason": "string"
}

400

Bad Request

Returns BadRequest of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


412

Precondition Failed

Returns PreconditionFailed of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


428

Precondition Required

Returns PreconditionRequired of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


429

Too Many Requests

Returns TooManyRequests of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


default

Error

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/firewall/rule-analysis/activities/{id}/status
On This Page
Rule Analysis Operations
POST
Create Rule Analysis Activity
POST
Delete Rule Analysis Activities
POST
List Rule Analysis Activities
GET
Get Rule Analysis Activity
DELETE
Delete Rule Analysis Activity
POST
Update Rule Analysis Activity
GET
Get Rule Analysis Activity Status
POST
List Anomaly Rule Sets
POST
List Anomaly Rule Set Firewall Rules
GET
Download Rule Analysis Result
POST
List Rule Analysis Settings
PUT
Update Rule Analysis Settings
POST
Update Rule Analysis Ignored Rules
POST
List Rule Analysis Ignored Rules
POST
List Rule Analysis Summaries
POST
List Rule Analysis Firewall Rules