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

Consulta los detalles de las plantillas de informes de cumplimiento en lotes.

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

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
NextToken	string	No	Si la respuesta se trunca, utilice NextToken para enviar otra solicitud y obtener los resultados posteriores al punto de truncamiento.	IWBjqMYSy0is7zSMGu16****
MaxResults	integer	No	El número de entradas que se devolverán por página. Valor predeterminado: 20.	20
Keyword	string	No	La palabra clave para su búsqueda. Puede realizar una consulta difusa sobre el ID de la plantilla, el nombre de la plantilla o la descripción de la plantilla.	test-description

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	8195B664-9565-4685-89AC-8B5F04B44B92
TotalCount	integer	El número total de plantillas.	7
MaxResults	integer	El número máximo de entradas que se devolverán por página. Valores válidos: de 1 a 50. Valor predeterminado: 20.	20
NextToken	string	Si la respuesta se trunca, utilice NextToken para enviar otra solicitud y obtener los resultados posteriores al punto de truncamiento.	aVCjqNaSy0Ps7zSMGu25****
ReportTemplateList	array<object>	La lista de plantillas de informes.
	array<object>
ReportTemplateId	string	El ID de la plantilla de informe.	crt-xxx
ReportTemplateName	string	El nombre de la plantilla de informe.	test-name
ReportTemplateDescription	string	La descripción de la plantilla de informe.	test-description
ReportGranularity	string	La granularidad de agregación del informe. Desde la perspectiva de la cuenta de administración, se admiten las siguientes opciones: AllInOne: agrega todas las cuentas dentro del alcance de la plantilla en un solo informe. GroupByAggregator: genera informes por grupo de agregador. Se exporta como un único archivo comprimido. GroupByAccount: genera informes independientes para cada cuenta (valor predeterminado). Se exporta como un único archivo comprimido. Las cuentas miembro solo admiten GroupByAccount.	AllInOne
ReportFileFormats	string	El formato del informe. Solo se admite Excel.	excel
ReportLanguage	string	El idioma del informe. Valores válidos: zh-CN y en-US. Valor predeterminado: en-US.	en-US
SubscriptionFrequency	string	La frecuencia de suscripción del informe. Si se especifica este parámetro, debe ser una expresión cron con formato Quartz. El formato es: segundo minuto hora día mes día de la semana. Ejemplos comunes: Ejecutar diariamente a las 00:00: 0 0 0 * * ? Ejecutar cada lunes a las 15:30: 0 30 15 ? * MON Ejecutar el primer día de cada mes a las 02:00: 0 0 2 1 * ? Donde: "" significa cualquier valor. "?" significa que no hay un valor específico para el día o el día de la semana. "MON" significa lunes. Nota* Las horas están en UTC+8. Ajuste su expresión cron según su zona horaria local. Nota El sistema intenta ejecutar los informes a la hora programada, pero pueden producirse retrasos debido a la generación del informe. Cada plantilla puede activar como máximo una notificación por día. Nota En Quartz, los días de la semana se numeran comenzando desde el domingo: 1 = domingo, 2 = lunes, 3 = martes, 4 = miércoles, 5 = jueves, 6 = viernes, 7 = sábado.	0 0 13 * * ?
ReportScope	array<object>	Una matriz que define qué reglas aparecen en el informe de auditoría. Cada objeto ReportScope utiliza lógica OR (lógica aditiva). Nota Por ejemplo, si la matriz tiene dos elementos —el primero especifica el RuleId cr-1 y el segundo especifica el RuleId cr-2— entonces el informe cubre tanto cr-1 como cr-2.
	object	Una definición de alcance del informe.
Key	string	La clave para el alcance del informe. Valores admitidos: AggregatorId CompliancePackId RuleId	RuleId
Value	string	El valor para el alcance del informe. Para múltiples valores del mismo tipo —como varios ID de regla— sepárelos con comas (,).	cr-1,cr-2
MatchType	string	La lógica de coincidencia. Solo se admite In.	In

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "8195B664-9565-4685-89AC-8B5F04B44B92",
  "TotalCount": 7,
  "MaxResults": 20,
  "NextToken": "aVCjqNaSy0Ps7zSMGu25****",
  "ReportTemplateList": [
    {
      "ReportTemplateId": "crt-xxx",
      "ReportTemplateName": "test-name",
      "ReportTemplateDescription": "test-description",
      "ReportGranularity": "AllInOne",
      "ReportFileFormats": "excel",
      "ReportLanguage": "en-US",
      "SubscriptionFrequency": "0 0 13 * * ?",
      "ReportScope": [
        {
          "Key": "RuleId",
          "Value": "cr-1,cr-2",
          "MatchType": "In"
        }
      ]
    }
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	ReportTemplateNotExist	Report template does not exist or invalid.	Report template does not exist, please check the input ReportTemplateId
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.