1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
本接口用于获取访问日志索引配置信息
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAccessIndex。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul 。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Status | Boolean | 是否生效，true表示生效，false表示未生效 示例值：true |
| Rule | AccessRuleInfo | 索引配置信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"FullText":{"CaseSensitive":true,"Tokenizer":"!@#%^&*()-="', <>/?|\;:\n\t\r[]{}","ContainZH":false},"KeyValue":{"CaseSensitive":false,"KeyValues":[{"Key":"method","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"schema","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"host","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"url","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"client","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"status","Value":{"Type":"long","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"upstreamstatus","Value":{"Type":"long","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"user_agent","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"x_forwarded_for","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"referer","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"domain","Value":{"Type":"text","Tokenizer":"","SqlFlag":true,"ContainZH":false}},{"Key":"cookie","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"body","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"uuid","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}},{"Key":"query","Value":{"Type":"text","Tokenizer":"","SqlFlag":false,"ContainZH":false}}]}} |
| ModifyTime | String | 索引修改时间，初始值为索引创建时间。 示例值：2021-06-18 16:02:20 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 访问日志索引配置信息
访问日志索引配置信息
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccessIndex
<公共请求参数>
{}输出示例
{
"Response": {
"Status": true,
"Rule": {
"FullText": null,
"KeyValue": {
"CaseSensitive": false,
"KeyValues": [
{
"Key": "bot_action",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "bot_ai",
"Value": {
"Type": "long",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "bot_label",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "bot_module",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "bot_scene_id",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": false,
"ContainZH": false
}
},
{
"Key": "bot_score",
"Value": {
"Type": "long",
"Tokenizer": "token",
"SqlFlag": false,
"ContainZH": false
}
},
{
"Key": "bot_stat",
"Value": {
"Type": "long",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "bot_ti_tags",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": false,
"ContainZH": false
}
},
{
"Key": "bot_token",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "bot_ua",
"Value": {
"Type": "long",
"Tokenizer": "token",
"SqlFlag": false,
"ContainZH": false
}
},
{
"Key": "bytes_sent",
"Value": {
"Type": "long",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "client",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "cookie",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": false,
"ContainZH": false
}
},
{
"Key": "domain",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "headers",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": false,
"ContainZH": false
}
},
{
"Key": "host",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "instance",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": false,
"ContainZH": false
}
},
{
"Key": "ipinfo_city",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "ipinfo_isp",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "ipinfo_nation",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "ipinfo_province",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "ipinfo_state",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "method",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "query",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": false,
"ContainZH": false
}
},
{
"Key": "referer",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": false,
"ContainZH": false
}
},
{
"Key": "request_time",
"Value": {
"Type": "double",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "schema",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "sec_chain",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": false,
"ContainZH": false
}
},
{
"Key": "status",
"Value": {
"Type": "long",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "ua_goodbot",
"Value": {
"Type": "long",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "ua_type",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "upstream",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "upstream_connect_time",
"Value": {
"Type": "double",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "upstream_response_time",
"Value": {
"Type": "double",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "upstream_status",
"Value": {
"Type": "long",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "url",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "user_agent",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": true,
"ContainZH": false
}
},
{
"Key": "uuid",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": false,
"ContainZH": false
}
},
{
"Key": "x_forwarded_for",
"Value": {
"Type": "text",
"Tokenizer": "token",
"SqlFlag": false,
"ContainZH": false
}
}
]
},
"Tag": null
},
"ModifyTime": "2024-10-24 22:15:00",
"RequestId": "5ccd823d-ede6-4f21-b520-0db96a19f5f1"
}
}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 | 操作不支持。 |
