Query NIS Inspection Report Status with DescribeNisInspectionReportStatus API - Network Intelligence Service

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:DescribeNisInspectionReportStatus

get

*All Resource

*

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object	RpcResponse
RequestId	string	The request ID.	A7F0D6EC-E19E-58AC-AC9F-08036763960F
InspectionReportId	string	The ID of the inspection report.	nir-2ca527b8de114ba4afb9
InspectionTaskId	string	The ID of the inspection task.	ni-8svmpe0yso****r7fh79
Status	string	The status of the inspection report. Valid values: Failed : Failed. Finish : Finished. On-going : In progress.	Finish
StartTime	string	The start time.	2024-07-18 15:12:28
EndTime	string	The end time.	2024-07-18 15:13:07
InspectionProject	string	The type of inspection plan used for the task. Valid values: customized : Custom scenario. basic : Basic scenario.	basic
InspectionTaskName	string	The name of the inspection task.	Default

Examples

Success response

JSON format

{
  "RequestId": "A7F0D6EC-E19E-58AC-AC9F-08036763960F",
  "InspectionReportId": "nir-2ca527b8de114ba4afb9",
  "InspectionTaskId": "ni-8svmpe0yso****r7fh79",
  "Status": "Finish",
  "StartTime": "2024-07-18 15:12:28",
  "EndTime": "2024-07-18 15:13:07",
  "InspectionProject": "basic",
  "InspectionTaskName": "Default"
}

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.