文档

DescribeNisInspectionReportCheckItems - 查询巡检报告检查项详情

更新时间:

查询巡检报告检查项详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nis:DescribeNisInspectionReportCheckItemslist
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InspectionReportIdstring

巡检报告 ID

nir-ffd1af****196d0
ResourceTypearray

资源类型

string

关联资源的类型。

枚举值:
  • NATNAT
  • VPNVPN
  • NLBNLB
  • VBRVBR
  • ALBALB
  • CLBCLB
  • EIPEIP
  • TRTR
NAT
CategoryCodestring

巡检项类别。

stability
RiskLevelarray

风险等级集合。

string

风险等级,不填为全部风险等级。取值:

  • HighRisk:高风险
  • MediumRisk:中风险
  • LowRisk:低风险
  • NoRisk:无风险
HighRisk
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

hKrS+MVXkuOgztXnvdml16/uO3mvCyHxSjzdhx9VRUC+8umDTIV2Wg9TTOUrR7ve
MaxResultsinteger

分页查询时每页的最大条目数。最大值为 100。默认值为 20。

20
Languagestring

语言,枚举:zh-CN,en-US

zh-CN

返回参数

名称类型描述示例值
object

RpcResponse<NextTokenResult>

RequestIdstring

请求 ID。

D5E98683-355B-5867-8D3D-A24755F6895B
CheckItemListarray<object>

巡检检查项列表。

object
ResourceTypestring

巡检检查项关联的资源类型。

NAT
CategoryCodestring

巡检项类别。

stability
CheckItemCodestring

巡检检查项码

item_nat_water_level_check
Descriptionstring

巡检检查项描述。

CheckResultListarray<object>

巡检风险等级数量结果列表。

object
RiskLevelstring

风险等级。

取值: - **HighRisk**:高风险 - **MediumRisk**:中风险 - **LowRisk**:低风险 - **NoRisk**:无风险
Countinteger

巡检报告中对应等级的风险数量。

0
RecommendationListarray<object>

巡检异常项结果列表。

object
RiskLevelstring

风险等级。

取值: - **HighRisk**:高风险 - **MediumRisk**:中风险 - **LowRisk**:低风险 - **NoRisk**:无风险
RecommendationCodestring

巡检异常项。

nat_snat_cross_az_warn
Abnormalitystring

异常项描述。

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

异常原因。

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

优化建议。

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

异常项对应资源的元数据。

{"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"}]}
CheckItemNamestring

检查项的名称。

NAT高可用部署检查
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:如果 NextToken 为空表示没有下一次查询。 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。

hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj
TotalCountinteger

返回的条目总数。

11
MaxResultsinteger

分页大小,取值范围:1~100,默认值:20。

20
InspectionReportIdstring

巡检报告 ID

nir-ffd1af****196d0

示例

正常返回示例

JSON格式

{
  "RequestId": "D5E98683-355B-5867-8D3D-A24755F6895B",
  "CheckItemList": [
    {
      "ResourceType": "NAT",
      "CategoryCode": "stability",
      "CheckItemCode": "item_nat_water_level_check",
      "Description": "无",
      "CheckResultList": [
        {
          "RiskLevel": "取值:\n- **HighRisk**:高风险\n- **MediumRisk**:中风险\n- **LowRisk**:低风险\n- **NoRisk**:无风险",
          "Count": 0
        }
      ],
      "RecommendationList": [
        {
          "RiskLevel": "取值:\n- **HighRisk**:高风险\n- **MediumRisk**:中风险\n- **LowRisk**:低风险\n- **NoRisk**:无风险",
          "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\"}]}"
        }
      ],
      "CheckItemName": "NAT高可用部署检查"
    }
  ],
  "NextToken": "hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj",
  "TotalCount": 11,
  "MaxResults": 20,
  "InspectionReportId": "nir-ffd1af****196d0"
}

错误码

HTTP status code错误码错误信息描述
400IncorrectStatus.InspectionReportNotFinishThe specified task report InspectionReportId(%s) has not been completed.指定的任务报告InspectionReportId(%s)还没有完成。
400IllegalParam.ResourceTypeThe specified resourceType (%s) is invalid.指定的ResourceType变量值(%s)不存在。
400IllegalParam.RiskLevelThe specified argument RiskLevel(%s) is illegal.指定的参数RiskLevel(%s)不合法。
400IllegalParam.NextTokenThe specified nextToken(%s) is invalid.指定的NextToken(%s)参数不合法。
400IllegalParam.UnsupportedResourceTypeThe specified parameter ResourceType(%s) is invalid, with a resource type that is not currently supported.指定的参数ResourceType(%s)不合法,有当前不支持的资源类型。
404ResourceNotFound.InspectionReportIdThe specified InspectionReportId(%s) is not found.指定的InspectionReportId(%s)不存在。

访问错误中心查看更多错误码。