GetAggregateConfigRule - - Centre de documentation Alibaba Cloud

Consulte les détails d'une règle spécifiée dans un groupe de comptes spécifié.

Description de l'opération

Cette rubrique fournit un exemple montrant comment consulter les détails de la règle cr-7f7d626622af0041**** dans le groupe de comptes ca-7f00626622af0041****.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

config:GetAggregateConfigRule

get

*AggregateConfigRule.

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ConfigRuleId	string	Oui	L'identifiant de la règle. Pour plus d'informations sur la façon d'obtenir un identifiant de règle, consultez ListAggregateConfigRules.	cr-7f7d626622af0041****
AggregatorId	string	Oui	L'identifiant du groupe de comptes. Pour plus d'informations sur la façon d'obtenir un identifiant de groupe de comptes, consultez ListAggregators.	ca-7f00626622af0041****
Tag `deprecated`	array<object>	Non	Les balises. Ce paramètre est obsolète et n'a aucun effet.
	object	Non	Les balises de la ressource. Ce paramètre est obsolète et n'a aucun effet. Vous pouvez ajouter jusqu'à 20 balises.
Key	string	Non	La clé de balise de la ressource. Vous pouvez ajouter jusqu'à 20 clés de balise.	key-1
Value	string	Non	La valeur de balise de la ressource. Vous pouvez ajouter jusqu'à 20 valeurs de balise.	value-1

Pour plus d'informations sur les paramètres de requête courants, consultez Paramètres communs.

Éléments de réponse

Élément	Type	Description	Exemple
	object	Aucun.
RequestId	string	L'identifiant de la requête.	811234F4-C3AB-4D15-B90B-F55016D1B5AA
ConfigRule	object	La liste des règles.
RiskLevel	integer	Le niveau de risque de la règle. Valeurs valides : 1 : risque élevé. 2 : risque moyen. 3 : risque faible.	1
InputParameters	object	Les informations sur les paramètres de la règle.	{"tag1Key":"ECS","tag1Value":"test"}
Source	object	Les informations sur la source de la règle.
SourceDetails	array<object>	Les détails de la source de la règle.
	object	Aucun.
MessageType	string	Le mécanisme de déclenchement de la règle. Valeurs valides : ConfigurationItemChangeNotification : changement de configuration. ScheduledNotification : exécution périodique.	ConfigurationItemChangeNotification
EventSource	string	La source de l'événement. Remarque Actuellement, seuls les événements Cloud Config sont pris en charge : aliyun.config.	aliyun.config
MaximumExecutionFrequency	string	La fréquence d'exécution de la règle. Valeurs valides : One_Hour : 1 heure. Three_Hours : 3 heures. Six_Hours : 6 heures. Twelve_Hours : 12 heures. TwentyFour_Hours : 24 heures.	One_Hour
Owner	string	Le propriétaire de la source de la règle. Valeurs valides : CUSTOM_FC : règle personnalisée. ALIYUN : modèle de règle.	ALIYUN
Identifier	string	L'identifiant de la règle. Si la règle est basée sur un modèle de règle, ce paramètre spécifie l'identifiant du modèle de règle. Si la règle est une règle personnalisée, ce paramètre spécifie l'ARN de la fonction.	acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/specific-config
ConfigRuleState	string	L'état d'exécution de la règle. Valeurs valides : ACTIVE : active. DELETING : en cours de suppression. EVALUATING : en cours d'évaluation. INACTIVE : désactivée.	ACTIVE
MaximumExecutionFrequency	string	La fréquence d'exécution de la règle. Valeurs valides : One_Hour : 1 heure. Three_Hours : 3 heures. Six_Hours : 6 heures. Twelve_Hours : 12 heures. TwentyFour_Hours : 24 heures.	One_Hour
ManagedRule	object	Les détails du modèle de règle.
SourceDetails	array<object>	Les détails de la source du modèle de règle.
	object	Les détails de la source de la règle.
MessageType	string	Le mécanisme de déclenchement de la règle. Valeurs valides : ConfigurationItemChangeNotification : changement de configuration. ScheduledNotification : exécution périodique.	ConfigurationItemChangeNotification
EventSource	string	La source de l'événement. Remarque Actuellement, seuls les événements Cloud Config sont pris en charge : aliyun.config.	aliyun.config
MaximumExecutionFrequency	string	La fréquence d'exécution de la règle. Valeurs valides : One_Hour : 1 heure. Three_Hours : 3 heures. Six_Hours : 6 heures. Twelve_Hours : 12 heures. TwentyFour_Hours : 24 heures.	One_Hour
Description	string	La description du modèle de règle.	Un disque ECS qui n'est pas verrouillé en raison de paiements en retard ou pour des raisons de sécurité est considéré comme « conforme »
Labels	array	La liste des balises du modèle de règle.
	string	La balise du modèle de règle.	["RAM","Utilisateur"]
