Retrieve NIS Inspection Task Details Programmatically via API - Network Intelligence Service

Queries the details of an inspection task.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InspectionTaskId	string	Yes	The ID of the inspection task.	ni-8svmpe0yso2bhzr7fh79

Response elements

Element	Type	Description	Example
	object	RpcResponse
RequestId	string	The request ID.	A7F0D6EC-E19E-58AC-AC9F-08036763960F
InspectionTaskId	string	The ID of the inspection task.	ni-8svmpe0yso2bhzr7fh79
InspectionName	string	The name of the inspection task.	Default
Status	string	The running status of the task. Creating Active Running Inactive	Active
InspectionProject	string	The type of inspection plan for the task. Valid values: basic and customized.	basic
InspectionTriggerTime	string	The time when the inspection task was triggered.	2024-07-01 15:15:57
InspectionInterval	string	The inspection interval. The unit is day.	1
LastUpdateReportId	string	The ID of the latest report.	nir-7c3dd178738a429abe6d
CreateTime	string	The time when the task was created.	2024-07-01 10:00:57
LastUpdateTime	string	The time when the task was last updated.	2024-07-01 10:00:59
CheckResourceList	array<object>	The configuration of the inspected resources.
	object
ResourceType	string	The resource type.	EIP
CheckScope	string	The inspection rule. Valid values: Whitelist : Allowlist. BlackList : Blocklist. CheckAll : All instances of the resource type are fully managed.	CheckAll

Examples

Success response

JSON format

{
  "RequestId": "A7F0D6EC-E19E-58AC-AC9F-08036763960F",
  "InspectionTaskId": "ni-8svmpe0yso2bhzr7fh79",
  "InspectionName": "Default",
  "Status": "Active",
  "InspectionProject": "basic",
  "InspectionTriggerTime": "2024-07-01 15:15:57",
  "InspectionInterval": "1",
  "LastUpdateReportId": "nir-7c3dd178738a429abe6d",
  "CreateTime": "2024-07-01 10:00:57\n",
  "LastUpdateTime": "2024-07-01 10:00:59",
  "CheckResourceList": [
    {
      "ResourceType": "EIP",
      "CheckScope": "CheckAll"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
404	ResourceNotFound.InspectionTaskId	The specified InspectionTaskId(%s) is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.