Automate Network Audits with NIS Inspection Report API - Network Intelligence Service

Queries an inspection report summary.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nis:DescribeNisInspectionReportSummary

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InspectionReportId	string	Yes	The ID of the inspection report.	nir-38abb318b27b49cc9a01

Response elements

Element	Type	Description	Example
	object	RpcResponse
RequestId	string	The request ID.	4838F3F2-30E1-5D82-B25A-B9FE33BC3E25
InspectionReportId	string	The ID of the inspection report.	nir-38abb318b27b49cc9a01
InspectionTaskId	string	The ID of the inspection task.	ni-8svmpe0yso2bhzr7fh79
Status	string	The status of the task. Valid values: Creating Active Running Inactive Valid values: Creating : Being created. Active : Enabled. Running : In progress. Inactive : Disabled.	Active
StartTime	string	The start time.	2024-06-03 09:35:00
EndTime	string	The end time.	2024-06-03 09:36:00
Summary	object	The summary information.
CheckItemCount	integer	The number of inspection items.	11
CheckResourceCount	integer	The number of inspected resources.	123
PassRateSummary	array<object>	The pass rate summary.
	object
PassRateScope	string	The scope of the pass rate. Valid values: Stability : Stability. Total : Overall.	Stability
PassRate	number	The pass rate.	0.98
RiskSummary	array<object>	The risk summary.
	object
RiskType	string	The risk type. Valid values: StabilityRisk : Stability risk. TotalRisk : Overall risk.	StabilityRisk
RiskLevel	string	The risk level. Valid values: LowRisk : Low risk. HighRisk : High risk. MediumRisk : Medium risk. NoRisk : No risk.	HighRisk
RiskCount	integer	The number of risks.	3
ResourceCount	integer	The number of resources associated with the risk.	0

Examples

Success response

JSON format

{
  "RequestId": "4838F3F2-30E1-5D82-B25A-B9FE33BC3E25",
  "InspectionReportId": "nir-38abb318b27b49cc9a01",
  "InspectionTaskId": "ni-8svmpe0yso2bhzr7fh79",
  "Status": "Active",
  "StartTime": "2024-06-03 09:35:00",
  "EndTime": "2024-06-03 09:36:00\n",
  "Summary": {
    "CheckItemCount": 11,
    "CheckResourceCount": 123,
    "PassRateSummary": [
      {
        "PassRateScope": "Stability",
        "PassRate": 0.98
      }
    ],
    "RiskSummary": [
      {
        "RiskType": "StabilityRisk",
        "RiskLevel": "HighRisk",
        "RiskCount": 3,
        "ResourceCount": 0
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden.InspectionReportId	This user does not have permission to this report parameter (%s).	This user does not have permission to this report parameter (%s).
404	ResourceNotFound.InspectionReportId	The specified InspectionReportId(%s) is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.