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

Consulta los detalles de una regla especificada.

Descripción de la operación

Este tema proporciona un ejemplo de cómo consultar los detalles de la regla cr-7f7d626622af0041****.

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

get

*Rule

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ConfigRuleId	string	Sí	El ID de la regla. Para obtener más información, consulte ListConfigRules.	cr-7f7d626622af0041****
Tag `deprecated`	array<object>	No	Las etiquetas del recurso. Este parámetro está obsoleto y no tiene efecto. Puede agregar un máximo de 20 etiquetas a un recurso.
	object	No	Las etiquetas del recurso.
Key	string	No	La clave de etiqueta del recurso. Puede agregar un máximo de 20 claves de etiqueta a un recurso.	key-1
Value	string	No	El valor de etiqueta del recurso. Puede agregar un máximo de 20 valores de etiqueta a un recurso.	value-1

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
ConfigRule	object	Los detalles de la regla.
AccountId	integer	El ID de la cuenta de Alibaba Cloud a la que pertenece la regla.	120886317861****
Compliance	object	Las estadísticas de cumplimiento de la regla.
ComplianceType	string	El resultado de la evaluación de cumplimiento. Valores válidos: COMPLIANT: El recurso cumple con la normativa. NON_COMPLIANT: El recurso no cumple con la normativa. NOT_APPLICABLE: La regla no se aplica al recurso. INSUFFICIENT_DATA: No hay datos disponibles.	NON_COMPLIANT
Count	integer	El número de recursos evaluados según el resultado de cumplimiento.	3
ConfigRuleArn	string	El nombre de recurso de Alibaba Cloud (ARN) de la regla.	acs:config::100931896542**:rule/cr-7f7d626622af0041**
ConfigRuleEvaluationStatus	object	El estado de ejecución de la regla.
FirstActivatedTimestamp	integer	La marca de tiempo cuando se activó la regla por primera vez. Unidad: milisegundos.	1624932221993
FirstEvaluationStarted	boolean	Indica si la regla se ha evaluado. Valores válidos: true: La regla se ha evaluado. false: La regla no se ha evaluado.	true
LastErrorCode	string	El código de error devuelto en la última ejecución fallida de la regla.	TimeOut
LastErrorMessage	string	El mensaje de error devuelto en la última ejecución fallida de la regla.	Time out
LastFailedEvaluationTimestamp	integer	La marca de tiempo cuando finalizó la última evaluación fallida de la regla. Unidad: milisegundos.	1614687022000
LastFailedInvocationTimestamp	integer	La marca de tiempo cuando inició la última invocación fallida de la regla. Unidad: milisegundos.	1614687022000
LastSuccessfulEvaluationTimestamp	integer	La marca de tiempo cuando finalizó la última evaluación exitosa de la regla. Unidad: milisegundos.	1624932227486
LastSuccessfulInvocationTimestamp	integer	La marca de tiempo cuando inició la última invocación exitosa de la regla. Unidad: milisegundos.	1624932227476
ConfigRuleId	string	El ID de la regla.	cr-7f7d626622af0041****
ConfigRuleName	string	El nombre de la regla.	RAM用户开启MFA
ConfigRuleState	string	El estado de la regla. Valores válidos: ACTIVE: La regla está habilitada. DELETING: La regla se está eliminando. EVALUATING: La regla se está utilizando para evaluar configuraciones de recursos. INACTIVE: La regla está deshabilitada.	ACTIVE
ConfigRuleTriggerTypes	string	El tipo de activador de la regla. Valores válidos: ConfigurationItemChangeNotification: La regla se activa por cambios en la configuración. ScheduledNotification: La regla se activa periódicamente.	ConfigurationItemChangeNotification
CreateBy	object	La información sobre el creador de la regla.
CompliancePackId	string	El ID del paquete de cumplimiento.	cp-541e626622af008****
CompliancePackName	string	El nombre del paquete de cumplimiento.	OSS合规基线
CreatorId	string	El ID de la cuenta de Alibaba Cloud que se utilizó para crear la regla.	100931896542****
CreatorName	string	El nombre del creador.	Alice
CreateTimestamp	integer	La marca de tiempo cuando se creó la regla. Unidad: milisegundos.	1604684022000
Description	string	La descripción de la regla.	RAM用户开启MFA，视为“合规”
ExcludeRegionIdsScope	string	Los ID de las regiones donde no se aplica la regla. La regla no evalúa recursos en estas regiones. Separe varios ID de región con una coma (,).	cn-hangzhou
ExcludeResourceGroupIdsScope	string	Los ID de los grupos de recursos donde no se aplica la regla. La regla no evalúa recursos en estos grupos de recursos. Separe varios ID de grupo de recursos con una coma (,).	rg-aekzdibsjjc****
ExcludeResourceIdsScope	string	Los ID de los recursos que no son evaluados por la regla. Separe varios ID de recursos con una coma (,).	23642660635687****
ExcludeTagsScope	array<object>	Las etiquetas de los recursos que no son evaluados por la regla.
	object	Las etiquetas de los recursos que no son evaluados por la regla.
