DescribeFlowLogs - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeFlowLogs	A operação que você deseja executar. Defina o valor como DescribeFlowLogs.
RegionId	String	Sim	cn-hangzhou	O ID da região do log de fluxo. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
FlowLogName	String	Não	myFlowlog	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://`.
FlowLogId	String	Não	fl-bp1f6qqhsrc2c12ta****	O ID do log de fluxo.
Description	String	Não	This is my Flowlog.	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://`.
ResourceType	String	Não	NetworkInterface	O tipo de recurso do qual o tráfego é capturado. Valores válidos: NetworkInterface: interface de rede elástica (ENI) VSwitch: todas as ENIs em um vSwitch VPC: todas as ENIs em uma virtual private cloud (VPC)
ResourceId	String	Não	eni-askldfas****	O ID do recurso do qual o tráfego é capturado.
TrafficType	String	Não	All	O tipo de tráfego capturado. Valores válidos: All: todo o tráfego Allow: tráfego permitido pelo controle de acesso Drop: tráfego negado pelo controle de acesso
ProjectName	String	Não	FlowLogProject	O projeto que gerencia os dados de tráfego capturados.
LogStoreName	String	Não	FlowLogStore	O Logstore que armazena os dados de tráfego capturados.
Status	String	Não	Active	O status do log de fluxo. Valores válidos: Active Activating Inactive
PageNumber	Integer	Não	1	O número da página a ser retornada. Valor padrão: 1.
PageSize	Integer	Não	20	O número de entradas a serem retornadas em cada página. Valor máximo: 50. Valor padrão: 20.
VpcId	String	Não	vpc-bp1nwd16gvo1wgs****	O ID da VPC à qual o log de fluxo pertence.
ResourceGroupId	String	Não	rg-bp67acfmxazb4ph****	O ID do grupo de recursos ao qual o log de fluxo pertence.
Tags.N.Key	String	Não	FinanceDept	A chave da tag N a ser adicionada ao recurso. É possível especificar até 20 chaves de tag. A chave da tag não pode ser uma string vazia. A chave da tag pode ter no máximo 128 caracteres. Ela não pode começar com `aliyun` ou `acs:`, e não pode conter `http://` ou `https://`.
Tags.N.Value	String	Não	FinanceJoshua	O valor da tag N a ser adicionada ao recurso. É possível especificar até 20 valores de tag. O valor da tag pode ser uma string vazia. O valor da tag pode ter até 128 caracteres e não pode começar com `acs:` ou `aliyun`. O valor da tag não pode conter `http://` ou `https://`.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageSize	String	20	O número de entradas por página.
PageNumber	String	1	O número da página retornada.
RequestId	String	F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1	O ID da solicitação.
TotalCount	String	1	O número de logs de fluxo consultados.
Success	String	true	Indica se a operação foi bem-sucedida. Valores válidos: true false
FlowLogs	Array of FlowLog		As informações sobre os logs de fluxo.
FlowLog
Status	String	Active	O status do log de fluxo. Valores válidos: Active Activating Inactive
CreationTime	String	2022-01-21T03:08:50Z	O momento em que o log de fluxo foi criado.
FlowLogName	String	myFlowlog	O nome do log de fluxo.
TrafficType	String	All	O tipo de tráfego capturado pelo log de fluxo. Valores válidos: All: todo o tráfego Allow: tráfego permitido pelo controle de acesso Drop: tráfego negado pelo controle de acesso
ResourceType	String	NetworkInterface	O tipo de recurso do qual o tráfego é capturado. Valores válidos: NetworkInterface: ENI VSwitch: todas as ENIs em um vSwitch VPC: todas as ENIs em uma VPC
Description	String	Description	A descrição do log de fluxo.
ProjectName	String	FlowLogProject	O projeto que gerencia os dados de tráfego capturados.
LogStoreName	String	FlowLogStore	O Logstore que armazena os dados de tráfego capturados.
ResourceId	String	eni-askldfas****	O ID do recurso do qual o tráfego é capturado.
RegionId	String	cn-hangzhou	O ID da região do log de fluxo.
FlowLogId	String	fl-bp1f6qqhsrc2c12ta****	O ID do log de fluxo.
BusinessStatus	String	Normal	O status comercial do log de fluxo. Valores válidos: Normal FinancialLocked
AggregationInterval	Integer	10	O intervalo de amostragem do log de fluxo. Unidade: minutos.
TrafficPath	Array of String	all	O escopo de amostragem do tráfego coletado. Valores válidos: all (valor padrão): todo o tráfego internetGateway: tráfego da Internet Nota Por padrão, o recurso de caminho de tráfego não está disponível. Para usar esse recurso, envie um ticket.
ServiceType	String	sls	O tipo de hospedagem do serviço de nuvem. Este parâmetro pode estar vazio, o que indica que o log de fluxo foi criado pelo usuário. Se este parâmetro não estiver vazio, o valor será definido como sls. O valor sls indica que o log de fluxo foi criado no console do Simple Log Service (SLS). Nota Um log de fluxo criado no console do SLS pode ser exibido na lista de VPCs. No entanto, não é possível modificar, iniciar, parar ou excluir o log de fluxo no console da VPC. Para gerenciar o log de fluxo, faça login no console do SLS e execute as operações necessárias.
ResourceGroupId	String	rg-bp67acfmxazb4ph****	O ID do grupo de recursos ao qual o log de fluxo pertence.
Tags	Array of Tag		A lista de tags.
Tag
Key	String	FinanceDept	A chave da tag N.
Value	String	FinanceJoshua	O valor da tag N.
FlowLogDeliverStatus	String	FAILED	Indica se o log de fluxo foi entregue. Valores válidos: SUCCESS FAILED
FlowLogDeliverErrorMessage	String	UnavaliableTarget	Se a entrega do log de fluxo falhar, você poderá solucionar o problema com base nas seguintes mensagens de erro que podem ser retornadas: UnavaliableTarget: O Logstore do SLS está indisponível e não pode receber logs. Verifique se o Logstore está disponível. ProjectNotExist: O projeto do SLS não existe. Recomendamos que você exclua o projeto e crie um novo. UnknownError: Ocorreu um erro interno. Tente novamente mais tarde.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=DescribeFlowLogs
&RegionId=cn-hangzhou
&FlowLogName=myFlowlog
&FlowLogId=fl-bp1f6qqhsrc2c12ta****
&Description=This is my Flowlog.
&ResourceType=NetworkInterface
&ResourceId=eni-askldfas****
&TrafficType=All
&ProjectName=FlowLogProject
&LogStoreName=FlowLogStore
&Status=Active
&PageNumber=1
&PageSize=20
&VpcId=vpc-bp1nwd16gvo1wgs****
&ResourceGroupId=rg-bp67acfmxazb4ph****
&Tags=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&Common request parameters

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeFlowLogsResponse>
    <PageSize>20</PageSize>
    <PageNumber>1</PageNumber>
    <RequestId>F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1</RequestId>
    <TotalCount>1</TotalCount>
    <Success>true</Success>
    <FlowLogs>
        <Status>Active</Status>
        <CreationTime>2022-01-21T03:08:50Z</CreationTime>
        <FlowLogName>myFlowlog</FlowLogName>
        <TrafficType>All</TrafficType>
        <ResourceType>NetworkInterface</ResourceType>
        <Description>Description</Description>
        <ProjectName>FlowLogProject</ProjectName>
        <LogStoreName>FlowLogStore</LogStoreName>
        <ResourceId>eni-askldfas****</ResourceId>
        <RegionId>cn-hangzhou</RegionId>
        <FlowLogId>fl-bp1f6qqhsrc2c12ta****</FlowLogId>
        <BusinessStatus>Normal</BusinessStatus>
        <AggregationInterval>10</AggregationInterval>
        <TrafficPath>all</TrafficPath>
        <ServiceType>sls</ServiceType>
        <ResourceGroupId>rg-bp67acfmxazb4ph****</ResourceGroupId>
        <Tags>
            <Key>FinanceDept</Key>
            <Value>FinanceJoshua</Value>
        </Tags>
        <FlowLogDeliverStatus>FAILED</FlowLogDeliverStatus>
        <FlowLogDeliverErrorMessage>UnavaliableTarget</FlowLogDeliverErrorMessage>
    </FlowLogs>
</DescribeFlowLogsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : "20",
  "PageNumber" : "1",
  "RequestId" : "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1",
  "TotalCount" : "1",
  "Success" : "true",
  "FlowLogs" : [ {
    "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" : [ "all" ],
    "ServiceType" : "sls",
    "ResourceGroupId" : "rg-bp67acfmxazb4ph****",
    "Tags" : [ {
      "Key" : "FinanceDept",
      "Value" : "FinanceJoshua"
    } ],
    "FlowLogDeliverStatus" : "FAILED",
    "FlowLogDeliverErrorMessage" : "UnavaliableTarget"
  } ]
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
400	InvalidInstanceId	Instance does not exist.	A mensagem de erro retornada porque a instância não existe.
400	ProjectOrLogstoreNotExist	The specified project or logstore does not exist.	A mensagem de erro retornada porque o projeto ou Logstore especificado não existe.
400	SourceProjectNotExist	The Source Project or logstore does not exist.	A mensagem de erro retornada porque o projeto de origem ou Logstore não existe.
400	Unauthorized	This api does not support sub user or role.	A mensagem de erro retornada porque você não pode chamar esta operação como um usuário RAM.
400	ParameterInvalid	Invalid parameter.	A mensagem de erro retornada porque um parâmetro é inválido.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.