DescribeFlowlogs - Cloud Enterprise Network: Central de Documentação do Alibaba Cloud

Consulta logs de fluxo.

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

cen:DescribeFlowlogs

get

*Flowlog

acs:cbn:{#regionId}:{#accountId}:flowlog/*

*Flowlog

acs:cbn:{#regionId}:{#accountId}:flowlog/{#FlowLogId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClientToken	string	Não	O token do cliente usado para garantir a idempotência da solicitação.	123e4567-e89b-12d3-a456-42665544****
RegionId	string	Não	O ID da região do log de fluxo.	cn-hangzhou.
FlowLogName	string	Não	O nome do log de fluxo.	myFlowlog.
FlowLogId	string	Não	O ID do log de fluxo.	flowlog-m5evbtbpt****
Description	string	Não	A descrição do log de fluxo.	myFlowlog.
CenId	string	Não	O ID da instância da Cloud Enterprise Network (CEN).	cen-7qthudw0ll6jmc****
ProjectName	string	Não	O nome do projeto que armazena o tráfego capturado.	FlowLogProject.
LogStoreName	string	Não	O nome do Logstore que armazena o tráfego capturado.	FlowLogStore.
Status	string	Não	O status do log de fluxo. Valores válidos:	Active.
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página para consultas paginadas. Valor mínimo: 1. Valor padrão: 20.	20
Tag	array<object>	Não	As informações da tag.
	object	Não
Key	string	Não	A chave da tag do recurso.	TagKey.
Value	string	Não	O valor da tag do recurso.	TagValue.
TransitRouterAttachmentId	string	Não	O ID da conexão da instância de rede.	tr-attach-qieks13jnt1cchy***
TransitRouterId	string	Não	O ID da instância do roteador de trânsito.	tr-uf654ttymmljlvh2x****
Interval	integer	Não	A duração da janela de captura do log de fluxo. Unidade: segundos. Valores válidos: 60 ou 600. Valor padrão: 600.	600
FlowLogVersion	string	Não	A versão do log de fluxo.	3

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
PageSize	string	O número de entradas por página para consultas paginadas.	20
PageNumber	string	O número da página.	1
RequestId	string	O ID da solicitação.	F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1
TotalCount	string	O número total de entradas retornadas.	1
Success	string	Indica se a chamada atual da API foi bem-sucedida.	true.
FlowLogs	object
FlowLog	array<object>	A lista de logs de fluxo.
	array<object>	As informações do log de fluxo.
Status	string	O status do log de fluxo. Valores válidos: Active: O log de fluxo está ativado. Inactive: O log de fluxo está desativado.	Active
CreationTime	string	A hora em que o log de fluxo foi criado. A hora segue o padrão ISO 8601 no formato AAAA-MM-DDThh:mm:ssZ. A hora é exibida em UTC.	2021-07-24T13:00:52Z
FlowLogName	string	O nome do log de fluxo.	myFlowlog
Description	string	A descrição do log de fluxo.	myFlowlog
ProjectName	string	O nome do projeto que armazena os dados de tráfego capturados.	FlowLogProject
CenId	string	O ID da instância da Cloud Enterprise Network (CEN).	cen-7qthudw0ll6jmc****
LogStoreName	string	O Logstore que armazena os dados de tráfego capturados.	FlowLogStore
RegionId	string	O ID da região do log de fluxo.	cn-hangzhou
FlowLogId	string	O ID do log de fluxo.	flowlog-m5evbtbpt****
TransitRouterAttachmentId	string	O ID da conexão da instância de rede.	tr-attach-5x4o4ynzuqbv6g****
TransitRouterId	string	O ID do roteador de trânsito.	tr-bp1g9313sx675zr1lajmj
LogFormatString	string	A string que define o formato do log de fluxo. Formato: `${Field 1}${Field 2}${Field 3}`	${srcaddr}${dstaddr}${bytes}
FlowLogVersion	string	A versão do log de fluxo. Os logs de fluxo são criados automaticamente na versão mais recente, que é a 3.	3
Interval	integer	A janela de tempo para coleta de dados de log. Unidade: segundos. Valores válidos: 60 ou 600. Valor padrão: 600.	60
Tags	object
Tag	array<object>	As tags.
	object	A tag N a ser adicionada à instância.
Key	string	A chave da tag.	TagKey
Value	string	O valor da tag.	TagValue

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": "20",
  "PageNumber": "1",
  "RequestId": "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1",
  "TotalCount": "1",
  "Success": "true",
  "FlowLogs": {
    "FlowLog": [
      {
        "Status": "Active",
        "CreationTime": "2021-07-24T13:00:52Z",
        "FlowLogName": "myFlowlog",
        "Description": "myFlowlog",
        "ProjectName": "FlowLogProject",
        "CenId": "cen-7qthudw0ll6jmc****",
        "LogStoreName": "FlowLogStore",
        "RegionId": "cn-hangzhou",
        "FlowLogId": "flowlog-m5evbtbpt****",
        "TransitRouterAttachmentId": "tr-attach-5x4o4ynzuqbv6g****",
        "TransitRouterId": "tr-bp1g9313sx675zr1lajmj",
        "LogFormatString": "${srcaddr}${dstaddr}${bytes}",
        "FlowLogVersion": "3",
        "Interval": 60,
        "Tags": {
          "Tag": [
            {
              "Key": "TagKey",
              "Value": "TagValue"
            }
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	OperationUnsupported.action	This action is not support.	A região atual não suporta esta operação.
400	InvalidFlowlogId.NotFound	The specified flowlog id does not exist or does not match the cen Id.	O flowlog especificado no parâmetro não existe.
400	IllegalParam.TagValue	The tag values are not valid.	O valor da tag especificado na solicitação é inválido.
400	IllegalParam.TagKey	The tag keys are not valid.	A chave da tag especificada na solicitação é inválida.
400	InvalidDescription	Description is invalid.	A descrição é inválida.
400	InvalidName	Name is invalid.	O nome é inválido.
400	InvalidParameter.Interval	Interval is invalid.	A frequência de amostragem especificada é inválida.
400	InvalidParameter.FlowLogVersion	Flowlog version is invalid.	A versão do log de fluxo especificada é inválida.
400	InvalidParameter	Invalid parameter.	O parâmetro é inválido.
400	Unauthorized	The AccessKeyId is unauthorized.	A conta não tem permissão para realizar esta operação.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.