1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
api资产列表
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeApiListVersionTwo。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。 |
| Domain | 是 | String | 域名 示例值：qcloudwaf.com |
| PageIndex | 是 | Integer | 页面索引，第几页 示例值：0 |
| PageSize | 是 | Integer | 页面大小 示例值：10 |
| Filters.N | 否 | Array of ApiDataFilter | 过滤条件 示例值：[{"Entity":"waf"}] |
| Sort.N | 否 | Array of String | 排序方法，1 升序，-1 降序 示例值：["update_time":"1"] |
| NeedTotalCount | 否 | Boolean | 是否进行总数查询 示例值：false |
| StartTs | 否 | Integer | 查询开始时间 示例值：1730204365 |
| EndTs | 否 | Integer | 查询结束时间 示例值：1730204365 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of ApiAsset | api资产列表 示例值：[{"Domain":"waf"}] |
| Total | Integer | 总数 示例值：10 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 API资产列表
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApiListVersionTwo
<公共请求参数>
{
"Domain": "qcloudwaf.com",
"Filters": [
{
"Entity": "key",
"Operator": "=",
"Value": "waf"
}
],
"PageIndex": 0,
"PageSize": 0,
"Sort": [
"timestamp"
],
"NeedTotalCount": true,
"StartTs": 0,
"EndTs": 0
}输出示例
{
"Response": {
"Data": [
{
"Domain": "qcloudwaf.com",
"Method": "GET",
"ApiName": "/test/aa",
"Scene": "login",
"Label": [
"login"
],
"Active": true,
"Timestamp": 123131231123,
"InsertTime": 123131312321,
"Mode": "1",
"Level": "300",
"Count": 1,
"Remark": "adasd",
"IsAuth": 0,
"ApiRequestRuleId": 0,
"ApiLimitRuleId": 0
}
],
"Total": 0,
"RequestId": "asdq2we41234123cszd"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.MongoOperationFailed | 操作Mongo数据库失败 |
| UnsupportedOperation | 操作不支持。 |
