1. 接口描述
接口请求域名: waf.tencentcloudapi.com 。
本接口用于获取访问日志导出列表
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAccessExports。 |
Version | 是 | String | 公共参数,本接口取值:2018-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-seoul 。 |
TopicId | 是 | String | 客户要查询的日志主题ID,每个客户都有对应的一个主题 示例值:"1ae37c76-df99-4e2b-998c-20f39eba6226" |
Offset | 否 | Integer | 分页的偏移量,默认值为0 示例值:0 |
Limit | 否 | Integer | 分页单页限制数目,默认值为20,最大值100 示例值:100 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 日志导出ID。 示例值:1 |
Exports | Array of ExportAccessInfo | 日志导出列表 示例值:[{"ExportId":"export-61daca5c-f341-4796-aeb3-4f2f598a06c7","Query":"*","FileName":"log_100005604621_1ae37c76-df99-4e2b-998c-20f39eba6226_20210713_export-61daca5c-f341-4796-aeb3-4f2f598a06c7_1626174454.tar.gz","FileSize":279519,"Order":"desc","Format":"json","Count":6221,"Status":"Completed","From":1625395948532,"To":1626000748532,"CosPath":"https://export-cd-1254077820.cos.ap-chengdu.myqcloud.com/%2Fexport%2F20210713%2Flog_100005604621_1ae37c76-df99-4e2b-998c-20f39eba6226_20210713_export-61daca5c-f341-4796-aeb3-4f2f598a06c7_1626174454.tar.gz?q-sign-algorithm=sha1&q-ak=xxx&q-sign-time=1626175178%3B1626178778&q-key-time=1626175178%3B1626178778&q-header-list=host&q-url-param-list=&q-signature=ebb37d76834b5be4ff0c8bfa263d88d1adf5685d","CreateTime":"2021-07-13 19:07:15"}] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取访问日志导出列表
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccessExports
<公共请求参数>
{
"TopicId": "1ae37c76-df99-4e2b-998c-20f39eba6226"
}
输出示例
{
"Response": {
"Exports": [
{
"ExportId": "export-61daca5c-f341-4796-aeb3-4f2f598a06c7",
"Query": "bot:1",
"FileName": "log_100005604621_1ae37c76-df99-4e2b-998c-20f39eba6226_20210713_export-61daca5c-f341-4796-aeb3-4f2f598a06c7_1626174454.tar.gz",
"FileSize": 279519,
"Order": "desc",
"Format": "json",
"Count": 6221,
"Status": "Completed",
"From": 1625395948532,
"To": 1626000748532,
"CosPath": "https://export-cd-1254077820.cos.ap-chengdu.myqcloud.com/%2Fexport%2F20210713%2Flog_100005604621_1ae37c76-df99-4e2b-998c-20f39eba6226_20210713_export-61daca5c-f341-4796-aeb3-4f2f598a06c7_1626174454.tar.gz?q-sign-algorithm=sha1&q-ak=xxx&q-sign-time=1626175178%3B1626178778&q-key-time=1626175178%3B1626178778&q-header-list=host&q-url-param-list=&q-signature=ebb37d76834b5be4ff0c8bfa263d88d1adf5685d",
"CreateTime": "2021-07-13 19:07:15"
}
],
"TotalCount": 1,
"RequestId": "9b02bf9e-c89c-42c3-9ae1-685f968fa02d"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
FailedOperation.CLSInternalError | CLS内部错误。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidCertificate | 证书内容非法。 |
InvalidParameter.QueryCertBySSLIDFailed | 根据ID查询证书失败。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |