GetAggregateResourceComplianceByConfigRule - Cloud Config - Centro de documentación de Alibaba Cloud

Descripción de la operación

Este tema proporciona un ejemplo sobre cómo consultar los resultados de evaluación de cumplimiento de recursos mediante la regla cr-d369626622af008e**** en el grupo de cuentas ca-a4e5626622af0079****. El resultado devuelto muestra que la regla evaluó 10 recursos, de los cuales 5 son compatibles.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

config:GetAggregateResourceComplianceByConfigRule

get

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ComplianceType	string	No	El resultado de la evaluación de cumplimiento. Valores válidos: COMPLIANT: Compatible. NON_COMPLIANT: No compatible. NOT_APPLICABLE: No aplicable. INSUFFICIENT_DATA: Sin datos. Valores válidos: NOT_APPLICABLE : No aplicable. COMPLIANT : Compatible. NON_COMPLIANT : No compatible. INSUFFICIENT_DATA : Sin datos. IGNORED : Ignorado.	COMPLIANT
ConfigRuleId	string	Sí	El ID de la regla. Para obtener información sobre cómo obtener un ID de regla, consulte ListAggregateConfigRules.	cr-d369626622af008e****
AggregatorId	string	Sí	El ID del grupo de cuentas. Para obtener información sobre cómo obtener un ID de grupo de cuentas, consulte ListAggregators.	ca-a4e5626622af0079****
ResourceAccountId	integer	No	El ID de la cuenta de Alibaba Cloud del propietario del recurso en el grupo de cuentas. Nota Especifique ResourceAccountId o ResourceOwnerId. Se recomienda utilizar este parámetro.	100931896542****

Para obtener más información sobre los parámetros de solicitud comunes, consulte Parámetros comunes.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Ninguna.
ComplianceResult	object	Los resultados de la evaluación de cumplimiento de los recursos.
TotalCount	integer	El número total de recursos evaluados por la regla.	10
Compliances	array<object>	Los resultados de la evaluación de cumplimiento de los recursos.
	object	Ninguna.
ComplianceType	string	El resultado de la evaluación de cumplimiento. Valores válidos: COMPLIANT: Compatible. NON_COMPLIANT: No compatible. NOT_APPLICABLE: No aplicable. INSUFFICIENT_DATA: Sin datos.	COMPLIANT
Count	integer	El número de recursos. Por ejemplo, si `ComplianceType` se establece en `COMPLIANT`, este parámetro indica el número de recursos compatibles.	5
RequestId	string	El ID de la solicitud.	23306AB1-34E0-468F-BD7B-68D8AEAB754C

Ejemplos

Respuesta exitosa

JSON Formato

{
  "ComplianceResult": {
    "TotalCount": 5,
    "Compliances": [
      {
        "ComplianceType": "COMPLIANT",
        "Count": 3
      }
    ]
  },
  "RequestId": "23306AB1-34E0-468F-BD7B-68D8AEAB754C"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
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 error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.