創建流日志。
接口說明
流日志可以幫您捕獲轉發路由器實例和網絡實例連接(跨地域連接、VPC 連接、VPN 連接、ECR 連接和 VBR 連接)傳輸的流量信息。在創建流日志前,請先了解以下說明:
-
僅企業版轉發路由器支持創建流日志。
-
對于跨地域連接的流量信息,流日志僅捕獲轉發路由器出方向的流量信息,不支持捕獲轉發路由器入方向的流量信息。
例如,美國(硅谷)地域的云服務器 ECS(Elastic Compute Service)實例通過云企業網訪問美國(弗吉尼亞)地域的 ECS 實例,在您為美國(弗吉尼亞)地域的轉發路由器配置流日志后,您可以在日志服務控制臺查看美國(弗吉尼亞)ECS 實例向美國(硅谷)ECS 實例發送的報文信息,但無法查看美國(硅谷)ECS 實例向美國(弗吉尼亞)ECS 實例發送的報文信息。如果您需要查看美國(硅谷)ECS 實例向美國(弗吉尼亞)ECS 實例發送的報文信息,您需要在美國(硅谷)地域的轉發路由器上也配置流日志。
-
流日志捕獲 VPC 連接的流量信息時,僅捕獲轉發路由器 ENI 傳輸的流量信息,如果您需要了解 VPC 內其他 ENI 傳輸的流量信息,請參見 VPC 流日志概述。
-
CreateFlowlog
接口屬于異步接口,即系統會先返回一個流日志 ID,但是流日志并未創建完成,系統后臺的創建任務仍在進行。您可以調用DescribeFlowlogs
接口查詢流日志的狀態。- 當流日志處于 Creating 狀態時,表示流日志正在創建中,在該狀態下,您只能執行查詢操作,不能執行其他操作。
- 當流日志處于 Active 狀態時,表示流日志創建完成。
前提條件
為資源創建流日志前,請確保您已經擁有了相關資源。各個資源的創建操作,請參見:
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cen:CreateFlowlog | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。
| 123e4567-e89b-12d3-a456-42665544**** |
RegionId | string | 是 | 流日志所屬的地域 ID。 您可以通過調用 DescribeChildInstanceRegions 接口獲取地域 ID。 | cn-hangzhou |
FlowLogName | string | 否 | 流日志名稱。 名稱可以為空或長度為 1~128 個字符,不能以 http://或 https://開頭。 | myFlowlog |
Description | string | 否 | 流日志的描述信息。 描述可以為空或長度為 1~256 個字符,不能以 http://或 https://開頭。 | myFlowlog |
CenId | string | 是 | 云企業網實例 ID。 | cen-7qthudw0ll6jmc**** |
ProjectName | string | 是 | 存儲捕獲流量的 Project。
| flowlog-project |
LogStoreName | string | 是 | 存儲捕獲流量的 Logstore。
| flowlog-logstore |
Interval | long | 否 | 流日志捕獲流量的捕獲窗口時長。單位:秒。取值:60 或 600。默認值:600。 | 600 |
TransitRouterAttachmentId | string | 否 | VPC 連接、VPN 連接、VBR 連接、ECR 連接或跨地域連接 ID。 若需配置轉發路由器實例的流日志,此字段不填值。 | tr-attach-r6g0m3epjehw57**** |
TransitRouterId | string | 否 | 轉發路由器實例 ID。 | tr-bp1rmwxnk221e3fas**** |
LogFormatString | string | 否 | 自定義流日志記錄字段的字符串。 格式定義為:
| ${srcaddr}${dstaddr}${bytes} |
Tag | array<object> | 否 | 標簽信息。 一次最多支持輸入 20 個標簽信息。 | |
object | 否 | 標簽信息。 一次最多支持輸入 20 個標簽信息。 | ||
Key | string | 否 | 資源的標簽鍵。 一旦傳入該值,則不允許為空字符串。最多支持 64 個字符,不能以 一次最多支持輸入 20 個標簽的標簽鍵。 | TagKey |
Value | string | 否 | 資源的標簽值。 標簽值可以為空或輸入不超過 128 個字符的字符串,不能以 每一個標簽鍵對應一個標簽值,一次最多支持輸入 20 個標簽鍵對應的標簽值。 | TagValue |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457",
"Success": "true",
"FlowLogId": "flowlog-m5evbtbpt****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ProjectOrLogstoreNotExist | The specified project or logstore does not exist. | 參數中指定的project或logstore不存在。 |
400 | SourceProjectNotExist | The Source Project or logstore does not exist. | SourceProject或者logstore不存在。 |
400 | OperationUnsupported.action | This action is not support. | 當前地域不支持該操作。 |
400 | RuleExist | The rule has already existed. | 該規則已存在。 |
400 | QuotaExceeded.FlowlogCount | This user has reached the maximum instance number of flowlog. | flowlog數量已達到上限。 |
400 | InvalidFlowlogId.exist | This cenId already has flowlog instance existed. | 當前Cen已經存在flowlog,無法操作。 |
400 | Flowlog.AlreayExist | This attachment already has existed flowlog instance. | flowlog已存在,無法重復創建。 |
400 | IllegalParam.TransitRouterAttachmentId | TransitRouterAttachmentId is illegal. | 參數中指定的TrInstance不合法。 |
400 | InvalidTransitRouterAttachmentId.NotFound | The TransitRouterAttachmentId is not found. | 參數中指定的TransitRouterAttachmentId不存在。 |
400 | IncorrectStatus.flowlog | This action is not allowed in the current flow log status. | flowlog狀態不正確 |
400 | InvalidOperation.TransitRouterNotExist | Operation is invalid because the transit router not exist. | 轉發路由器不存在。 |
400 | IncorrectStatus.TransitRouterAttachmentId | The resource is not in a valid state for the attachment operation. | 當前該Attachment不處于穩態,不支持該操作。 |
400 | ProjectExist | Project already exist, please try a different project name. | 日志Project已存在,請嘗試使用不同的Project名稱。 |
400 | InvalidParameter.ProjectName | Project name is invalid or does not belong to specified region. | Project名稱不合法或與不屬于指定的region。 |
400 | IncorrectStatus.TrFlowlog | Flowlog status for specified TransitRouter is invalid for this operation. | 指定轉發路由器的流日志配置狀態不合法。 |
400 | OperationInvalid.IncompatibleFlowlogExist | Operation is invalid because incompatible flowlog config exists. | 存在不兼容的Flowlog配置,請刪除后重試。 |
400 | InvalidParameter.LogFormatString | LogFormatString is invalid. | 指定的日志格式不合法。 |
400 | InvalidParameter.LogStoreName | Specified LogStore name is invalid. | Logstore名稱不合法。 |
400 | InvalidParameter.ProjectName | ProjectName is invalid. | Project名稱不合法。 |
400 | OperationFailed.InvalidLogInfo | The entered log service information is invalid. Check whether the ProjectName and LogStoreName are correct, and whether Log Service has been activated. | 輸入的日志服務信息不合法。請確認ProjectName以及LogStoreName是否正確,并確認是否已開通日志服務。 |
400 | IncorrectStatus.TransitRouterInstance | The status of TransitRouter is incorrect. | 轉發路由器狀態不正確。 |
400 | InvalidParameter | Invalid parameter. | 參數不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號無權限操作。 |
403 | NoPermission.AliyunServiceRoleForTRFlowLog | You are not authorized to create service linked role AliyunServiceRoleForTRFlowLog. | 無權限創建服務關聯角色AliyunServiceRoleForTRFlowLog。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-11-22 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-11-14 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-07-02 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-05-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-01-03 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |