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

Consulta os detalhes de uma regra especificada em um grupo de contas especificado.

Descrição da operação

Este tópico fornece um exemplo de como consultar os detalhes da regra cr-7f7d626622af0041**** no grupo de contas ca-7f00626622af0041****.

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:GetAggregateConfigRule

get

*AggregateConfigRule.

acs:config:*:{#accountId}:aggregateconfigrule/{#ConfigRuleId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ConfigRuleId	string	Sim	O ID da regra. Para obter informações sobre como obter um ID de regra, consulte ListAggregateConfigRules.	cr-7f7d626622af0041****
AggregatorId	string	Sim	O ID do grupo de contas. Para obter informações sobre como obter um ID de grupo de contas, consulte ListAggregators.	ca-7f00626622af0041****
Tag `deprecated`	array<object>	Não	As tags. Este parâmetro está obsoleto e não tem efeito.
	object	Não	As tags do recurso. Este parâmetro está obsoleto e não tem efeito. É possível adicionar no máximo 20 tags.
Key	string	Não	A chave da tag do recurso. É possível adicionar no máximo 20 chaves de tag.	key-1
Value	string	Não	O valor da tag do recurso. É possível adicionar no máximo 20 valores de tag.	value-1

Para obter informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Nenhum.
RequestId	string	O ID da solicitação.	811234F4-C3AB-4D15-B90B-F55016D1B5AA
ConfigRule	object	A lista de regras.
RiskLevel	integer	O nível de risco da regra. Valores válidos: 1: alto risco. 2: risco médio. 3: baixo risco.	1
InputParameters	object	As informações dos parâmetros da regra.	{"tag1Key":"ECS","tag1Value":"test"}
Source	object	As informações da origem da regra.
SourceDetails	array<object>	Os detalhes da origem da regra.
	object	Nenhum.
MessageType	string	O mecanismo de acionamento da regra. Valores válidos: ConfigurationItemChangeNotification: alteração de configuração. ScheduledNotification: execução periódica.	ConfigurationItemChangeNotification
EventSource	string	A origem do evento. Nota Atualmente, apenas eventos do Cloud Config são suportados: aliyun.config.	aliyun.config
MaximumExecutionFrequency	string	A frequência de execução da regra. Valores válidos: One_Hour: 1 hora. Three_Hours: 3 horas. Six_Hours: 6 horas. Twelve_Hours: 12 horas. TwentyFour_Hours: 24 horas.	One_Hour
Owner	string	O proprietário da origem da regra. Valores válidos: CUSTOM_FC: regra personalizada. ALIYUN: modelo de regra.	ALIYUN
Identifier	string	O identificador da regra. Se a regra for baseada em um modelo de regra, este parâmetro especifica o identificador do modelo de regra. Se a regra for uma regra personalizada, este parâmetro especifica o ARN da função.	acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/specific-config
ConfigRuleState	string	O status de execução da regra. Valores válidos: ACTIVE: ativa. DELETING: sendo excluída. EVALUATING: sendo avaliada. INACTIVE: desativada.	ACTIVE
MaximumExecutionFrequency	string	A frequência de execução da regra. Valores válidos: One_Hour: 1 hora. Three_Hours: 3 horas. Six_Hours: 6 horas. Twelve_Hours: 12 horas. TwentyFour_Hours: 24 horas.	One_Hour
ManagedRule	object	Os detalhes do modelo de regra.
SourceDetails	array<object>	Os detalhes da origem do modelo de regra.
	object	Os detalhes da origem da regra.
MessageType	string	O mecanismo de acionamento da regra. Valores válidos: ConfigurationItemChangeNotification: alteração de configuração. ScheduledNotification: execução periódica.	ConfigurationItemChangeNotification
EventSource	string	A origem do evento. Nota Atualmente, apenas eventos do Cloud Config são suportados: aliyun.config.	aliyun.config
MaximumExecutionFrequency	string	A frequência de execução da regra. Valores válidos: One_Hour: 1 hora. Three_Hours: 3 horas. Six_Hours: 6 horas. Twelve_Hours: 12 horas. TwentyFour_Hours: 24 horas.	One_Hour
Description	string	A descrição do modelo de regra.	Um disco ECS que não está bloqueado devido a pagamentos atrasados ou motivos de segurança é considerado "conforme"
Labels	array	A lista de tags do modelo de regra.
	string	A tag do modelo de regra.	["RAM","USer"]
Identifier	string	O identificador do modelo de regra.	ram-user-mfa-check
OptionalInputParameterDetails	object	Os detalhes dos parâmetros opcionais do modelo de regra.	{}
ManagedRuleName	string	O nome do modelo de regra.	MFA ativado para usuários RAM
CompulsoryInputParameterDetails	object	Os detalhes dos parâmetros obrigatórios do modelo de regra.	{}
ConfigRuleArn	string	O ARN do modelo de regra.	acs:config::100931896542**:rule/cr-7f7d626622af0041**
Description	string	A descrição do modelo de regra.	Se o MFA estiver ativado para usuários RAM, o recurso será considerado "conforme"
CreateBy	object	As informações sobre o criador da regra.
CompliancePackId	string	O ID do pacote de conformidade.	cp-541e626622af008****
AggregatorName	string	O nome do grupo de contas.	Test_Group
CompliancePackName	string	O nome do pacote de conformidade.	Linha de base de conformidade do OSS
CreatorName	string	O nome do criador da regra.	Alice
CreatorType	string	O tipo do criador da regra. Apenas `AGGREGATOR` (grupo de contas) é suportado.	AGGREGATOR
CreatorId	string	O ID da conta do criador da regra.	100931896542****
AggregatorId	string	O ID do grupo de contas.	ca-04b3fd170e340007****
ConfigRuleName	string	O nome da regra.	MFA ativado para usuários RAM
ConfigRuleEvaluationStatus	object	O status de execução da regra.
LastErrorCode	string	O código de erro da execução mais recente da regra.	TimeOut
LastSuccessfulEvaluationTimestamp	integer	O timestamp de término da invocação bem-sucedida mais recente da regra. Unidade: milissegundos.	1624932227486
FirstActivatedTimestamp	integer	O timestamp em que a regra foi ativada pela primeira vez. Este valor é um timestamp UNIX em milissegundos.	1624932221993
FirstEvaluationStarted	boolean	Indica se a regra foi avaliada. Valores válidos: true: A regra foi avaliada. false: A regra não foi avaliada.	true
LastSuccessfulInvocationTimestamp	integer	O timestamp de início da invocação bem-sucedida mais recente da regra. Unidade: milissegundos.	1624932227476
LastErrorMessage	string	A mensagem de erro da execução mais recente da regra.	tempo esgotado
LastFailedEvaluationTimestamp	integer	O timestamp de término da invocação com falha mais recente da regra. Unidade: milissegundos.	1614687022000
LastFailedInvocationTimestamp	integer	O timestamp de início da invocação com falha mais recente da regra. Unidade: milissegundos.	1614687022000
ConfigRuleId	string	O ID da regra.	cr-7f7d626622af0041****
ModifiedTimestamp	integer	O timestamp em que a regra foi atualizada pela última vez. Unidade: milissegundos.	1614687022000
CreateTimestamp	integer	O timestamp em que a regra foi criada. Unidade: milissegundos.	1604684022000
ResourceTypesScope	string	Os tipos de recursos avaliados pela regra.	ACS::RAM::User
ExcludeRegionIdsScope	string	Os IDs das regiões excluídas da avaliação da regra. A regra não avalia recursos nas regiões especificadas. Separe vários IDs de região com vírgulas (,).	cn-hangzhou
RegionIdsScope	string	O ID da região dos recursos que a regra avalia.	global
ExcludeResourceIdsScope	string	Os IDs dos recursos excluídos da avaliação da regra.	23642660635687****
ResourceIdsScope	string	Os IDs dos recursos aos quais a regra se aplica. Separe vários IDs de recurso com vírgulas (,).	eip-8vbf3x310fn56ijfd****
ResourceGroupIdsScope	string	O ID do grupo de recursos dos recursos que a regra avalia.	rg-aekzdibsjjc****
ExcludeResourceGroupIdsScope	string	Os IDs dos grupos de recursos excluídos da avaliação da regra. A regra não avalia recursos nos grupos de recursos especificados. Separe vários IDs de grupo de recursos com vírgulas (,).	rg-aekzdibsjjc****
TagKeyScope `deprecated`	string	[Descontinuado] Use o campo `TagsScope` em vez deste. A chave da tag dos recursos que a regra avalia.	RAM
TagValueScope `deprecated`	string	[Descontinuado] Use o campo `TagsScope` em vez deste. O valor da tag dos recursos que a regra avalia.	MFA
TagsScope	array<object>	O escopo de tags.
	object
TagKey	string	A chave da tag.	key-1
TagValue	string	O valor da tag.	value-1
ExcludeTagsScope	array<object>	O escopo de tags excluídas.
	object
TagKey	string	A chave da tag.	key-2
TagValue	string	O valor da tag.	value-2
ConfigRuleTriggerTypes	string	O mecanismo de acionamento da regra. Valores válidos: ConfigurationItemChangeNotification: alteração de configuração. ScheduledNotification: execução periódica.	ConfigurationItemChangeNotification
TagKeyLogicScope	string	Este campo não é retornado para regras criadas usando o parâmetro `TagsScope`. Este campo é usado para recuperar regras criadas usando o campo descontinuado `TagKeyScope` (não recomendado). Por exemplo, se o parâmetro `TagKeyScope` estiver definido como `ECS,OSS` e este parâmetro estiver definido como `AND`, a regra se aplicará apenas a recursos vinculados tanto à tag `ECS` quanto à tag `OSS`. Valores válidos: AND: E lógico. OR: OU lógico.	AND
FolderIdsScope	string	Os IDs das pastas do diretório de recursos. A regra se aplica apenas a recursos dentro das contas membro sob as pastas especificadas.	fd-ZtHsRH****
ExcludeFolderIdsScope	string	Os IDs das pastas do diretório de recursos excluídas da avaliação da regra. A regra não avalia recursos dentro das contas membro sob as pastas especificadas.	fd-pWmkqZ****
ExcludeAccountIdsScope	string	As contas membro excluídas da avaliação da regra. A regra não executa avaliação em recursos dentro das contas especificadas.	120886317861****
ResourceNameScope	string	O nome do recurso ao qual a regra se aplica.	i-xxx
Compliance	object	As estatísticas de conformidade da regra.
ComplianceType	string	O resultado de conformidade. Valores válidos: COMPLIANT: compatível. NON_COMPLIANT: não compatível. NOT_APPLICABLE: não aplicável. INSUFFICIENT_DATA: dados insuficientes.	NON_COMPLIANT
Count	integer	A contagem de recursos avaliados que correspondem ao resultado de conformidade.	3
AccountId	integer	O ID da conta Alibaba Cloud à qual a regra pertence.	120886317861****
ExtendContent	string	O conteúdo estendido. Atualmente, este parâmetro é usado apenas para definir o horário de acionamento para o acionamento periódico de 24 horas.	{"fixedHour":"12"}
Tags	array<object>	As tags do recurso.
	object	As tags do recurso.
TagKey	string	A chave da tag.	key-1
TagValue	string	O valor da tag.	value-1
AccountIdsScope	string	Os IDs das contas de membro às quais a regra se aplica. A regra entra em vigor apenas nos recursos dentro das contas de membro especificadas. Separe vários IDs de contas de membro com vírgulas (,).	120886317861****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "811234F4-C3AB-4D15-B90B-F55016D1B5AA",
  "ConfigRule": {
    "RiskLevel": 1,
    "InputParameters": {
      "tag1Key": "ECS",
      "tag1Value": "test"
    },
    "Source": {
      "SourceDetails": [
        {
          "MessageType": "ConfigurationItemChangeNotification",
          "EventSource": "aliyun.config",
          "MaximumExecutionFrequency": "One_Hour"
        }
      ],
      "Owner": "ALIYUN",
      "Identifier": "acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/specific-config"
    },
    "ConfigRuleState": "ACTIVE",
    "MaximumExecutionFrequency": "One_Hour",
    "ManagedRule": {
      "SourceDetails": [
        {
          "MessageType": "ConfigurationItemChangeNotification",
          "EventSource": "aliyun.config",
          "MaximumExecutionFrequency": "One_Hour"
        }
      ],
      "Description": "ECS磁盘未因欠费或安全等原因而被锁定，视为“合规”。",
      "Labels": [
        "[\"RAM\",\"USer\"]"
      ],
      "Identifier": "ram-user-mfa-check",
      "OptionalInputParameterDetails": {},
      "ManagedRuleName": "RAM用户开启MFA",
      "CompulsoryInputParameterDetails": {}
    },
    "ConfigRuleArn": "acs:config::100931896542****:rule/cr-7f7d626622af0041****",
    "Description": "RAM用户开启MFA，视为“合规”。",
    "CreateBy": {
      "CompliancePackId": "cp-541e626622af008****",
      "AggregatorName": "Test_Group",
      "CompliancePackName": "OSS合规基线",
      "CreatorName": "Alice",
      "CreatorType": "AGGREGATOR",
      "CreatorId": "100931896542****",
      "AggregatorId": "ca-04b3fd170e340007****"
    },
    "ConfigRuleName": "RAM用户开启MFA",
    "ConfigRuleEvaluationStatus": {
      "LastErrorCode": "TimeOut",
      "LastSuccessfulEvaluationTimestamp": 1624932227486,
      "FirstActivatedTimestamp": 1624932221993,
      "FirstEvaluationStarted": true,
      "LastSuccessfulInvocationTimestamp": 1624932227476,
      "LastErrorMessage": "time out",
      "LastFailedEvaluationTimestamp": 1614687022000,
      "LastFailedInvocationTimestamp": 1614687022000
    },
    "ConfigRuleId": "cr-7f7d626622af0041****",
    "ModifiedTimestamp": 1614687022000,
    "CreateTimestamp": 1604684022000,
    "ResourceTypesScope": "ACS::RAM::User",
    "ExcludeRegionIdsScope": "cn-hangzhou",
    "RegionIdsScope": "global",
    "ExcludeResourceIdsScope": "23642660635687****",
    "ResourceIdsScope": "eip-8vbf3x310fn56ijfd****\n",
    "ResourceGroupIdsScope": "rg-aekzdibsjjc****",
    "ExcludeResourceGroupIdsScope": "rg-aekzdibsjjc****",
    "TagKeyScope": "RAM",
    "TagValueScope": "MFA",
    "TagsScope": [
      {
        "TagKey": "key-1",
        "TagValue": "value-1"
      }
    ],
    "ExcludeTagsScope": [
      {
        "TagKey": "key-2",
        "TagValue": "value-2"
      }
    ],
    "ConfigRuleTriggerTypes": "ConfigurationItemChangeNotification",
    "TagKeyLogicScope": "AND",
    "FolderIdsScope": "fd-ZtHsRH****",
    "ExcludeFolderIdsScope": "fd-pWmkqZ****",
    "ExcludeAccountIdsScope": "120886317861****",
    "ResourceNameScope": "i-xxx",
    "Compliance": {
      "ComplianceType": "NON_COMPLIANT",
      "Count": 3
    },
    "AccountId": 0,
    "ExtendContent": "{\"fixedHour\":\"12\"}",
    "Tags": [
      {
        "TagKey": "key-1",
        "TagValue": "value-1"
      }
    ],
    "AccountIdsScope": "120886317861****\n"
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	ConfigRuleNotExists	The ConfigRule does not exist.
400	NoPermission	You are not authorized to perform this operation.
400	Invalid.AggregatorId.Value	The specified AggregatorId is invalid.
404	AccountNotExisted	Your account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.