Identifier	string	L'identifiant du modèle de règle.	ram-user-mfa-check
OptionalInputParameterDetails	object	Les détails des paramètres facultatifs du modèle de règle.	{}
ManagedRuleName	string	Le nom du modèle de règle.	MFA activé pour les utilisateurs RAM
CompulsoryInputParameterDetails	object	Les détails des paramètres obligatoires du modèle de règle.	{}
ConfigRuleArn	string	L'ARN de la règle.	acs:config::100931896542**:rule/cr-7f7d626622af0041**
Description	string	La description du modèle de règle.	Si le MFA est activé pour les utilisateurs RAM, la ressource est considérée comme « conforme »
CreateBy	object	Les informations sur le créateur de la règle.
CompliancePackId	string	L'identifiant du package de conformité.	cp-541e626622af008****
AggregatorName	string	Le nom du groupe de comptes.	Groupe_test
CompliancePackName	string	Le nom du package de conformité.	Base de référence de conformité OSS
CreatorName	string	Le nom du créateur de la règle.	Alice
CreatorType	string	Le type du créateur de la règle. Seul AGGREGATOR (groupe de comptes) est pris en charge.	AGGREGATOR
CreatorId	string	L'identifiant du compte du créateur de la règle.	100931896542****
AggregatorId	string	L'identifiant du groupe de comptes.	ca-04b3fd170e340007****
ConfigRuleName	string	Le nom de la règle.	MFA activé pour les utilisateurs RAM
ConfigRuleEvaluationStatus	object	L'état d'évaluation de la règle.
LastErrorCode	string	Le code d'erreur de l'exécution la plus récente de la règle.	TimeOut
LastSuccessfulEvaluationTimestamp	integer	L'horodatage de fin de l'invocation de règle réussie la plus récente. Unité : millisecondes.	1624932227486
FirstActivatedTimestamp	integer	L'horodatage de la première activation de la règle. Cette valeur est un horodatage UNIX en millisecondes.	1624932221993
FirstEvaluationStarted	boolean	Indique si la règle a été évaluée. Valeurs valides : true : la règle a été évaluée. false : la règle n'a pas été évaluée.	true
LastSuccessfulInvocationTimestamp	integer	L'horodatage de début de l'invocation de règle réussie la plus récente. Unité : millisecondes.	1624932227476
LastErrorMessage	string	Le message d'erreur de l'exécution la plus récente de la règle.	délai d'attente dépassé
LastFailedEvaluationTimestamp	integer	L'horodatage de fin de l'invocation de règle échouée la plus récente. Unité : millisecondes.	1614687022000
LastFailedInvocationTimestamp	integer	L'horodatage de début de l'invocation de règle échouée la plus récente. Unité : millisecondes.	1614687022000
ConfigRuleId	string	L'identifiant de la règle.	cr-7f7d626622af0041****
ModifiedTimestamp	integer	L'horodatage de la dernière mise à jour de la règle. Unité : millisecondes.	1614687022000
CreateTimestamp	integer	L'horodatage de création de la règle. Unité : millisecondes.	1604684022000
ResourceTypesScope	string	Les types de ressources évalués par la règle.	ACS::RAM::User
ExcludeRegionIdsScope	string	Les identifiants de région exclus de l'évaluation de la règle. La règle n'évalue pas les ressources dans les régions spécifiées. Séparez les identifiants de région multiples par des virgules (,).	cn-hangzhou
RegionIdsScope	string	Les identifiants des régions des ressources évaluées par la règle.	global
ExcludeResourceIdsScope	string	Les identifiants des ressources exclus de l'évaluation de la règle.	23642660635687****
ResourceIdsScope	string	Les identifiants des ressources auxquels la règle s'applique. Séparez les identifiants de ressources multiples par des virgules (,).	eip-8vbf3x310fn56ijfd****
ResourceGroupIdsScope	string	L'identifiant du groupe de ressources des ressources évaluées par la règle.	rg-aekzdibsjjc****
ExcludeResourceGroupIdsScope	string	Les identifiants des groupes de ressources exclus de l'évaluation de la règle. La règle n'évalue pas les ressources des groupes de ressources spécifiés. Séparez les identifiants de groupes de ressources multiples par des virgules (,).	rg-aekzdibsjjc****
TagKeyScope `deprecated`	string	[Obsolète] Utilisez plutôt le champ TagsScope. La clé de balise des ressources évaluées par la règle.	RAM
TagValueScope `deprecated`	string	[Obsolète] Utilisez plutôt le champ TagsScope. La valeur de balise des ressources évaluées par la règle.	MFA
TagsScope	array<object>	La portée des balises.
	object
