查詢流日志。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫(xiě)入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
cen:DescribeFlowlogs | get | *Flowlog acs:cbn:{#regionId}:{#accountId}:flowlog/* *Flowlog acs:cbn:{#regionId}:{#accountId}:flowlog/{#FlowLogId} |
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客戶端 Token,用于保證請(qǐng)求的冪等性。 從您的客戶端生成一個(gè)參數(shù)值,確保不同請(qǐng)求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 說(shuō)明
若您未指定,則系統(tǒng)自動(dòng)使用 API 請(qǐng)求的 RequestId 作為 ClientToken 標(biāo)識(shí)。每次 API 請(qǐng)求的 RequestId 可能不一樣。
| 123e4567-e89b-12d3-a456-42665544**** |
RegionId | string | 否 | 流日志所屬地域 ID。 您可以通過(guò)調(diào)用 DescribeChildInstanceRegions 接口獲取地域 ID。 | cn-hangzhou |
FlowLogName | string | 否 | 流日志的名稱。 名稱可以為空或長(zhǎng)度為 1~128 個(gè)字符,不能以 http://或 https://開(kāi)頭。 | myFlowlog |
FlowLogId | string | 否 | 流日志 ID。 | flowlog-m5evbtbpt**** |
Description | string | 否 | 流日志的描述信息。 描述可以為空或長(zhǎng)度為 1~256 個(gè)字符,不能以 http://或 https://開(kāi)頭。 | myFlowlog |
CenId | string | 否 | 云企業(yè)網(wǎng)實(shí)例 ID。 | cen-7qthudw0ll6jmc**** |
ProjectName | string | 否 | 存儲(chǔ)捕獲流量的 Project 名稱。 Project 名稱長(zhǎng)度為 3~63 字符,必須以小寫(xiě)字母或者數(shù)字開(kāi)頭和結(jié)尾,只能包括小寫(xiě)字母、數(shù)字和短劃線(-)。 | FlowLogProject |
LogStoreName | string | 否 | 存儲(chǔ)捕獲流量的 LogStore 名稱。 Logstore 名稱長(zhǎng)度為 3~63 字符,必須以小寫(xiě)字母或者數(shù)字開(kāi)頭和結(jié)尾,只能包括小寫(xiě)字母、數(shù)字、短劃線(-)和下劃線(_)。 | FlowLogStore |
Status | string | 否 | 流日志的狀態(tài)。取值:
| Active |
PageNumber | integer | 否 | 列表的頁(yè)碼。默認(rèn)值:1。 | 1 |
PageSize | integer | 否 | 分頁(yè)查詢時(shí)每頁(yè)的條目數(shù)。最小值:1。默認(rèn)值:20。 | 20 |
Tag | array<object> | 否 | 標(biāo)簽信息。 一次最多支持輸入 20 個(gè)標(biāo)簽信息。 | |
object | 否 | |||
Key | string | 否 | 資源的標(biāo)簽鍵。 一旦傳入該值,則不允許為空字符串。最多支持 64 個(gè)字符,不能以 一次最多支持輸入 20 個(gè)標(biāo)簽的標(biāo)簽鍵。 | TagKey |
Value | string | 否 | 資源的標(biāo)簽值。 標(biāo)簽值可以為空或輸入不超過(guò) 128 個(gè)字符的字符串,不能以 每一個(gè)標(biāo)簽鍵對(duì)應(yīng)一個(gè)標(biāo)簽值,一次最多支持輸入 20 個(gè)標(biāo)簽鍵對(duì)應(yīng)的標(biāo)簽值。 | TagValue |
TransitRouterAttachmentId | string | 否 | 網(wǎng)絡(luò)實(shí)例連接 ID。 | tr-attach-qieks13jnt1cchy*** |
TransitRouterId | string | 否 | 轉(zhuǎn)發(fā)路由器實(shí)例 ID。 | tr-uf654ttymmljlvh2x**** |
Interval | integer | 否 | 流日志捕獲流量的捕獲窗口時(shí)長(zhǎng)。單位:秒。取值:60 或 600。默認(rèn)值:600。 | 600 |
FlowLogVersion | string | 否 | 流日志的版本。 創(chuàng)建流日志時(shí)自動(dòng)使用系統(tǒng)支持的最新版本,當(dāng)前為 3。 | 3 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"PageSize": "20",
"PageNumber": "1",
"RequestId": "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1",
"TotalCount": "1",
"Success": "true",
"FlowLogs": {
"FlowLog": [
{
"Status": "Active",
"CreationTime": "2021-07-24T13:00:52Z",
"FlowLogName": "myFlowlog",
"Description": "myFlowlog",
"ProjectName": "FlowLogProject",
"CenId": "cen-7qthudw0ll6jmc****",
"LogStoreName": "FlowLogStore",
"RegionId": "cn-hangzhou",
"FlowLogId": "flowlog-m5evbtbpt****",
"TransitRouterAttachmentId": "tr-attach-5x4o4ynzuqbv6g****",
"TransitRouterId": "tr-bp1g9313sx675zr1lajmj",
"LogFormatString": "${srcaddr}${dstaddr}${bytes}",
"FlowLogVersion": "3",
"Interval": 60,
"Tags": {
"Tag": [
{
"Key": "TagKey",
"Value": "TagValue"
}
]
}
}
]
}
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | OperationUnsupported.action | This action is not support. | 當(dāng)前地域不支持該操作。 |
400 | InvalidFlowlogId.NotFound | The specified flowlog id does not exist or does not match the cen Id. | 參數(shù)中指定的flowlog不存在。 |
400 | IllegalParam.TagValue | The tag values are not valid. | 參數(shù)中指定的tag value不合法。 |
400 | IllegalParam.TagKey | The tag keys are not valid. | 參數(shù)中指定的tag key不合法。 |
400 | InvalidDescription | Description is invalid. | 描述不合法。 |
400 | InvalidName | Name is invalid. | name不合法。 |
400 | InvalidParameter.Interval | Interval is invalid. | 指定的采樣頻率不合法。 |
400 | InvalidParameter.FlowLogVersion | Flowlog version is invalid. | 指定的flowlog版本不合法。 |
400 | InvalidParameter | Invalid parameter. | 參數(shù)不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號(hào)無(wú)權(quán)限操作。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-11-14 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2024-05-22 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2023-12-13 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2023-01-09 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2022-12-02 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2022-09-14 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2022-09-14 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |