gtema 4cfecba474 VPC api from PR#278

Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>

2022-10-17 12:39:05 +00:00

21 KiB

Raw Permalink Blame History

Updating a VPC Flow Log

Function

This API is used to update a VPC flow log.

URI

PUT /v1/{project_id}/fl/flow_logs/{flowlog_id}

Table 1 describes the parameters.

**Table 1** Parameter description
Name	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
flowlog_id	Yes	String	Specifies the VPC flow log ID.

Request Message

Request parameter

**Table 2** Request parameter
Name	Type	Description
flow_log	flow_log object	Specifies the FlowLog objects. For details, see Table 3.

**Table 3** Description of the **FlowLog** field
Name	Mandatory	Type	Description
name	No	String	Specifies the VPC flow log name. The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
description	No	String	Provides supplementary information about the VPC flow log. The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
admin_state	No	Boolean	Specifies whether to enable the VPC flow log function.

Example request

PUT https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/f49f00f1-0f15-470a-a8c5-4e879e461c8d

{
    "flow_log": {
        "name": "flow-log-update",
        "description": "update",
        "admin_state": false
    }
}

Response Message

Response parameter

**Table 4** Response parameter
Name	Type	Description
flow_log	flow_log object	Specifies the FlowLog objects. For details, see Table 5.

**Table 5** Description of the **FlowLog** field
Name	Type	Description
id	String	Specifies the VPC flow log UUID.
name	String	Specifies the VPC flow log name.
tenant_id	String	Specifies the project ID.
description	String	Provides supplementary information about the VPC flow log.
resource_type	String	Specifies the type of resource on which to create the VPC flow log.
resource_id	String	Specifies the unique resource ID.
traffic_type	String	Specifies the type of traffic to log.
log_group_id	String	Specifies the log group ID.
log_topic_id	String	Specifies the log topic ID.
admin_state	Boolean	Specifies whether to enable the VPC flow log function.
status	String	Specifies the VPC flow log status. ACTIVE: Enabled DOWN: Disabled ERROR: Abnormal fault
created_at	String	Specifies the time when the VPC flow log was created.
updated_at	String	Specifies the time when the VPC flow log was updated.

Example response

{
    "flow_log": {
        "id": "f49f00f1-0f15-470a-a8c5-4e879e461c8d",
        "name": " flow-log-update",
        "description": "update",
        "tenant_id": "b2782e6708b8475c993e6064bc456bf8",
        "resource_type": "port",
        "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde",
        "traffic_type": "reject",
        "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd",
        "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63",
        "created_at": "2019-01-14T11:03:02",
        "updated_at": "2019-01-14T12:03:02"
        "status": "DOWN",
        "admin_state": false
    }
}

Status Code

See Status Codes.

Error Code

See Error Codes.

Parent topic: VPC Flow Log

21 KiB Raw Permalink Blame History