DescribeFlowLogs - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeFlowLogs	L'opération à effectuer. Définissez la valeur sur DescribeFlowLogs.
RegionId	String	Yes	cn-hangzhou	L'ID de région du journal de flux. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.
FlowLogName	String	No	myFlowlog	Le nom du journal de flux. Le nom doit comporter entre 1 et 128 caractères et ne peut pas commencer par `http://` ou `https://`.
FlowLogId	String	No	fl-bp1f6qqhsrc2c12ta****	L'ID du journal de flux.
Description	String	No	This is my Flowlog.	La description du journal de flux. La description doit comporter entre 1 et 256 caractères et ne peut pas commencer par `http://` ou `https://`.
ResourceType	String	No	NetworkInterface	Le type de ressource dont le trafic est capturé. Valeurs valides : NetworkInterface : interface réseau élastique (ENI) VSwitch : toutes les ENI d'un vSwitch VPC : toutes les ENI d'un VPC
ResourceId	String	No	eni-askldfas****	L'ID de la ressource dont le trafic est capturé.
TrafficType	String	No	All	Le type de trafic capturé. Valeurs valides : All : tout le trafic Allow : trafic autorisé par le contrôle d'accès Drop : trafic refusé par le contrôle d'accès
ProjectName	String	No	FlowLogProject	Le projet qui gère les données de trafic capturées.
LogStoreName	String	No	FlowLogStore	Le Logstore qui stocke les données de trafic capturées.
Status	String	No	Active	L'état du journal de flux. Valeurs valides : Active Activating Inactive
PageNumber	Integer	No	1	Le numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	Integer	No	20	Le nombre d'entrées à renvoyer par page. Valeur maximale : 50. Valeur par défaut : 20.
VpcId	String	No	vpc-bp1nwd16gvo1wgs****	L'ID du VPC auquel appartient le journal de flux.
ResourceGroupId	String	No	rg-bp67acfmxazb4ph****	L'ID du groupe de ressources auquel appartient le journal de flux.
Tags.N.Key	String	No	FinanceDept	La clé du tag N à ajouter à la ressource. Vous pouvez spécifier au maximum 20 clés de tag. La clé de tag ne peut pas être une chaîne vide. La clé de tag peut comporter au maximum 128 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:`, et ne peut pas contenir `http://` ou `https://`.
Tags.N.Value	String	No	FinanceJoshua	La valeur du tag N à ajouter à la ressource. Vous pouvez spécifier au maximum 20 valeurs de tag. La valeur de tag peut être une chaîne vide. La valeur de tag peut comporter jusqu'à 128 caractères et ne peut pas commencer par `acs:` ou `aliyun`. La valeur de tag ne peut pas contenir `http://` ou `https://`.

Paramètres de réponse

Parameter	Type	Example	Description
PageSize	String	20	Le nombre d'entrées par page.
PageNumber	String	1	Le numéro de la page renvoyée.
RequestId	String	F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1	L'ID de la requête.
TotalCount	String	1	Le nombre total de journaux de flux.
Success	String	true	Indique si l'opération a réussi. Valeurs valides : true false
FlowLogs	Array of FlowLog		Les informations relatives aux journaux de flux.
FlowLog
Status	String	Active	L'état du journal de flux. Valeurs valides : Active Activating Inactive
CreationTime	String	2022-01-21T03:08:50Z	L'heure de création du journal de flux.
FlowLogName	String	myFlowlog	Le nom du journal de flux.
TrafficType	String	All	Le type de trafic capturé par le journal de flux. Valeurs valides : All : tout le trafic Allow : trafic autorisé par le contrôle d'accès Drop : trafic refusé par le contrôle d'accès
ResourceType	String	NetworkInterface	Le type de ressource dont le trafic est capturé. Valeurs valides : NetworkInterface : ENI VSwitch : toutes les ENI d'un vSwitch VPC : toutes les ENI d'un VPC
Description	String	Description	La description du journal de flux.
ProjectName	String	FlowLogProject	Le projet qui gère les données de trafic capturées.
LogStoreName	String	FlowLogStore	Le Logstore qui stocke les données de trafic capturées.
ResourceId	String	eni-askldfas****	L'ID de la ressource dont le trafic est capturé.
RegionId	String	cn-hangzhou	L'ID de région du journal de flux.
FlowLogId	String	fl-bp1f6qqhsrc2c12ta****	L'ID du journal de flux.
BusinessStatus	String	Normal	L'état commercial du journal de flux. Valeurs valides : Normal FinancialLocked
AggregationInterval	Integer	10	L'intervalle d'échantillonnage du journal de flux. Unité : minutes.
TrafficPath	Array of String	all	La portée d'échantillonnage du trafic collecté. Valeurs valides : all (valeur par défaut) : tout le trafic internetGateway : trafic Internet Remarque Par défaut, la fonctionnalité de chemin de trafic n'est pas disponible. Pour utiliser cette fonctionnalité, soumettez un ticket.
ServiceType	String	sls	Le type d'hébergement du service cloud. Ce paramètre peut être vide, ce qui indique que le journal de flux a été créé par l'utilisateur. Si ce paramètre n'est pas vide, la valeur est définie sur sls. La valeur sls indique que le journal de flux a été créé dans la console Simple Log Service (SLS). Remarque Un journal de flux créé dans la console SLS peut être affiché dans la liste VPC. Toutefois, vous ne pouvez pas modifier, démarrer, arrêter ou supprimer le journal de flux dans la console VPC. Si vous souhaitez gérer le journal de flux, connectez-vous à la console SLS et effectuez les opérations requises.
ResourceGroupId	String	rg-bp67acfmxazb4ph****	L'ID du groupe de ressources auquel appartient le journal de flux.
Tags	Array of Tag		La liste des tags.
Tag
Key	String	FinanceDept	La clé du tag N.
Value	String	FinanceJoshua	La valeur du tag N.
FlowLogDeliverStatus	String	FAILED	Indique si le journal de flux est livré. Valeurs valides : SUCCESS FAILED
FlowLogDeliverErrorMessage	String	UnavaliableTarget	Si la livraison du journal de flux a échoué, vous pouvez résoudre le problème en vous basant sur les messages d'erreur suivants qui peuvent être renvoyés : UnavaliableTarget : Le Logstore de SLS n'est pas disponible et ne peut pas recevoir de journaux. Vérifiez si le Logstore est disponible. ProjectNotExist : Le projet SLS n'existe pas. Nous vous recommandons de supprimer le projet et d'en créer un nouveau. UnknownError : Une erreur interne s'est produite. Réessayez ultérieurement.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

XML format

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>

JSON format

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"
  } ]
}

Codes d'erreur

HttpCode	Error code	Error message	Description
400	InvalidInstanceId	Instance does not exist.	L'instance n'existe pas.
400	ProjectOrLogstoreNotExist	The specified project or logstore does not exist.	Le projet ou le Logstore spécifié n'existe pas.
400	SourceProjectNotExist	The Source Project or logstore does not exist.	Le projet source ou le Logstore n'existe pas.
400	Unauthorized	This api does not support sub user or role.	Vous ne pouvez pas appeler cette opération en tant qu'utilisateur RAM.
400	ParameterInvalid	Invalid parameter.	Un paramètre n'est pas valide.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.