ListNisInspectionTasks - Network Intelligence Service - Alibaba Cloud Documentation Center

Lists the network inspection tasks.

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 support 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:ListNisInspectionTasks

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InspectionTaskId	string	No	The ID of the network inspection task.	ni-8svm******hzr7fh79
InspectionName	string	No	The name of the network inspection task.	nis巡检
InspectionProject	string	No	The type of inspection solution that the network inspection task uses. Valid values: basic and customized.	basic
Status	string	No	The running status of the task. Valid values: Creating Active Running Inactive	Active
NextToken	string	No	The token that is used to retrieve the next page of results. Set this parameter to the NextToken value returned from a previous call.	hKrS+MVXkuOgztXnvdml1/R9jhHkiH8eW3CfaOYU0CEL7yiT0zae6J8v1zYNg+d1
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 20.	20

Response parameters

Parameter	Type	Description	Example
	object	RpcResponse
RequestId	string	The request ID.	A7F0D6EC-E19E-58AC-AC9F-08036763960F
InspectionTaskList	array<object>	The list of network inspection tasks.
	object
InspectionTaskId	string	The ID of the network inspection task.	ni-8svm******hzr7fh79
InspectionName	string	The name of the network inspection task.	nis巡检
Status	string	The running status of the task. Valid values: Creating: The task is being created. Active Running Inactive	Active
InspectionProject	string	The type of inspection solution that the network inspection task uses. Valid values: basic and customized.	basic
CreateTime	string	The time when the task was created.	2024-06-18 00:14:46
LastUpdateReportId	string	The ID of the latest report.	nir-b4c4c9******8a25e
NextToken	string	The token to retrieve the next page of results. If the value of this parameter is not empty, it indicates that there are more results to retrieve. If this parameter is empty, all results have been returned.	hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj
MaxResults	integer	The number of entries per page. Valid values: 1 to 100. Default value: 20.	20
TotalCount	integer	The total number of entries returned.	5

Examples

Success response

JSON format

{
  "RequestId": "A7F0D6EC-E19E-58AC-AC9F-08036763960F",
  "InspectionTaskList": [
    {
      "InspectionTaskId": "ni-8svm******hzr7fh79",
      "InspectionName": "nis巡检",
      "Status": "Active",
      "InspectionProject": "basic",
      "CreateTime": "2024-06-18 00:14:46",
      "LastUpdateReportId": "nir-b4c4c9******8a25e"
    }
  ],
  "NextToken": "hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj",
  "MaxResults": 20,
  "TotalCount": 5
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.NextToken	The specified argument NextToken(%s) is illegal.	The specified argument NextToken(%s) is illegal.
400	IllegalParam.Status	The specified Status(%s) parameter is illegal.	The specified Status(%s) parameter is illegal.
400	IllegalParam.InspectionProject	The specified argument InspectionProject(%s) is illegal.	The specified parameter InspectionProject is illegal.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.