EvaluatePreConfigRules - Cloud Config: Central de Documentação do Alibaba Cloud

Executa regras de avaliação para realizar pré-verificações de conformidade em recursos.

Descrição da operação

Para obter mais informações sobre os conceitos, os princípios de operação e o processo de integração das regras de avaliação, consulte Definição e princípios de operação das regras de avaliação.

Após a criação de uma regra de avaliação, uma regra gerenciada com as mesmas configurações é criada. Essa regra gerenciada pode verificar continuamente a conformidade dos recursos após a criação deles.

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

config:EvaluatePreConfigRules

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ResourceTypeFormat	string	Não	O token de início da consulta.	ros
ResourceEvaluateItems	array<object>	Sim	Uma matriz que contém os recursos que você deseja avaliar.
	array<object>	Não	Os recursos que você deseja avaliar.
ResourceLogicalId	string	Não	O ID lógico do recurso. Nota Se este parâmetro estiver vazio, ele será gerado com base no valor Base64 de `ResourceProperties`.	ResourceLogicId-test
ResourceType	string	Não	O tipo do recurso. Para obter informações sobre como obter o identificador de uma regra de avaliação, consulte ListPreManagedRules. Nota Os parâmetros `ResourceType`, `Identifier` e `ResourceProperties` devem ser especificados ao mesmo tempo.	ACS::ECS::Instance
Rules	array<object>	Não	Uma matriz que contém as regras de avaliação.
	object	Não	As regras de avaliação.
Identifier	string	Não	O identificador da regra. Para obter informações sobre como obter o identificador de uma regra, consulte ListPreManagedRules. Nota Os parâmetros `ResourceType`, `Identifier` e `ResourceProperties` devem ser especificados ao mesmo tempo.	ecs-instance-deletion-protection-enabled
InputParameters	string	Não	Os parâmetros de entrada da regra.	{}
ResourceProperties	string	Não	Os itens de configuração do recurso (propriedades do recurso a ser criado), como as especificações, região, nome, status e status de ativação da porta ou da interface de rede do recurso. Nota Os parâmetros `ResourceType`, `Identifier` e `ResourceProperties` devem ser especificados ao mesmo tempo.	{"ResourceGroupId":"","Memory":8192,"InstanceChargeType":"PostPaid","Cpu":2}
EnableManagedRules	boolean	Não	Especifica se os modelos de regra devem ser ativados. Valores válidos: true: ativa os modelos de regra. false (padrão): não ativa os modelos de regra.	false

Para obter mais informações, consulte Parâmetros comuns.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Nenhum.
RequestId	string	O ID da solicitação.	129ECF1C-7897-1131-BD0F-4B588AC05400
ResourceEvaluations	array<object>	A matriz que contém os resultados da avaliação de conformidade.
	array<object>	As informações sobre os resultados da avaliação de conformidade retornadas.
ResourceLogicalId	string	O ID lógico do recurso. Nota Se o parâmetro da solicitação estiver vazio, ele será gerado automaticamente com base no valor Base64 de `ResourceProperties`.	ResourceLogicId-test
ResourceType	string	O tipo do recurso.	ACS::ECS::Instance
Rules	array<object>	As regras de avaliação.
	object	As regras de avaliação.
Identifier	string	The identifier of the rule.	ecs-instance-deletion-protection-enabled
ComplianceType	string	The compliance type of the resource that was evaluated by using the evaluation rule. Valid values: COMPLIANT: The resource is evaluated as compliant. NON_COMPLIANT: The resource is evaluated as non-compliant. NOT_APPLICABLE: The rule does not apply to the resource.	NON_COMPLIANT
Annotation	string	The reason why the resource was evaluated as incompliant.	{\"configuration\":\"false\",\"desiredValue\":\"True\",\"operator\":\"StringEquals\",\"property\":\"$.DeletionProtection\"}
HelpUrl	string	The URL of the topic that describes how the managed rule remediates the non-compliant configurations.	https://example.aliyundoc.com

Para obter mais informações, consulte Parâmetros comuns.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "129ECF1C-7897-1131-BD0F-4B588AC05400",
  "ResourceEvaluations": [
    {
      "ResourceLogicalId": "ResourceLogicId-test",
      "ResourceType": "ACS::ECS::Instance",
      "Rules": [
        {
          "Identifier": "ecs-instance-deletion-protection-enabled",
          "ComplianceType": "NON_COMPLIANT",
          "Annotation": "{\\\"configuration\\\":\\\"false\\\",\\\"desiredValue\\\":\\\"True\\\",\\\"operator\\\":\\\"StringEquals\\\",\\\"property\\\":\\\"$.DeletionProtection\\\"}",
          "HelpUrl": "https://example.aliyundoc.com"
        }
      ]
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.