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

Obtém os detalhes dos modelos de relatório de conformidade em lotes.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

config:ListReportTemplates

list

*ReportTemplate.

acs:config::{#accountId}:reporttemplate/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
NextToken	string	Não	O token usado para obter a próxima página de resultados quando a resposta é truncada.	IWBjqMYSy0is7zSMGu16****
MaxResults	integer	Não	O número máximo de entradas a serem retornadas por página. Valor padrão: 20.	20
Keyword	string	Não	A palavra-chave de pesquisa. Há suporte para correspondência aproximada para IDs de modelo, nomes de modelo e descrições de modelo.	test-description

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	8195B664-9565-4685-89AC-8B5F04B44B92
TotalCount	integer	O número total de modelos.	7
MaxResults	integer	O número de entradas retornadas por página. Valores válidos: 1 a 50. Valor padrão: 20.	20
NextToken	string	O token usado para obter a próxima página de resultados quando a resposta é truncada.	aVCjqNaSy0Ps7zSMGu25****
ReportTemplateList	array<object>	A lista de modelos de relatório.
	array<object>
ReportTemplateId	string	O ID do modelo de relatório.	crt-xxx
ReportTemplateName	string	O nome do modelo de relatório.	test-name
ReportTemplateDescription	string	A descrição do modelo de relatório.	test-description
ReportGranularity	string	A granularidade de agregação do relatório. Para uma conta de gerenciamento, os seguintes valores são suportados: AllInOne: Agrega todas as contas dentro do escopo do modelo para gerar um único relatório. GroupByAggregator: Agrega contas por grupo de contas para gerar relatórios e os empacota em um arquivo compactado. GroupByAccount: Gera um relatório separado para cada conta (padrão) e os empacota em um arquivo compactado. Para contas de membro, apenas o valor GroupByAccount é suportado.	AllInOne
ReportFileFormats	string	O formato do relatório. Atualmente, há suporte apenas para Excel.	excel
ReportLanguage	string	O idioma do relatório. Valores válidos: zh-CN e en-US. Valor padrão: en-US.	en-US
SubscriptionFrequency	string	A frequência de assinatura do relatório. Se este campo não estiver vazio, será uma expressão cron do Quartz que aciona notificações de assinatura. O formato é: Segundos Minutos Horas Dia-do-mês Mês Dia-da-semana. A seguir estão exemplos de expressões cron comuns: Executar às 00:00 todos os dias: 0 0 0 * * ? Executar às 15:30 toda segunda-feira: 0 30 15 ? * MON Executar às 02:00 no primeiro dia de cada mês: 0 0 2 1 * ? Onde: "" indica qualquer valor. "?" é usado nos campos de dia do mês e dia da semana para indicar nenhum valor específico. "MON" indica segunda-feira. Nota* O horário de acionamento está em UTC+8. Ajuste as configurações da expressão cron com base no seu fuso horário. Nota O sistema tenta acionar notificações de acordo com a expressão cron, mas podem ocorrer atrasos devido ao status de geração do relatório. A expressão cron limita as notificações para o mesmo modelo a no máximo uma vez por dia. Nota Além de usar MON para segunda-feira, você também pode usar números. Observe que na estrutura Quartz: 1 representa domingo, 2 representa segunda-feira, 3 representa terça-feira, 4 representa quarta-feira, 5 representa quinta-feira, 6 representa sexta-feira e 7 representa sábado.	0 0 13 * * ?
ReportScope	array<object>	A matriz de escopos de relatório, que é usada para especificar o escopo das regras incluídas no relatório de auditoria. A operação lógica OR é aplicada entre cada ReportScope na matriz. Nota Por exemplo, se o tamanho da matriz for 2, o primeiro ReportScope especificar a regra In cr-1 e o segundo ReportScope especificar a regra In cr-2, o escopo de regras para este relatório incluirá cr-1 e cr-2.
	object	O escopo do relatório.
Key	string	A chave do escopo do relatório. Valores válidos: AggregatorId CompliancePackId RuleId	RuleId
Value	string	O valor do escopo do relatório. Vários itens do mesmo tipo, como vários IDs de regra, podem ser separados por vírgulas (,).	cr-1,cr-2
MatchType	string	A lógica de correspondência. Atualmente, há suporte apenas para In.	In

Exemplos

Resposta de sucesso

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 erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	ReportTemplateNotExist	Report template does not exist or invalid.
503	ServiceUnavailable	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.