DescribeApiExports - Web Application Firewall: Central de Documentação do Alibaba Cloud

Consulta a lista de tarefas de exportação de segurança de API.

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

yundun-waf:DescribeApiExports

get

*全部资源

*

acs:ResourceGroupId

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Lang `deprecated`	string	Não	O tipo de idioma. Valores válidos: zh: Chinês. en: Inglês.	zh
PageNumber	integer	Não	O número da página a ser retornado em uma consulta paginada. Valor padrão: 1, que indica a primeira página.	1
PageSize	integer	Não	O número de entradas por página em uma consulta paginada. Valor padrão: 10, que indica 10 entradas por página.	10
InstanceId	string	Sim	O ID da instância do WAF. Nota Você pode chamar DescribeInstance para consultar o ID da instância atual do WAF.	waf_v3prepaid_public_cn-p****
RegionId	string	Não	A região onde a instância do WAF está implantada. Valores válidos: cn-hangzhou: China continental. ap-southeast-1: Fora da China continental.	cn-hangzhou
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos do Alibaba Cloud.	rg-acfm***q

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	D9532525-E885-54E7-A178-D5554D563AFB
ApiExports	array<object>	A lista de tarefas de exportação.
	object	As informações da tarefa de exportação.
Status	string	O status da tarefa de exportação. Valores válidos: expired: O arquivo expirou. exporting: A exportação está em andamento. completed: A exportação foi concluída.	completed
FileUrl	string	A URL de download do arquivo.	https://waf-api-sec-cn.*.aliyuncs.com/file_1610954145*.csv
Type	string	O tipo da tarefa de exportação. Valores válidos: apisec_api: Tarefa de ativo de API. apisec_abnormal: Tarefa de risco de API. apisec_event: Tarefa de evento de segurança de API.	apisec_api
Format	string	O formato do arquivo exportado.	CSV
FileName	string	O nome do arquivo.	file_16109541456445334c0f01d9a7444e0e908***.csv
CreateTime	integer	A hora em que a tarefa de exportação foi criada. O valor é um timestamp UNIX (UTC). Unidade: segundos.	1725604852
Total	integer	O número total de entradas retornadas.	7

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "D9532525-E885-54E7-A178-D5554D563AFB",
  "ApiExports": [
    {
      "Status": "completed",
      "FileUrl": "https://waf-api-sec-cn.***.aliyuncs.com/file_1610954145***.csv",
      "Type": "apisec_api",
      "Format": "CSV",
      "FileName": "file_16109541456445334c0f01d9a7444e0e908***.csv",
      "CreateTime": 1725604852
    }
  ],
  "Total": 7
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.