TagKey	string	La clé de balise.	key-1
TagValue	string	La valeur de balise.	value-1
ExcludeTagsScope	array<object>	La portée des balises exclues.
	object
TagKey	string	La clé de balise.	key-2
TagValue	string	La valeur de balise.	value-2
ConfigRuleTriggerTypes	string	Le mécanisme de déclenchement de la règle. Valeurs valides : ConfigurationItemChangeNotification : changement de configuration. ScheduledNotification : exécution périodique.	ConfigurationItemChangeNotification
TagKeyLogicScope	string	Ce champ n'est pas renvoyé pour les règles créées à l'aide du paramètre TagsScope. Ce champ est utilisé pour récupérer les règles créées à l'aide du champ obsolète TagKeyScope (non recommandé). Par exemple, si le paramètre TagKeyScope est défini sur ECS, OSS et que ce paramètre est défini sur AND, la règle s'applique uniquement aux ressources liées à la fois aux balises ECS et OSS. Valeurs valides : AND : ET logique. OR : OU logique.	AND
FolderIdsScope	string	Les identifiants des dossiers du répertoire de ressources. La règle s'applique uniquement aux ressources des comptes membres sous les dossiers spécifiés.	fd-ZtHsRH****
ExcludeFolderIdsScope	string	Les identifiants des dossiers du répertoire de ressources exclus de l'évaluation de la règle. La règle n'évalue pas les ressources des comptes membres sous les dossiers spécifiés.	fd-pWmkqZ****
ExcludeAccountIdsScope	string	Les identifiants des comptes membres exclus de l'évaluation de la règle. La règle n'effectue aucune évaluation sur les ressources des comptes spécifiés.	120886317861****
ResourceNameScope	string	Le nom de la ressource auquel la règle s'applique.	i-xxx
Compliance	object	Les statistiques de conformité de la règle.
ComplianceType	string	Le résultat de conformité. Valeurs valides : COMPLIANT : conforme. NON_COMPLIANT : non conforme. NOT_APPLICABLE : non applicable. INSUFFICIENT_DATA : données insuffisantes.	NON_COMPLIANT
Count	integer	Le nombre de ressources évaluées correspondant au résultat de conformité.	3
AccountId	integer	L'identifiant du compte Alibaba Cloud auquel la règle appartient.	120886317861****
ExtendContent	string	Le contenu étendu. Actuellement, ce paramètre est utilisé uniquement pour définir l'heure de déclenchement pour l'exécution périodique de 24 heures.	{"fixedHour":"12"}
Tags	array<object>	Les balises de ressources.
	object	Les balises de ressources.
TagKey	string	La clé de balise.	key-1
TagValue	string	La valeur de balise.	value-1
AccountIdsScope	string	Les identifiants des comptes membres auxquels la règle s'applique. La règle ne prend effet que sur les ressources au sein des comptes membres spécifiés. Séparez plusieurs identifiants de comptes membres par des virgules (,).	120886317861****

Exemples

JSON format

{
  "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": "Les disques ECS non verrouillés en raison d'impayés, de problèmes de sécurité ou d'autres motifs sont considérés comme « conformes »",
      "Labels": [
        "[\"RAM\",\"USer\"]"
      ],
      "Identifier": "ram-user-mfa-check",
      "OptionalInputParameterDetails": {},
      "ManagedRuleName": "MFA activé pour les utilisateurs RAM",
      "CompulsoryInputParameterDetails": {}
    },
    "ConfigRuleArn": "acs:config::100931896542****:rule/cr-7f7d626622af0041****",
    "Description": "MFA activé pour les utilisateurs RAM, considéré comme « conforme »",
    "CreateBy": {
      "CompliancePackId": "cp-541e626622af008****",
      "AggregatorName": "Test_Group",
      "CompliancePackName": "Référentiel de conformité OSS",
      "CreatorName": "Alice",
      "CreatorType": "AGGREGATOR",
      "CreatorId": "100931896542****",
      "AggregatorId": "ca-04b3fd170e340007****"
    },
    "ConfigRuleName": "MFA activé pour les utilisateurs RAM",
    "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****",
    "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"
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
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.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.