查询巡检报告检查项详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
nis:DescribeNisInspectionReportCheckItems |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InspectionReportId |
string |
是 |
巡检报告 ID |
nir-ffd1af****196d0 |
| ResourceType |
array |
否 |
资源类型 |
|
|
string |
否 |
关联资源的类型。 |
NAT |
|
| CategoryCode |
string |
否 |
巡检项类别。 |
stability |
| RiskLevel |
array |
否 |
风险等级集合。 |
|
|
string |
否 |
风险等级，不填为全部风险等级。取值：
|
HighRisk |
|
| NextToken |
string |
否 |
查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。 |
hKrS+MVXkuOgztXnvdml16/uO3mvCyHxSjzdhx9VRUC+8umDTIV2Wg9TTOUrR7ve |
| MaxResults |
integer |
否 |
分页查询时每页的最大条目数。最大值为 100。默认值为 20。 |
20 |
| Language |
string |
否 |
语言，枚举：zh-CN，en-US |
zh-CN |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
RpcResponse<NextTokenResult |
||
| RequestId |
string |
请求 ID。 |
D5E98683-355B-5867-8D3D-A24755F6895B |
| CheckItemList |
array<object> |
巡检检查项列表。 |
|
|
object |
|||
| ResourceType |
string |
巡检检查项关联的资源类型。 |
NAT |
| CategoryCode |
string |
巡检项类别。 |
stability |
| CheckItemCode |
string |
巡检检查项码 |
item_nat_water_level_check |
| Description |
string |
巡检检查项描述。 |
无 |
| CheckResultList |
array<object> |
巡检风险等级数量结果列表。 |
|
|
object |
|||
| RiskLevel |
string |
风险等级。取值：
|
LowRisk |
| Count |
integer |
巡检报告中对应等级的风险数量。 |
0 |
| RecommendationList |
array<object> |
巡检异常项结果列表。 |
|
|
object |
|||
| RiskLevel |
string |
风险等级。 取值：
|
LowRisk |
| RecommendationCode |
string |
巡检异常项。 |
nat_snat_cross_az_warn |
| Abnormality |
string |
异常项描述。 |
多个跨可用区资源共用一台NAT网关 |
| Reason |
string |
异常原因。 |
多个跨可用区资源共用一台NAT网关 |
| Suggestion |
string |
优化建议。 |
建议在资源所在可用区均部署NAT网关，并配置您的SNAT/DNAT规则以确保资源使用同可用区内的NAT网关。这样可以确保即使某个可用区发生故障，其他可用区的资源仍能保持网络通信。 |
| Metadata |
string |
异常项对应资源的元数据。 |
{"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 |
检查项的名称。 |
NAT高可用部署检查 |
| NextToken |
string |
是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。 如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。 |
hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj |
| TotalCount |
integer |
返回的条目总数。 |
11 |
| MaxResults |
integer |
分页大小，取值范围：1~100，默认值：20。 |
20 |
| InspectionReportId |
string |
巡检报告 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": "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高可用部署检查"
}
],
"NextToken": "hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj",
"TotalCount": 11,
"MaxResults": 20,
"InspectionReportId": "nir-ffd1af****196d0"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | IncorrectStatus.InspectionReportNotFinish | The specified task report InspectionReportId(%s) has not been completed. | 指定的任务报告InspectionReportId(%s)还没有完成。 |
| 400 | IllegalParam.ResourceType | The specified resourceType (%s) is invalid. | 指定的ResourceType变量值(%s)不存在。 |
| 400 | IllegalParam.RiskLevel | The specified argument RiskLevel(%s) is illegal. | 指定的参数RiskLevel(%s)不合法。 |
| 400 | IllegalParam.NextToken | The specified nextToken(%s) is invalid. | 指定的NextToken(%s)参数不合法。 |
| 400 | IllegalParam.UnsupportedResourceType | The specified parameter ResourceType(%s) is invalid, with a resource type that is not currently supported. | 指定的参数ResourceType(%s)不合法，有当前不支持的资源类型。 |
| 403 | Forbidden.InspectionReportId | This user does not have permission to this report parameter (%s). | 该用户无该报告参数(%s)权限。 |
| 404 | ResourceNotFound.InspectionReportId | The specified InspectionReportId(%s) is not found. | 指定的InspectionReportId(%s)不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。