All Products
Search

This Product

    Network Intelligence Service:DescribeNisInspectionReportCheckItems

    Document Center

    Network Intelligence Service:DescribeNisInspectionReportCheckItems

    Last Updated:Aug 21, 2026

    Queries the details of inspection report check items.

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

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InspectionReportId

    string

    Yes

    The inspection report ID.

    nir-ffd1af****196d0
    ResourceType

    array

    No

    The resource type.

    string

    No

    The type of the associated resource.

    Valid values:

    • NAT :

      NAT

    • VPN :

      VPN

    • NLB :

      NLB

    • VBR :

      VBR

    • ALB :

      ALB

    • CLB :

      CLB

    • EIP :

      EIP

    • TR :

      TR

    NAT
    CategoryCode

    string

    No

    The category of the check item.

    stability
    RiskLevel

    array

    No

    The collection of risk levels.

    string

    No

    The risk level. If not specified, all risk levels are included. Valid values:

    • HighRisk: high risk.

    • MediumRisk: medium risk.

    • LowRisk: low risk.

    • NoRisk: no risk.

    Valid values:

    • LowRisk :

      Low risk.

    • HighRisk :

      High risk.

    • MediumRisk :

      Medium risk.

    • NoRisk :

      No risk.

    HighRisk
    NextToken

    string

    No

    The query token. Set this parameter to the NextToken value returned in the previous API call.

    hKrS+MVXkuOgztXnvdml16/uO3mvCyHxSjzdhx9VRUC+8umDTIV2Wg9TTOUrR7ve
    MaxResults

    integer

    No

    The maximum number of entries per page for a paged query. Maximum value: 100. Default value: 20.

    20
    Language

    string

    No

    The language. Valid values: zh-CN, en-US.

    Valid values:

    • en-US :

      English.

    • zh-CN :

      Chinese.

    zh-CN

    Response elements

    Element

    Type

    Description

    Example

    object

    RpcResponse<NextTokenResult>

    RequestId

    string

    The request ID.

    D5E98683-355B-5867-8D3D-A24755F6895B
    CheckItemList

    array<object>

    The list of inspection check items.

    array<object>

    ResourceType

    string

    The resource type associated with the inspection check item.

    NAT
    CategoryCode

    string

    The category of the check item.

    stability
    CheckItemCode

    string

    The code of the inspection check item.

    item_nat_water_level_check
    Description

    string

    The description of the inspection check item.

    None
    CheckResultList

    array<object>

    The list of risk level count results for the inspection.

    object

    RiskLevel

    string

    The risk level. Valid values:

    • HighRisk: high risk.

    • MediumRisk: medium risk.

    • LowRisk: low risk.

    • NoRisk: no risk.

    LowRisk
    Count

    integer

    The number of risks at the corresponding level in the inspection report.

    0
    RecommendationList

    array<object>

    The list of inspection anomaly results.

    object

    RiskLevel

    string

    The risk level. Valid values:

    • HighRisk: high risk.

    • MediumRisk: medium risk.

    • LowRisk: low risk.

    • NoRisk: no risk.

    LowRisk
    RecommendationCode

    string

    The inspection anomaly item.

    nat_snat_cross_az_warn
    Abnormality

    string

    The description of the anomaly.

    Multiple cross-zone resources share a single NAT gateway
    Reason

    string

    The cause of the anomaly.

    Multiple cross-zone resources share a single NAT gateway
    Suggestion

    string

    The optimization suggestions.

    Deploy NAT gateways in each zone where your resources reside and configure SNAT/DNAT rules to ensure that resources use the NAT gateway in the same zone. This ensures that if a zone fails, resources in other zones can still maintain network communication
    Metadata

    string

    The metadata of the resource associated with the anomaly item.

    {"Columns":[{"ColumnType":"id","ColumnTitle":"Resource ID","ColumnValue":"ResourceId"},{"ColumnType":"az","ColumnTitle":"NAT Deployment AZ","ColumnValue":"NatAZ"},{"ColumnType":"array.az","ColumnTitle":"Resource Deployment AZ","ColumnValue":"ForwardsAZs"},{"ColumnType":"region","ColumnTitle":"Region","ColumnValue":"RegionNo"}]}
    ReasonCode

    string

    SuggestionCode

    string

    CheckItemName

    string

    The name of the check item.

    NAT High Availability Deployment Check
    DescriptionCode

    string

    The description code of the check item.

    item_ep_high_availability_check_description
    NextToken

    string

    Indicates whether a next query token exists. If NextToken is empty, no more results exist. If NextToken is returned, the value indicates the token for the next query.

    hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj
    TotalCount

    integer

    The total number of entries returned.

    11
    MaxResults

    integer

    The page size. Valid values: 1 to 100. Default value: 20.

    20
    InspectionReportId

    string

    The inspection report ID.

    nir-ffd1af****196d0

    Examples

    Success response

    JSON format

    {
  "RequestId": "D5E98683-355B-5867-8D3D-A24755F6895B",
  "CheckItemList": [
    {
      "ResourceType": "NAT",
      "CategoryCode": "stability",
      "CheckItemCode": "item_nat_water_level_check",
      "Description": "无",
      "CheckResultList": [
        {
          "RiskLevel": "LowRisk",
          "Count": 0
        }
      ],
      "RecommendationList": [
        {
          "RiskLevel": "LowRisk",
          "RecommendationCode": "nat_snat_cross_az_warn",
          "Abnormality": "Multiple cross-zone resources share a single NAT gateway.",
          "Reason": "Multiple cross-zone resources share a single NAT gateway.",
          "Suggestion": "Deploy NAT gateways in all zones where resources reside.",
          "Metadata": "{\"Columns\":[{\"ColumnType\":\"id\",\"ColumnTitle\":\"Resource ID\",\"ColumnValue\":\"ResourceId\"},{\"ColumnType\":\"az\",\"ColumnTitle\":\"NAT Deployment Zone\",\"ColumnValue\":\"NatAZ\"},{\"ColumnType\":\"array.az\",\"ColumnTitle\":\"Resource Deployment Zone\",\"ColumnValue\":\"ForwardsAZs\"},{\"ColumnType\":\"region\",\"ColumnTitle\":\"Region\",\"ColumnValue\":\"RegionNo\"}]}",
          "ReasonCode": "",
          "SuggestionCode": ""
        }
      ],
      "CheckItemName": "NAT high-availability deployment check",
      "DescriptionCode": "item_ep_high_availability_check_description"
    }
  ],
  "NextToken": "hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj",
  "TotalCount": 11,
  "MaxResults": 20,
  "InspectionReportId": "nir-ffd1af****196d0"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 IncorrectStatus.InspectionReportNotFinish The specified task report InspectionReportId(%s) has not been completed. The specified task report InspectionReportId(%s) has not been completed.
    400 IllegalParam.ResourceType The specified resourceType (%s) is invalid. The value of ResourceType is invalid.
    400 IllegalParam.RiskLevel The specified argument RiskLevel(%s) is illegal. The specified argument RiskLevel(%s) is illegal.
    400 IllegalParam.NextToken The specified nextToken(%s) is invalid. The NextToken(%s) parameter is set to an invalid value.
    400 IllegalParam.UnsupportedResourceType The specified parameter ResourceType(%s) is invalid, with a resource type that is not currently supported. The specified parameter ResourceType(%s) is invalid, with a resource type that is not currently supported.
    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. The specified InspectionReportId (%s) does not exist.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.