Creating a Flow Log
Function
This API is used to create a flow log for an enterprise router.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/enterprise-router/{er_id}/flow-logs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
er_id |
Yes |
String |
Enterprise router ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Client-Token |
No |
String |
Idempotence identifier Minimum: 1 Maximum: 64 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
flow_log |
Yes |
FlowLogRequest object |
Request body for creating a flow log |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Flow log name Minimum: 1 Maximum: 64 |
description |
No |
String |
Flow log description Minimum: 0 Maximum: 255 |
resource_type |
Yes |
String |
Type of resource whose flow logs are collected.
|
resource_id |
Yes |
String |
Resource ID |
log_group_id |
Yes |
String |
Log group ID. Obtain the log group ID by referring to the Log Tank Service User Guide. |
log_stream_id |
Yes |
String |
Log stream ID. Obtain the log stream ID by referring to the Log Tank Service User Guide. |
log_store_type |
Yes |
String |
Flow log storage type. LTS: Logs are stored on LTS servers. |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
X-Client-Token |
- |
Idempotence identifier |
Parameter |
Type |
Description |
---|---|---|
flow_log |
FlowLog object |
Flow log details |
request_id |
String |
Request ID |
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_aggregation_interval |
Integer |
Log aggregation time, in seconds. The value ranges from 60 to 600. |
created_at |
String |
Creation time in the format of YYYY-MM-DDTHH:mm:ss.sssZ |
updated_at |
String |
Update time in the format of 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
Creating a flow log
POST https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/a43c55e9-4911-4030-90e1-5c2bf6ae6fe2/flow-logs { "flow_log" : { "name" : "flow-log", "description" : "flow log test", "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" } }
Example Responses
Status code: 202
Accepted
{ "flow_log" : { "id" : "b216bc1d-5963-41a7-89f9-779a5128c5ac", "name" : "flow_log", "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 Logs" }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" }
SDK Sample Code
The SDK sample code is as follows.
Java
Creating a flow log
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.er.v3.region.ErRegion; import com.huaweicloud.sdk.er.v3.*; import com.huaweicloud.sdk.er.v3.model.*; public class CreateFlowLogSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); ErClient client = ErClient.newBuilder() .withCredential(auth) .withRegion(ErRegion.valueOf("<YOUR REGION>")) .build(); CreateFlowLogRequest request = new CreateFlowLogRequest(); CreateFlowLogRequestBody body = new CreateFlowLogRequestBody(); FlowLogRequest flowLogbody = new FlowLogRequest(); flowLogbody.withName("flow-log") .withDescription("flow log test") .withResourceType(FlowLogRequest.ResourceTypeEnum.fromValue("attachment")) .withResourceId("6f83b848-8331-4271-ac0c-ef94b7686402") .withLogGroupId("0139393c-eeb2-49f0-bbd4-c5faec6b1497") .withLogStreamId("d22c3b44-2f71-470f-83f3-96a8af6956ad") .withLogStoreType(FlowLogRequest.LogStoreTypeEnum.fromValue("LTS")); body.withFlowLog(flowLogbody); request.withBody(body); try { CreateFlowLogResponse response = client.createFlowLog(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
Creating a flow log
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdker.v3.region.er_region import ErRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdker.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = ErClient.new_builder() \ .with_credentials(credentials) \ .with_region(ErRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateFlowLogRequest() flowLogbody = FlowLogRequest( name="flow-log", description="flow log test", 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" ) request.body = CreateFlowLogRequestBody( flow_log=flowLogbody ) response = client.create_flow_log(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
Creating a flow log
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" er "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := er.NewErClient( er.ErClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateFlowLogRequest{} descriptionFlowLog:= "flow log test" flowLogbody := &model.FlowLogRequest{ Name: "flow-log", Description: &descriptionFlowLog, ResourceType: model.GetFlowLogRequestResourceTypeEnum().ATTACHMENT, ResourceId: "6f83b848-8331-4271-ac0c-ef94b7686402", LogGroupId: "0139393c-eeb2-49f0-bbd4-c5faec6b1497", LogStreamId: "d22c3b44-2f71-470f-83f3-96a8af6956ad", LogStoreType: model.GetFlowLogRequestLogStoreTypeEnum().LTS, } request.Body = &model.CreateFlowLogRequestBody{ FlowLog: flowLogbody, } response, err := client.CreateFlowLog(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
202 |
Accepted |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot