DescribeFlowLogs - Virtual Private Cloud: 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

vpc:DescribeFlowLogs

get

*FlowLog

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do log de fluxo. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
FlowLogName	string	Não	O nome do log de fluxo. O nome deve ter de 1 a 128 caracteres e não pode começar com `http://` ou `https://`.	myFlowlog
FlowLogId	string	Não	O ID do log de fluxo.	fl-bp1f6qqhsrc2c12ta****
Description	string	Não	A descrição do log de fluxo. A descrição deve ter de 1 a 256 caracteres e não pode começar com `http://` ou `https://`.	This is my Flowlog.
ResourceType	string	Não	O tipo de recurso do tráfego a ser capturado. Valores válidos: NetworkInterface: controlador de interface de rede elástica (NIC). VSwitch: todos os controladores de interface de rede elástica (NIC) em um vSwitch. VPC: todos os controladores de interface de rede elástica (NIC) em uma nuvem privada virtual (VPC).	NetworkInterface
ResourceId	string	Não	O ID do recurso cujo tráfego você deseja capturar.	eni-askldfas****
TrafficType	string	Não	O tipo de tráfego a ser capturado. Valores válidos: All: todo o tráfego. Allow: tráfego permitido pelo controle de acesso. Drop: tráfego negado pelas políticas de controle de acesso.	All
ProjectName	string	Não	O projeto do Log Service que gerencia o tráfego capturado.	FlowLogProject
LogStoreName	string	Não	O Logstore que armazena o tráfego capturado.	FlowLogStore
Status	string	Não	O status do log de fluxo. Valores válidos: Active: O log de fluxo está ativo. Activating: O log de fluxo está sendo criado. Inactive: O log de fluxo está inativo.	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 paginação em uma consulta paginada. Valor máximo: 50. Valor padrão: 20.	20
VpcId	string	Não	O ID da VPC para a qual você deseja consultar os logs de fluxo.	vpc-bp1nwd16gvo1wgs****
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o log de fluxo pertence.	rg-bp67acfmxazb4ph****
Tags	array<object>	Não	A lista de tags.
	object	Não	A lista de tags.
Key	string	Não	A chave da tag do recurso. Você pode especificar até 20 chaves de tag. Se você especificar este parâmetro, não poderá especificar uma string vazia. Uma chave de tag pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	FinanceDept
Value	string	Não	O valor da tag do recurso. Você pode especificar até 20 valores de tag. Se você especificar este parâmetro, poderá especificar uma string vazia. Um valor de tag pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	FinanceJoshua

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os detalhes dos logs de fluxo.
PageSize	string	O número de entradas por página para paginação em uma consulta paginada.	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 logs de fluxo retornados.	1
Success	string	Indica se a chamada foi bem-sucedida. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada falhou.	true
FlowLogs	object
FlowLog	array<object>	A lista de logs de fluxo.
	array<object>	A lista de logs de fluxo.
Status	string	O status do log de fluxo. Valores válidos: Active: O log de fluxo está ativo. Activating: O log de fluxo está sendo criado. Inactive: O log de fluxo está inativo.	Active
CreationTime	string	A hora em que o log de fluxo foi criado. A hora é exibida em UTC e segue o padrão ISO 8601 no formato AAAA-MM-DDThh:mm:ssZ.	2022-01-21T03:08:50Z
FlowLogName	string	O nome do log de fluxo.	myFlowlog
TrafficType	string	O tipo de tráfego que os logs de fluxo capturam. Valores válidos: All: todo o tráfego. Allow: tráfego permitido pelo controle de acesso. Drop: tráfego negado pelas políticas de controle de acesso.	All
ResourceType	string	O tipo de recurso do tráfego que os logs de fluxo capturam. Valores válidos: NetworkInterface: controlador de interface de rede elástica (NIC). VSwitch: todos os controladores de interface de rede elástica (NIC) em um vSwitch. VPC: todos os controladores de interface de rede elástica (NIC) em uma nuvem privada virtual (VPC).	NetworkInterface
Description	string	A descrição do log de fluxo.	Description
ProjectName	string	O projeto do Log Service que gerencia o tráfego capturado.	FlowLogProject
LogStoreName	string	O Logstore que armazena o tráfego capturado.	FlowLogStore
ResourceId	string	O ID do recurso cujo tráfego é capturado pelo log de fluxo.	eni-askldfas****
RegionId	string	O ID da região do log de fluxo.	cn-hangzhou
FlowLogId	string	O ID do log de fluxo.	fl-bp1f6qqhsrc2c12ta****
BusinessStatus	string	O status do serviço. Valores válidos: Normal: normal. FinancialLocked: bloqueado devido a pagamento em atraso.	Normal
AggregationInterval	integer	O intervalo de amostragem do log de fluxo. Unidade: minutos.	10
TrafficPath	object
TrafficPathList	array	O caminho de tráfego a ser capturado. Valores válidos: all: captura todo o tráfego. internetGateway: captura o tráfego da Internet.
	string	O caminho de tráfego a ser capturado. Valores válidos: all (padrão): captura todo o tráfego. internetGateway: captura o tráfego da Internet. Nota O recurso de caminho de tráfego está desativado por padrão. Para usar este recurso, abra um ticket.	all
