enterprise-router/api-ref/source/apis/flow_logs/updating_a_flow_log.rst

original_name

UpdateFlowLog.html

Updating a Flow Log

Function

This API is used to update a flow log.

URI

PUT /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
er_id	Yes	String	Enterprise router ID
flow_log_id	Yes	String	Flow log ID

Request Parameters

Table 2 Request body parameters

Parameter	Mandatory	Type	Description
name	No	String	Flow log name Minimum: 1 Maximum: 64
description	No	String	Minimum: 0 Maximum: 255

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter	Type	Description
flow_log	FlowLog <updateflowlog__response_flowlog> object	Flow log details
request_id	String	Request ID

Table 4 FlowLog

Parameter	Type	Description
id	String	Flow log ID
name	String	Flow log name
description	String	Flow log description
project_id	String	Project ID of the flow log task creator
resource_type	String	Resource type. The value is attachment.
resource_id	String	Resource ID
log_group_id	String	Log group ID
log_stream_id	String	Log stream ID
log_store_type	String	Flow log storage type. LTS is used for log storage.
log_store_name	String	Flow log storage name. This parameter is not supported for now.
log_aggregation_interval	Integer	Log aggregation time, in seconds. The value ranges from 60 to 600.
created_at	String	Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ
updated_at	String	Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ
state	String	Flow log status. Value options: pending, available, modifying, deleting, deleted, and failed
enabled	Boolean	Whether to enable flow logs. The value can be true or false.

Example Requests

Updating a flow log

PUT https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/6f83b848-8331-4271-ac0c-ef94b7686402/flow_logs/b216bc1d-5963-41a7-89f9-779a5128c5ac

{
  "name" : "flow_log_update",
  "description" : "flow log update test"
}

Example Responses

Status code: 200

OK

{
  "flow_log" : {
    "id" : "b216bc1d-5963-41a7-89f9-779a5128c5ac",
    "name" : "flow_log_update",
    "project_id" : "0605767a9980d5762fbcc00b3537e757",
    "resource_type" : "attachment",
    "resource_id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
    "log_group_id" : "0139393c-eeb2-49f0-bbd4-c5faec6b1497",
    "log_stream_id" : "d22c3b44-2f71-470f-83f3-96a8af6956ad",
    "log_store_type" : "LTS",
    "log_aggregation_interval" : 600,
    "created_at" : "2020-03-11T15:13:31Z",
    "updated_at" : "2022-03-11T15:13:31Z",
    "state" : "available",
    "enabled" : true,
    "description" : "flow log update test"
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

Status Codes

Status Code	Description
200	OK

Error Codes

See Error Codes <errorcode>.