GetConfigRule - - Centre de documentation Alibaba Cloud

Consulte les détails d'une règle spécifiée.

Description de l'opération

Cette rubrique fournit un exemple montrant comment consulter les détails de la règle cr-7f7d626622af0041****.

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

get

*Rule

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ConfigRuleId	string	Oui	L'identifiant de la règle.	cr-7f7d626622af0041****
Tag `deprecated`	array<object>	Non	Les balises de la ressource. Ce paramètre est obsolète et n'a aucun effet. Vous pouvez ajouter un maximum de 20 balises à une ressource.
	object	Non	Les balises de la ressource.
Key	string	Non	La clé de balise de la ressource. Vous pouvez ajouter un maximum de 20 clés de balise à une ressource.	key-1
Value	string	Non	La valeur de la balise de la ressource. Vous pouvez ajouter un maximum de 20 valeurs de balise à une ressource.	value-1

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

Éléments de réponse

Élément	Type	Description	Exemple
	object
ConfigRule	object	Les détails de la règle.
AccountId	integer	L'identifiant du compte Alibaba Cloud auquel appartient la règle.	120886317861****
Compliance	object	Les statistiques de conformité de la règle.
ComplianceType	string	The compliance evaluation result. Valid values: COMPLIANT: The resource is compliant. NON_COMPLIANT: The resource is non-compliant. NOT_APPLICABLE: The rule does not apply to the resource. INSUFFICIENT_DATA: No data is available.	NON_COMPLIANT
Count	integer	The number of resources that are evaluated based on the compliance result.	3
ConfigRuleArn	string	L'Alibaba Cloud Resource Name (ARN) de la règle.	acs:config::100931896542**:rule/cr-7f7d626622af0041**
ConfigRuleEvaluationStatus	object	L'état d'exécution de la règle.
FirstActivatedTimestamp	integer	The timestamp when the rule was first activated. Unit: milliseconds.	1624932221993
FirstEvaluationStarted	boolean	Indicates whether the rule has been evaluated. Valid values: true: The rule has been evaluated. false: The rule has not been evaluated.	true
LastErrorCode	string	The error code returned for the last failed execution of the rule.	TimeOut
LastErrorMessage	string	The error message returned for the last failed execution of the rule.	Time out
LastFailedEvaluationTimestamp	integer	The timestamp when the last failed evaluation of the rule ended. Unit: milliseconds.	1614687022000
LastFailedInvocationTimestamp	integer	The timestamp when the last failed invocation of the rule started. Unit: milliseconds.	1614687022000
LastSuccessfulEvaluationTimestamp	integer	The timestamp when the last successful evaluation of the rule ended. Unit: milliseconds.	1624932227486
LastSuccessfulInvocationTimestamp	integer	The timestamp when the last successful invocation of the rule started. Unit: milliseconds.	1624932227476
ConfigRuleId	string	L'identifiant de la règle.	cr-7f7d626622af0041****
ConfigRuleName	string	Le nom de la règle.	Activation de l'authentification MFA pour les utilisateurs RAM
ConfigRuleState	string	L'état de la règle. Valeurs valides : ACTIVE : La règle est activée. DELETING : La règle est en cours de suppression. EVALUATING : La règle est utilisée pour évaluer les configurations de ressources. INACTIVE : La règle est désactivée.	ACTIVE
ConfigRuleTriggerTypes	string	Le type de déclenchement de la règle. Valeurs valides : ConfigurationItemChangeNotification : La règle est déclenchée par des modifications de configuration. ScheduledNotification : La règle est déclenchée périodiquement.	ConfigurationItemChangeNotification
CreateBy	object	Les informations sur le créateur de la règle.
CompliancePackId	string	The ID of the compliance package.	cp-541e626622af008****
CompliancePackName	string	The name of the compliance package.	OSS合规基线
CreatorId	string	The ID of the Alibaba Cloud account that was used to create the rule.	100931896542****
CreatorName	string	The name of the creator.	Alice
CreateTimestamp	integer	L'horodatage de la création de la règle. Unité : millisecondes.	1604684022000
Description	string	La description de la règle.	L'activation de l'authentification MFA pour les utilisateurs RAM est considérée comme conforme
ExcludeRegionIdsScope	string	Les identifiants des régions où la règle ne s'applique pas. La règle n'évalue pas les ressources dans ces régions. Séparez les identifiants de région multiples par une virgule (,).	cn-hangzhou
ExcludeResourceGroupIdsScope	string	Les identifiants des groupes de ressources où la règle ne s'applique pas. La règle n'évalue pas les ressources dans ces groupes de ressources. Séparez les identifiants de groupe de ressources multiples par une virgule (,).	rg-aekzdibsjjc****
ExcludeResourceIdsScope	string	Les identifiants des ressources qui ne sont pas évaluées par la règle. Séparez les identifiants de ressource multiples par une virgule (,).	23642660635687****
ExcludeTagsScope	array<object>	Les balises des ressources qui ne sont pas évaluées par la règle.
	object	Les balises des ressources qui ne sont pas évaluées par la règle.
TagKey	string	The tag key.	key-2
TagValue	string	The tag value.	value-2
InputParameters	object	Les paramètres d'entrée de la règle.
ManagedRule	object	Les détails de la règle gérée.
CompulsoryInputParameterDetails	object	The details of the required input parameters of the managed rule.	{}
Description	string	The description of the managed rule.	ECS磁盘未因欠费或安全等原因而被锁定，视为“合规”。
Identifier	string	The identifier of the managed rule.	ram-user-mfa-check
Labels	array	The list of rule labels.
	string	The label of the managed rule.	["RAM","User"]
ManagedRuleName	string	The name of the managed rule.	RAM用户开启MFA
OptionalInputParameterDetails	object	The details of the optional input parameters of the managed rule.	{}
SourceDetails	array<object>	The source details of the managed rule.
	object	The source details of the managed rule.
EventSource	string	The event source. Remarque Only Cloud Config events are supported. The value is aliyun.config.	aliyun.config
MaximumExecutionFrequency	string	The execution frequency of the rule. Valid values: One_Hour: 1 hour. Three_Hours: 3 hours. Six_Hours: 6 hours. Twelve_Hours: 12 hours. TwentyFour_Hours: 24 hours. Remarque This parameter is returned only when the rule is triggered periodically.	One_Hour
MessageType	string	The trigger type of the rule. Valid values: ConfigurationItemChangeNotification: The rule is triggered by configuration changes. ScheduledNotification: The rule is triggered periodically.	ConfigurationItemChangeNotification
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. Remarque Ce paramètre est renvoyé uniquement lorsque la règle est déclenchée périodiquement.	One_Hour
ModifiedTimestamp	integer	L'horodatage de la dernière mise à jour de la règle. Unité : millisecondes.	1614687022000
RegionIdsScope	string	Les identifiants des régions où la règle s'applique. La règle évalue uniquement les ressources dans ces régions.	global
ResourceGroupIdsScope	string	Les identifiants des groupes de ressources où la règle s'applique. La règle évalue uniquement les ressources dans ces groupes de ressources.	rg-aekzdibsjjc****
ResourceIdsScope	string	Les identifiants des ressources évaluées par la règle. Séparez les identifiants de ressource multiples par une virgule (,).	eip-8vbf3x310fn56ijfd****
ResourceTypesScope	string	Les types de ressources évaluées par la règle.	ACS::RAM::User
RiskLevel	integer	Le niveau de risque de la règle. Valeurs valides :	1
Scope	object	La portée effective de la règle.
ComplianceResourceTypes	array	The list of resource types that are evaluated by the rule. You can also view this information in the ResourceTypesScope field.
	string	The type of the resource that is evaluated by the rule.	ACS::RAM::User
Source	object	La source de la règle.
Identifier	string	The identifier of the rule. If the rule is a managed rule, the value of this parameter is the identifier of the managed rule. If the rule is a custom rule, the value of this parameter is the ARN of the function.	acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/specific-config
Owner	string	The owner of the rule. Valid values: CUSTOM_FC: a custom rule. ALIYUN: a managed rule.	ALIYUN
SourceDetails	array<object>	The source details.
	object	The source details.
EventSource	string	The event source. Remarque Only Cloud Config events are supported. The value is aliyun.config.	aliyun.config
MaximumExecutionFrequency	string	The execution frequency of the rule. Valid values: One_Hour: 1 hour. Three_Hours: 3 hours. Six_Hours: 6 hours. Twelve_Hours: 12 hours. TwentyFour_Hours: 24 hours. Remarque This parameter is returned only when the rule is triggered periodically.	One_Hour
MessageType	string	The trigger type of the rule. Valid values: ConfigurationItemChangeNotification: The rule is triggered by configuration changes. ScheduledNotification: The rule is triggered periodically.	ConfigurationItemChangeNotification
TagKeyLogicScope	string	Ce paramètre n'est pas renvoyé pour les règles créées à l'aide du paramètre TagsScope. Ce paramètre est renvoyé pour les règles créées à l'aide du paramètre obsolète TagKeyScope. Nous vous déconseillons d'utiliser le paramètre TagKeyScope. Par exemple, si 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 qui possèdent à la fois les balises ECS et OSS. Valeurs valides : AND OR	OR
TagKeyScope `deprecated`	string	Ce paramètre est obsolète. Utilisez plutôt le paramètre TagsScope. La règle s'applique uniquement aux ressources portant la balise spécifiée. Remarque Les paramètres TagKeyScope et TagValueScope sont renvoyés simultanément.	RAM
TagValueScope `deprecated`	string	Ce paramètre est obsolète. Utilisez plutôt le paramètre `TagsScope`. La règle s'applique uniquement aux ressources portant la balise spécifiée. Remarque Les paramètres `TagKeyScope` et `TagValueScope` sont renvoyés en même temps.	MFA
TagsScope	array<object>	La portée basée sur les balises.
	object	Les balises qui définissent la portée.
TagKey	string	The tag key.	key-1
TagValue	string	The tag value.	value-1
Tags	array<object>	Les balises de la ressource.
	object	Les balises de la ressource.
TagKey	string	The tag key.	key-1
TagValue	string	The tag value.	value-1
ResourceNameScope	string	La règle évalue uniquement les ressources qui portent les noms spécifiés.	i-xxx
ExtendContent	string	Le contenu étendu. Ce paramètre est utilisé uniquement pour spécifier l'heure de déclenchement d'une règle qui se déclenche sur un cycle de 24 heures.	{"fixedHour":"12"}
RequestId	string	L'identifiant de la requête.	811234F4-C3AB-4D15-B90B-F55016D1B5AA

Exemples

JSON format

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

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	ConfigRuleNotExists	The ConfigRule does not exist.	The rule does not exist.
400	NoPermission	You are not authorized to perform this operation.	You are not authorized to perform this operation.
404	AccountNotExisted	Your account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	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.