Identify Abnormal Inspection Resources Using NIS 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:DescribeNisInspectionRecommendationResources

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InspectionReportId	string	Yes	The ID of the inspection report.	nir-ffd1af****196d0
RecommendationCode	string	Yes	The recommendation code for the abnormal item.	nat_snat_cross_az_warn
NextToken	string	No	The token that is used to query the next page of results. Set this parameter to the NextToken value returned from the last API call.	hKrS+MVXkuOgztXnvdml16/uO3mvCyHxSjzdhx9VRUC+8umDTIV2Wg9TTOUrR7ve
MaxResults	integer	No	The maximum number of entries to return on each page. Maximum value: 100. Default value: 20.	20
Language	string	No	The language to use.	zh-CN

Response elements

Element	Type	Description	Example
	object	RpcResponse<NextTokenResult<DescribeNisInspectionRecommendationResourcesResponse>>
RequestId	string	The request ID.	A7F0D6EC-E19E-58AC-AC9F-08036763960F
ResourceList	array<object>	The list of resources.
	object
ResourceId	string	The ID of the abnormal instance.	ngw-p0wn04hi4****q2us6q7q
ResourceName	string	The name of the instance.	Public NAT Gateway
AnalysisData	string	The details of the abnormal item.	{ResourceId: "ngw-p0wn04hi4****q2us6q7q"}
NextToken	string	The token to start the next query.	qt0DqY2lXxwBt9/ROQoS/7J9p90D1vF2vFbwzb/1oSWr3AxcM6/KpObZ7Z1PZdcV
TotalCount	integer	The total number of resources.	192
MaxResults	integer	The maximum number of entries returned on each page. Maximum value: 100. Default value: 20.	20
InspectionReportId	string	The ID of the inspection report.	nir-ffd1af****196d0

Examples

Success response

JSON format

{
  "RequestId": "A7F0D6EC-E19E-58AC-AC9F-08036763960F",
  "ResourceList": [
    {
      "ResourceId": "ngw-p0wn04hi4****q2us6q7q",
      "ResourceName": "Public NAT Gateway",
      "AnalysisData": "\n{ResourceId: \"ngw-p0wn04hi4****q2us6q7q\"}"
    }
  ],
  "NextToken": "qt0DqY2lXxwBt9/ROQoS/7J9p90D1vF2vFbwzb/1oSWr3AxcM6/KpObZ7Z1PZdcV",
  "TotalCount": 192,
  "MaxResults": 20,
  "InspectionReportId": "nir-ffd1af****196d0\n"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.NextToken	The specified nextToken(%s) is invalid.	The NextToken(%s) parameter is set to an invalid value.
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.
404	ResourceNotFound.RecommendationCode	The specified parameter RecommendationCode(%s) does not exist.	The specified parameter RecommendationCode(%s) does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.