查詢巡檢報告檢查項詳情。
調試
您可以在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> |
巡檢檢查項列表。 |
|
|
array<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 Gateway |
| Reason |
string |
異常原因。 |
多個跨可用性區域資源共用一台NAT Gateway |
| Suggestion |
string |
最佳化建議。 |
建議在資源所在可用性區域均部署NAT Gateway,並配置您的SNAT/DNAT規則以確保資源使用同可用性區域內的NAT Gateway。這樣可以確保即使某個可用性區域發生故障,其他可用性區域的資源仍能保持網路通訊。 |
| 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高可用部署檢查 |
| DescriptionCode |
string |
item_ep_high_availability_check_description |
|
| 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 Gateway",
"Reason": "多個跨可用性區域資源共用一台NAT Gateway",
"Suggestion": "建議在資源所在可用性區域均部署NAT Gateway,並配置您的SNAT/DNAT規則以確保資源使用同可用性區域內的NAT Gateway。這樣可以確保即使某個可用性區域發生故障,其他可用性區域的資源仍能保持網路通訊。",
"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"
}
錯誤碼
|
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)不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。