You need to enable JavaScript to run this app.
导航
全球加速
  • 文档首页
    • /
  • 全球加速

DescribeListenerLogs

最近更新时间：2024.04.11 17:57:13

首次发布时间：2022.09.01 11:30:07

我的收藏

API说明

API 名称：DescribeListenerLogs。
API 域名：open.volcengineapi.com 。
API 描述：查询监听的访问日志列表。

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称类型是否必选格式说明
Action
string
是
[a-zA-Z]+
API 名称。
Versionstring是YYYY-MM-DDAPI 版本信息。该参数的取值是 2022-03-01 。

请求正文

在使用该 API 提交请求时，请求正文中可以包含的参数如下。

参数类型是否必选参数说明示例
ListenerId

string

是
指定查询哪个监听所属的日志，为单个监听ID。
listener-bnZuwNohUKyi9x7vsxiNXX
StartTimestring是查询起始时间，但不能为30天前的时间。2019-12-13 00:00:00

EndTime

string

是

  • 查询结束时间，但不能为30天前的时间。
  • 结束时间需大于起始时间，不限制时间范围。

2019-12-13 23:59:59

PageNumint是分页查询时指定的页码，为1到100000的整数。10
PageSizeint是分页查询时每页显示的数量，为1到1000的整数。20

响应正文

参数类型参数说明示例
Total
int
共有多少条数据
10
PageNumint分页查询，页码。1
PageSizeint分页查询，每页数量。10
FileListsList of FileList日志文件的信息。见 FileList

FileList

参数类型参数说明示例
ListenerId
string
查询监听 ID 。

listener-bnZuwNohUKyi9x7vsxiNXX

StartTimestring文件开始时间，包含设定时间值。2021-05-21 05:21:00
EndTimestring文件结束时间，不包含设定时间值。2021-05-21 05:21:00
FileNamestring文件名称。123456789_20220806150000_20220806160000.gz
FilePathstring文件下载地址。
https://cdnlog.volces.com/ipa-openapi/userlog2/file-download/v1?fileName=listener-name-FSc2363mYwZ7FSd3PawbynAVf.snssdk.com_20220809160000_20220809170000.gz&token=e28db947dd8a407f50a5ce278aed8c42d5b655ba78465db7f749482759e2719c8d8f1125cc650f2e6a54c66fc0e81d7f6d87181d704b335b509e21b2f949c17c
FileSizefloat文件大小，单位Byte。29270

示例

请求示例

POST https://open.volcengineapi.com/?Version=2022-03-01&Action=DescribeListenerLogs&<其他公共请求参数>
{
    "PageSize": 2,
    "PageNum": 1,
    "StartTime": "2022-08-06 00:00:00",
    "EndTime": "2022-08-06 17:06:28",
    "ListenerId": "listener-bnZuwNohUKyi9x7vsxiNXX"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202208061707170102252431390139DC4F",
        "Action": "DescribeListenerLogs",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "FilesCount": 16,
        "FileLists": [
            {
                "ListenerId": "listener-bnZuwNohUKyi9x7vsxiNXX",
                "StartTime": "2022-08-06 15:00:00",
                "EndTime": "2022-08-06 16:00:00",
                "FileName": "123456789_20220806150000_20220806160000.gz",
                "FilePath": "https://cdnlog.volces.com/ipa-openapi/userlog2/file-download/v1?fileName=listener-name-FSc2363mYwZ7FSd3PawbynAVf.snssdk.com_20220809160000_20220809170000.gz&token=e28db947dd8a407f50a5ce278aed8c42d5b655ba78465db7f749482759e2719c8d8f1125cc650f2e6a54c66fc0e81d7f6d87181d704b335b509e21b2f949c17c",
                "FileSize": 29053
            },
            {
                "ListenerId": "listener-bnZuwNohUKyi9x7vsxiNXX",
                "StartTime": "2022-08-06 14:00:00",
                "EndTime": "2022-08-06 15:00:00",
                "FileName": "123456789_20220806140000_20220806150000.gz",
                "FilePath": "https://cdnlog.volces.com/ipa-openapi/userlog2/file-download/v1?fileName=listener-name-FSc236mYwZ7FSd3PawbynAVf.snssdk.com_20220809150000_20220809160000.gz&token=e28db947dd8a407f50a5ce278aed8c42d5b655ba78465db7f749482759e2719c8d8f1125cc650f2e6a54c66fc0e81d7f6d87181d704b335b509e21b2f949c17c",
                "FileSize": 29270
            }
        ],
        "PageNum": 1,
        "PageSize": 2
    }
}