GetReportTemplate - Cloud Config: Central de Documentação do Alibaba Cloud

Obtém os detalhes de um modelo de relatório de conformidade.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ReportTemplateId	string	Sim	O ID do modelo de relatório.	crt-xxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
ReportTemplate	object	O modelo de relatório.
ReportTemplateId	string	O ID do modelo de relatório.	crt-xxx
ReportTemplateName	string	O nome do modelo de relatório.	test-name
SubscriptionFrequency	string	A frequência de assinatura do relatório. Se este campo não estiver vazio, ele contém uma expressão cron no formato Quartz que aciona notificações. O formato é: segundos minutos horas dia-do-mês mês dia-da-semana. Exemplos comuns incluem o seguinte: Executar diariamente às 00:00: 0 0 0 * * ? Executar toda segunda-feira às 15:30: 0 30 15 ? * MON Executar no primeiro dia de cada mês às 02:00: 0 0 2 1 * ? Onde: "" significa qualquer valor. "?" significa nenhum valor específico para o campo dia-do-mês ou dia-da-semana. MON significa segunda-feira. Nota* Os horários de acionamento estão em UTC+8. Ajuste sua expressão cron com base no seu fuso horário. Nota O sistema tenta acionar notificações o mais próximo possível do horário agendado. Podem ocorrer atrasos devido ao status de geração do relatório. Um único modelo pode acionar no máximo uma notificação por dia. Nota No Quartz, os dias da semana são numerados: 1 = domingo, 2 = segunda-feira, 3 = terça-feira, 4 = quarta-feira, 5 = quinta-feira, 6 = sexta-feira, 7 = sábado.	0 0 0 * * ?
ReportTemplateDescription	string	A descrição do modelo de relatório.	test-description
ReportGranularity	string	A granularidade de agregação do relatório.	AllInOne
ReportFileFormats	string	O formato de arquivo do relatório.	excel
ReportLanguage	string	O idioma do relatório. Valores válidos: zh-CN e en-US. O valor padrão é en-US se estiver vazio.	en-US
ReportScope	array<object>	O array de escopos do relatório. Cada escopo define um conjunto de regras incluídas no relatório de auditoria. Os escopos usam a lógica OR. Ou seja, as regras de todos os escopos são combinadas. Nota Se o array tiver dois itens, e o primeiro especificar o RuleId cr-1 enquanto o segundo especificar o RuleId cr-2, então o relatório abrangerá tanto cr-1 quanto cr-2.
	object	O escopo do relatório.
Key	string	Key for the report scope. Supported keys: AggregatorId CompliancePackId RuleId	RuleId
Value	string	Value for the report scope. For multiple values of the same type, such as multiple rule IDs, separate them with commas.	cr-1,cr-2
MatchType	string	Matching logic. Only In is supported.	In
RequestId	string	O ID da solicitação.	A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7

Exemplos

Resposta de sucesso

JSON formato

{
  "ReportTemplate": {
    "ReportTemplateId": "crt-xxx",
    "ReportTemplateName": "test-name",
    "SubscriptionFrequency": "0 0 0 * * ?",
    "ReportTemplateDescription": "test-description",
    "ReportGranularity": "AllInOne",
    "ReportFileFormats": "excel",
    "ReportLanguage": "en-US",
    "ReportScope": [
      {
        "Key": "RuleId",
        "Value": "cr-1,cr-2",
        "MatchType": "In"
      }
    ]
  },
  "RequestId": "A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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 Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.