TagKey	string	La clave de la etiqueta.	key-2
TagValue	string	El valor de la etiqueta.	value-2
InputParameters	object	Los parámetros de entrada de la regla.
ManagedRule	object	Los detalles de la regla administrada.
CompulsoryInputParameterDetails	object	Los detalles de los parámetros de entrada obligatorios de la regla administrada.	{}
Description	string	La descripción de la regla administrada.	ECS磁盘未因欠费或安全等原因而被锁定，视为“合规”
Identifier	string	El identificador de la regla administrada.	ram-user-mfa-check
Labels	array	La lista de etiquetas de la regla.
	string	La etiqueta de la regla administrada.	["RAM","User"]
ManagedRuleName	string	El nombre de la regla administrada.	RAM用户开启MFA
OptionalInputParameterDetails	object	Los detalles de los parámetros de entrada opcionales de la regla administrada.	{}
SourceDetails	array<object>	Los detalles del origen de la regla administrada.
	object	Los detalles del origen de la regla administrada.
EventSource	string	El origen del evento. Nota Solo se admiten eventos de Cloud Config. El valor es aliyun.config.	aliyun.config
MaximumExecutionFrequency	string	La frecuencia de ejecución de la regla. Valores válidos: One_Hour: 1 hora. Three_Hours: 3 horas. Six_Hours: 6 horas. Twelve_Hours: 12 horas. TwentyFour_Hours: 24 horas. Nota Este parámetro se devuelve solo cuando la regla se activa periódicamente.	One_Hour
MessageType	string	El tipo de activador de la regla. Valores válidos: ConfigurationItemChangeNotification: La regla se activa por cambios en la configuración. ScheduledNotification: La regla se activa periódicamente.	ConfigurationItemChangeNotification
MaximumExecutionFrequency	string	La frecuencia de ejecución de la regla. Valores válidos: One_Hour: 1 hora. Three_Hours: 3 horas. Six_Hours: 6 horas. Twelve_Hours: 12 horas. TwentyFour_Hours: 24 horas. Nota Este parámetro se devuelve solo cuando la regla se activa periódicamente.	One_Hour
ModifiedTimestamp	integer	La marca de tiempo cuando se actualizó la regla por última vez. Unidad: milisegundos.	1614687022000
RegionIdsScope	string	Los ID de las regiones donde se aplica la regla. La regla evalúa solo recursos en estas regiones.	global
ResourceGroupIdsScope	string	Los ID de los grupos de recursos donde se aplica la regla. La regla evalúa solo recursos en estos grupos de recursos.	rg-aekzdibsjjc****
ResourceIdsScope	string	Los ID de los recursos que son evaluados por la regla. Separe varios ID de recursos con una coma (,).	eip-8vbf3x310fn56ijfd****
ResourceTypesScope	string	Los tipos de recursos que son evaluados por la regla.	ACS::RAM::User
RiskLevel	integer	El nivel de riesgo de la regla. Valores válidos: 1: alto 2: medio 3: bajo	1
Scope	object	El alcance efectivo de la regla.
ComplianceResourceTypes	array	La lista de tipos de recursos que evalúa la regla. También puede consultar esta información en el campo ResourceTypesScope.
	string	El tipo de recurso que evalúa la regla.	ACS::RAM::User
Source	object	El origen de la regla.
Identifier	string	El identificador de la regla. Si la regla es una regla administrada, el valor de este parámetro es el identificador de la regla administrada. Si la regla es una regla personalizada, el valor de este parámetro es el ARN de la función.	acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/specific-config
Owner	string	El propietario de la regla. Valores válidos: CUSTOM_FC: una regla personalizada. ALIYUN: una regla administrada.	ALIYUN
SourceDetails	array<object>	Los detalles del origen.
	object	Los detalles del origen.
EventSource	string	El origen del evento. Nota Solo se admiten eventos de Cloud Config. El valor es aliyun.config.	aliyun.config
MaximumExecutionFrequency	string	La frecuencia de ejecución de la regla. Valores válidos: One_Hour: 1 hora. Three_Hours: 3 horas. Six_Hours: 6 horas. Twelve_Hours: 12 horas. TwentyFour_Hours: 24 horas. Nota Este parámetro se devuelve solo cuando la regla se activa periódicamente.	One_Hour
MessageType	string	El tipo de activador de la regla. Valores válidos: ConfigurationItemChangeNotification: La regla se activa por cambios en la configuración. ScheduledNotification: La regla se activa periódicamente.	ConfigurationItemChangeNotification
TagKeyLogicScope	string	Este parámetro no se devuelve para reglas creadas mediante el parámetro `TagsScope`. Este parámetro se devuelve para reglas creadas mediante el parámetro obsoleto TagKeyScope. No se recomienda utilizar el parámetro `TagKeyScope`. Por ejemplo, si `TagKeyScope` se establece en `ECS,OSS` y este parámetro se establece en `AND`, la regla se aplica solo a recursos que tienen tanto la etiqueta `ECS` como la etiqueta `OSS`. Valores válidos: AND OR	OR
TagKeyScope `deprecated`	string	Este parámetro está obsoleto. Utilice el parámetro `TagsScope` en su lugar. La regla se aplica solo a recursos con la etiqueta especificada. Nota Los parámetros `TagKeyScope` y `TagValueScope` se devuelven al mismo tiempo.	RAM
TagValueScope `deprecated`	string	Este parámetro está obsoleto. Utilice el parámetro `TagsScope` en su lugar. La regla se aplica solo a recursos con la etiqueta especificada. Nota Los parámetros `TagKeyScope` y `TagValueScope` se devuelven al mismo tiempo.	MFA
TagsScope	array<object>	El alcance basado en etiquetas.
	object	Las etiquetas que definen el alcance.
TagKey	string	La clave de la etiqueta.	key-1
TagValue	string	El valor de la etiqueta.	value-1
Tags	array<object>	Las etiquetas del recurso.
	object	Las etiquetas del recurso.
TagKey	string	La clave de la etiqueta.	key-1
TagValue	string	El valor de la etiqueta.	value-1
ResourceNameScope	string	La regla evalúa solo recursos que tienen los nombres especificados.	i-xxx
ExtendContent	string	El contenido extendido. Este parámetro se utiliza solo para especificar la hora de activación de una regla que se activa en un ciclo de 24 horas.	{"fixedHour":"12"}
RequestId	string	El ID de la solicitud.	811234F4-C3AB-4D15-B90B-F55016D1B5AA

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
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.

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.