ServiceType	string	O tipo de hospedagem do serviço em nuvem. Se este parâmetro estiver vazio, indica que o log de fluxo foi criado pelo usuário. Se este parâmetro não estiver vazio, o único valor válido é sls, o que indica que o log de fluxo foi criado no console do Simple Log Service. Nota As instâncias de log de fluxo criadas no console do Simple Log Service são exibidas na lista de VPCs. No entanto, você não pode modificar, iniciar, parar ou excluir essas instâncias de log de fluxo no console de VPC. Para realizar operações relacionadas no log de fluxo, você pode fazer login no console do Simple Log Service para modificá-lo, iniciá-lo, pará-lo ou excluí-lo.	sls
ResourceGroupId	string	O ID do grupo de recursos ao qual o log de fluxo pertence.	rg-bp67acfmxazb4ph****
Tags	object
Tag	array<object>	A lista de tags.
	object	A lista de tags.
Key	string	A chave da tag.	FinanceDept
Value	string	O valor da tag.	FinanceJoshua
FlowLogDeliverStatus	string	O status de entrega do log de fluxo. Valores válidos: SUCCESS: A entrega foi bem-sucedida. FAILED: A entrega falhou.	FAILED
FlowLogDeliverErrorMessage	string	A mensagem de erro retornada quando a entrega do log de fluxo falha. Você pode solucionar o problema com base na mensagem de erro. Possíveis mensagens de erro: UnavaliableTarget: O Logstore no Simple Log Service está indisponível e não pode receber logs. Verifique se o Logstore existe e está acessível. ProjectNotExist: O projeto no Simple Log Service não existe. Exclua o log de fluxo original e crie um novo que aponte para um projeto existente. UnknownError: Ocorreu um erro interno. Tente novamente mais tarde.	UnavaliableTarget
IpVersion	string	O tipo de endereço IP do tráfego capturado pelo log de fluxo.	IPv4
LogFormat	string

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": "2022-01-21T03:08:50Z",
        "FlowLogName": "myFlowlog",
        "TrafficType": "All",
        "ResourceType": "NetworkInterface",
        "Description": "Description",
        "ProjectName": "FlowLogProject",
        "LogStoreName": "FlowLogStore",
        "ResourceId": "eni-askldfas****",
        "RegionId": "cn-hangzhou",
        "FlowLogId": "fl-bp1f6qqhsrc2c12ta****",
        "BusinessStatus": "Normal",
        "AggregationInterval": 10,
        "TrafficPath": {
          "TrafficPathList": [
            "all"
          ]
        },
        "ServiceType": "sls",
        "ResourceGroupId": "rg-bp67acfmxazb4ph****",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "FlowLogDeliverStatus": "FAILED",
        "FlowLogDeliverErrorMessage": "UnavaliableTarget",
        "IpVersion": "IPv4",
        "LogFormat": ""
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidInstanceId	Instance does not exist.	A instância vSwitch não existe.
400	ProjectOrLogstoreNotExist	The specified project or logstore does not exist.	O projeto ou Logstore especificado não existe.
400	SourceProjectNotExist	The Source Project or logstore does not exist.	O projeto ou Logstore de origem do Simple Log Service não existe.
400	Unauthorized	This api does not support sub user or role.	Esta operação de API não oferece suporte a usuários ou funções do RAM.
400	ParameterInvalid	Invalid parameter.	O parâmetro de entrada é inválido.
400	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	O RegionId especificado não existe. Verifique se o serviço está disponível na região.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.