All Products
Search

This Product

    Network Intelligence Service:DescribeNisInspectionReportCheckItems

    Document Center

    Network Intelligence Service:DescribeNisInspectionReportCheckItems

    Last Updated:Dec 04, 2025

    Describes check items in an inspection report.

    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 ID of the inspection report.

    nir-ffd1af****196d0

    ResourceType

    array

    No

    The resource type.

    string

    No

    The type of the linked resource.

    Valid values:

    • NAT:

      NAT Gateway

    • VPN:

      VPN

    • NLB:

      Network Load Balancer (NLB)

    • VBR:

      Virtual Border Router (VBR)

    • ALB:

      Application Load Balancer (ALB)

    • CLB:

      Classic Load Balancer (CLB)

    • EIP:

      EIP

    • TR:

      Transit Router (TR)

    NAT

    CategoryCode

    string

    No

    The category of the check item.

    stability

    RiskLevel

    array

    No

    A collection of risk levels.

    string

    No

    The risk level. If you leave this parameter empty, check items of all risk levels are returned. Valid values:

    • HighRisk: high risk

    • MediumRisk: medium risk

    • LowRisk: low risk

    • NoRisk: no risk

    HighRisk

    NextToken

    string

    No

    The token that is used for the next query. Set this parameter to the NextToken value returned from the previous 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 of the content. Valid values: zh-CN and en-US.

    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 check items.

    array<object>

    ResourceType

    string

    The resource type associated with the check item.

    NAT

    CategoryCode

    string

    The category of the check item.

    stability

    CheckItemCode

    string

    The code of the check item.

    item_nat_water_level_check

    Description

    string

    The description of the check item.

    无

    CheckResultList

    array<object>

    The number of check items at each risk level.

    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 this level in the inspection report.

    0

    RecommendationList

    array<object>

    The list of results for abnormal check items.

    object

    RiskLevel

    string

    The risk level. Valid values:

    • HighRisk: high risk

    • MediumRisk: medium risk

    • LowRisk: low risk

    • NoRisk: no risk

    LowRisk

    RecommendationCode

    string

    The code for the abnormal check item.

    nat_snat_cross_az_warn

    Abnormality

    string

    The description of the abnormal item.

    多个跨可用区资源共用一台NAT网关

    Reason

    string

    The cause of the abnormality.

    多个跨可用区资源共用一台NAT网关

    Suggestion

    string

    The optimization suggestions.

    建议在资源所在可用区均部署NAT网关，并配置您的SNAT/DNAT规则以确保资源使用同可用区内的NAT网关。这样可以确保即使某个可用区发生故障，其他可用区的资源仍能保持网络通信。

    Metadata

    string

    The metadata of the resource that corresponds to the abnormal item.

    {"Columns":[{"ColumnType":"id","ColumnTitle":"资源ID","ColumnValue":"ResourceId"},{"ColumnType":"az","ColumnTitle":"NAT部署AZ","ColumnValue":"NatAZ"},{"ColumnType":"array.az","ColumnTitle":"资源部署AZ","ColumnValue":"ForwardsAZs"},{"ColumnType":"region","ColumnTitle":"地域","ColumnValue":"RegionNo"}]}

    ReasonCode

    string

    SuggestionCode

    string

    CheckItemName

    string

    The name of the check item.

    NAT高可用部署检查

    DescriptionCode

    string

    item_ep_high_availability_check_description

    NextToken

    string

    The token that is used to retrieve the next page of results. If this parameter is empty, all results have been returned.

    hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj

    TotalCount

    integer

    The total number of entries returned.

    11

    MaxResults

    integer

    The number of entries per page. Valid values: 1 to 100. Default value: 20.

    20

    InspectionReportId

    string

    The ID of the inspection report.

    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": "多个跨可用区资源共用一台NAT网关",
          "Reason": "多个跨可用区资源共用一台NAT网关",
          "Suggestion": "建议在资源所在可用区均部署NAT网关，并配置您的SNAT/DNAT规则以确保资源使用同可用区内的NAT网关。这样可以确保即使某个可用区发生故障，其他可用区的资源仍能保持网络通信。",
          "Metadata": "{\"Columns\":[{\"ColumnType\":\"id\",\"ColumnTitle\":\"资源ID\",\"ColumnValue\":\"ResourceId\"},{\"ColumnType\":\"az\",\"ColumnTitle\":\"NAT部署AZ\",\"ColumnValue\":\"NatAZ\"},{\"ColumnType\":\"array.az\",\"ColumnTitle\":\"资源部署AZ\",\"ColumnValue\":\"ForwardsAZs\"},{\"ColumnType\":\"region\",\"ColumnTitle\":\"地域\",\"ColumnValue\":\"RegionNo\"}]}",
          "ReasonCode": "",
          "SuggestionCode": ""
        }
      ],
      "CheckItemName": "NAT高可用部署检查",
      "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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.