DescribeNisInspectionReportCheckItems - Network Intelligence Service: Central de Documentação do Alibaba Cloud

Descreve os detalhes dos itens de verificação em um relatório de inspeção.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

nis:DescribeNisInspectionReportCheckItems

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InspectionReportId	string	Sim	O ID do relatório de inspeção.	nir-ffd1af****196d0
ResourceType	array	Não	O tipo de recurso.
	string	Não	O tipo do recurso associado. Valores válidos: NAT : VPN : NLB : VBR : ALB : CLB : EIP : TR :	NAT
CategoryCode	string	Não	A categoria do item de verificação.	stability
RiskLevel	array	Não	Uma coleção de níveis de risco.
	string	Não	O nível de risco. Se você não especificar este parâmetro, os itens de verificação de todos os níveis de risco serão retornados. Valores válidos: HighRisk: alto risco MediumRisk: risco médio LowRisk: baixo risco NoRisk: sem risco	HighRisk
NextToken	string	Não	O token de paginação que é usado na próxima solicitação para recuperar uma nova página de resultados. Defina este parâmetro com o valor NextToken retornado da chamada anterior.	hKrS+MVXkuOgztXnvdml16/uO3mvCyHxSjzdhx9VRUC+8umDTIV2Wg9TTOUrR7ve
MaxResults	integer	Não	O número máximo de entradas a serem retornadas em cada página. Valor máximo: 100. Valor padrão: 20.	20
Language	string	Não	O idioma do conteúdo. Valores válidos: zh-CN e en-US.	zh-CN

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	RpcResponse<NextTokenResult>
RequestId	string	O ID da solicitação.	D5E98683-355B-5867-8D3D-A24755F6895B
CheckItemList	array<object>	A lista de itens de verificação.
	array<object>
ResourceType	string	O tipo de recurso associado ao item de verificação.	NAT
CategoryCode	string	A categoria do item de verificação.	stability
CheckItemCode	string	O código do item de verificação.	item_nat_water_level_check
Description	string	A descrição do item de verificação.	无
CheckResultList	array<object>	A lista de resultados de verificação que indica o número de riscos em cada nível de risco.
	object
RiskLevel	string	The risk level. Valid values: HighRisk MediumRisk LowRisk NoRisk	LowRisk
Count	integer	The number of risks at the specified risk level in the inspection report.	0
RecommendationList	array<object>	A lista de resultados para itens de verificação anormais.
	object
RiskLevel	string	The risk level. Valid values: HighRisk MediumRisk LowRisk NoRisk	LowRisk
RecommendationCode	string	The inspection item is abnormal.	nat_snat_cross_az_warn
Abnormality	string	The description of the abnormal item.	Multiple cross-zone resources share a single NAT gateway.
Reason	string	The cause of the abnormality.	Multiple cross-zone resources share a single NAT gateway.
Suggestion	string	The optimization suggestions.	Deploy NAT gateways in all zones where resources reside.
Metadata	string	The metadata of the resource that corresponds to the abnormal item.	{"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	string
SuggestionCode	string
CheckItemName	string	O nome do item de verificação.	NAT high-availability deployment check
DescriptionCode	string		item_ep_high_availability_check_description
NextToken	string	Um token de paginação. Ele pode ser usado na próxima solicitação para recuperar uma nova página de resultados. Se NextToken estiver vazio, não há próxima página.	hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj
TotalCount	integer	O número total de entradas retornadas.	11
MaxResults	integer	O número de entradas por página. Valores válidos: 1 a 100. Valor padrão: 20.	20
InspectionReportId	string	O ID do relatório de inspeção.	nir-ffd1af****196d0

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.