1. 接口描述
接口请求域名: cwp.tencentcloudapi.com 。
查询应用防护白名单规则
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeYDRaspBlackWhite。 |
| Version | 是 | String | 公共参数,本接口取值:2018-02-28。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Filters.N | 否 | Array of Filter | 过滤条件。 示例值:[{"WhiteContent":"Name","Values":["dev"]}] |
| Limit | 否 | Integer | 返回数量,默认为10,最大值为100。 示例值:10 |
| Offset | 否 | Integer | 偏移量,默认为0。 示例值:0 |
| By | 否 | String | 排序字段,目前有:CreateTime、ModifyTime,默认按照ModifyTime排序 示例值:ModifyTime |
| Order | 否 | String | 排序升序还是倒序,DESC有ASC、 示例值:ASC |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| List | Array of YDRaspBlackWhiteListItem | 列表内容 |
| TotalCount | Integer | 总条数 示例值:1 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询应用防护白名单列表
输入示例
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeYDRaspBlackWhite
<公共请求参数>
{}
输出示例
{
"Response": {
"List": [
{
"AnnotationsRegexp": "",
"AttackType": 1,
"CWPEffective": 0,
"CWPMachinesNums": "0",
"CWPQuuids": [],
"CWPScope": 0,
"ClassNameRegexp": "",
"Content": "^ldap://([a-zA-Z0-9\\-\\._]+)(?::(\\d+))?(?:/(.*))?$",
"CreateTime": "2025-06-23 14:36:04",
"EksEffective": 1,
"EksMachinesNums": "全部超级节点",
"EksNodeUniqueID": [],
"EksScope": 1,
"FilterType": 0,
"HandleHistory": 0,
"IP": "",
"Id": 287,
"InterfacesRegexp": "",
"LoaderClassNameRegexp": "",
"LogicalSymbol": 0,
"MatchMode": 5,
"ModifyTime": "2025-06-25 15:32:12",
"PolicyName": "漏洞防御-yancyw",
"Source": "rasp",
"Status": 2,
"SuperClassNameRegexp": "",
"TCSSEffective": 0,
"TCSSMachinesNums": "0",
"TCSSQuuids": [],
"TCSSScope": 0
},
{
"AnnotationsRegexp": "test13",
"AttackType": 0,
"CWPEffective": 0,
"CWPMachinesNums": "0",
"CWPQuuids": [],
"CWPScope": 0,
"ClassNameRegexp": "test10",
"Content": "",
"CreateTime": "2025-06-24 20:13:24",
"EksEffective": 0,
"EksMachinesNums": "0",
"EksNodeUniqueID": [],
"EksScope": 0,
"FilterType": 0,
"HandleHistory": 1,
"IP": "",
"Id": 306,
"InterfacesRegexp": "test12",
"LoaderClassNameRegexp": "test14",
"LogicalSymbol": 1,
"MatchMode": 0,
"ModifyTime": "2025-06-24 20:13:24",
"PolicyName": "内存马白名单-2025-06-24",
"Source": "memshell_scan",
"Status": 0,
"SuperClassNameRegexp": "test11",
"TCSSEffective": 0,
"TCSSMachinesNums": "0",
"TCSSQuuids": [],
"TCSSScope": 0
},
{
"AnnotationsRegexp": "test8",
"AttackType": 0,
"CWPEffective": 0,
"CWPMachinesNums": "全部主机",
"CWPQuuids": [
"01fa34d3-db26-48ab-9f14-e8d3a48be95e",
"04ead17d-e148-46e1-aefb-4af725aaad43",
"140d9f26-557d-4588-9cc5-25f8ed39a274",
"155c5720-16bc-4093-b50c-ab8d6a0bc9d8",
"168d1f12-e9f0-44fd-8c8b-dc2437cc47f0",
"1caa6687-0f22-4046-a929-d3cdfe4061f6",
"23ec69fd-a340-4d5d-a830-e167a5ff3616",
"24c9be55-c743-4a75-a5c7-2a2907802256",
"279a6298-c8dd-11eb-a9a7-6e4ad7789d01",
"98113652-0b5e-11ea-83a3-6c0b84d587db"
],
"CWPScope": 1,
"ClassNameRegexp": "test5",
"Content": "",
"CreateTime": "2025-06-24 20:13:04",
"EksEffective": 0,
"EksMachinesNums": "0",
"EksNodeUniqueID": [],
"EksScope": 0,
"FilterType": 0,
"HandleHistory": 1,
"IP": "",
"Id": 305,
"InterfacesRegexp": "test7",
"LoaderClassNameRegexp": "test9",
"LogicalSymbol": 0,
"MatchMode": 0,
"ModifyTime": "2025-06-24 20:13:04",
"PolicyName": "内存马白名单-2025-06-24",
"Source": "memshell_scan",
"Status": 0,
"SuperClassNameRegexp": "test6",
"TCSSEffective": 0,
"TCSSMachinesNums": "0",
"TCSSQuuids": [],
"TCSSScope": 0
},
{
"AnnotationsRegexp": "",
"AttackType": 0,
"CWPEffective": 0,
"CWPMachinesNums": "0",
"CWPQuuids": [],
"CWPScope": 0,
"ClassNameRegexp": "test1",
"Content": "",
"CreateTime": "2025-06-24 20:12:42",
"EksEffective": 0,
"EksMachinesNums": "0",
"EksNodeUniqueID": [],
"EksScope": 0,
"FilterType": 0,
"HandleHistory": 1,
"IP": "",
"Id": 304,
"InterfacesRegexp": "test3",
"LoaderClassNameRegexp": "test5",
"LogicalSymbol": 0,
"MatchMode": 0,
"ModifyTime": "2025-06-24 20:12:42",
"PolicyName": "内存马白名单-2025-06-24",
"Source": "memshell_scan",
"Status": 0,
"SuperClassNameRegexp": "test2",
"TCSSEffective": 0,
"TCSSMachinesNums": "0",
"TCSSQuuids": [],
"TCSSScope": 0
},
{
"AnnotationsRegexp": "",
"AttackType": 0,
"CWPEffective": 0,
"CWPMachinesNums": "0",
"CWPQuuids": [],
"CWPScope": 0,
"ClassNameRegexp": "jsp_servlet\\._config\\._keystore\\.__1750147605303_temp",
"Content": "",
"CreateTime": "2025-06-24 10:39:43",
"EksEffective": 0,
"EksMachinesNums": "0",
"EksNodeUniqueID": [],
"EksScope": 0,
"FilterType": 0,
"HandleHistory": 1,
"IP": "",
"Id": 298,
"InterfacesRegexp": "javax\\.servlet\\.Servlet\\|weblogic\\.servlet\\.jsp\\.StaleIndicator\\|javax\\.servlet\\.jsp\\.HttpJspPage",
"LoaderClassNameRegexp": "",
"LogicalSymbol": 0,
"MatchMode": 0,
"ModifyTime": "2025-06-24 10:39:43",
"PolicyName": "test_old1",
"Source": "memshell_scan",
"Status": 0,
"SuperClassNameRegexp": "weblogic\\.servlet\\.jsp\\.JspBase",
"TCSSEffective": 0,
"TCSSMachinesNums": "0",
"TCSSQuuids": [],
"TCSSScope": 0
},
{
"AnnotationsRegexp": "",
"AttackType": 0,
"CWPEffective": 0,
"CWPMachinesNums": "0",
"CWPQuuids": [],
"CWPScope": 0,
"ClassNameRegexp": "jsp_servlet\\._config\\._keystore\\.__1750147605303_temp",
"Content": "",
"CreateTime": "2025-06-24 10:39:42",
"EksEffective": 0,
"EksMachinesNums": "0",
"EksNodeUniqueID": [],
"EksScope": 0,
"FilterType": 0,
"HandleHistory": 1,
"IP": "",
"Id": 297,
"InterfacesRegexp": "javax\\.servlet\\.Servlet\\|weblogic\\.servlet\\.jsp\\.StaleIndicator\\|javax\\.servlet\\.jsp\\.HttpJspPage",
"LoaderClassNameRegexp": "",
"LogicalSymbol": 0,
"MatchMode": 0,
"ModifyTime": "2025-06-24 10:39:42",
"PolicyName": "test_old1",
"Source": "memshell_scan",
"Status": 0,
"SuperClassNameRegexp": "weblogic\\.servlet\\.jsp\\.JspBase",
"TCSSEffective": 0,
"TCSSMachinesNums": "0",
"TCSSQuuids": [],
"TCSSScope": 0
},
{
"AnnotationsRegexp": "",
"AttackType": 0,
"CWPEffective": 0,
"CWPMachinesNums": "0",
"CWPQuuids": [],
"CWPScope": 0,
"ClassNameRegexp": "jsp_servlet\\._config\\._keystore\\.__1750147605303_temp",
"Content": "",
"CreateTime": "2025-06-24 10:39:41",
"EksEffective": 0,
"EksMachinesNums": "0",
"EksNodeUniqueID": [],
"EksScope": 0,
"FilterType": 0,
"HandleHistory": 1,
"IP": "",
"Id": 296,
"InterfacesRegexp": "javax\\.servlet\\.Servlet\\|weblogic\\.servlet\\.jsp\\.StaleIndicator\\|javax\\.servlet\\.jsp\\.HttpJspPage",
"LoaderClassNameRegexp": "",
"LogicalSymbol": 0,
"MatchMode": 0,
"ModifyTime": "2025-06-24 10:39:41",
"PolicyName": "test_old1",
"Source": "memshell_scan",
"Status": 0,
"SuperClassNameRegexp": "weblogic\\.servlet\\.jsp\\.JspBase",
"TCSSEffective": 0,
"TCSSMachinesNums": "0",
"TCSSQuuids": [],
"TCSSScope": 0
},
{
"AnnotationsRegexp": "",
"AttackType": 0,
"CWPEffective": 0,
"CWPMachinesNums": "0",
"CWPQuuids": [],
"CWPScope": 0,
"ClassNameRegexp": "jsp_servlet\\._config\\._keystore\\.__1750147605303_temp",
"Content": "",
"CreateTime": "2025-06-24 10:39:40",
"EksEffective": 0,
"EksMachinesNums": "0",
"EksNodeUniqueID": [],
"EksScope": 0,
"FilterType": 0,
"HandleHistory": 1,
"IP": "",
"Id": 295,
"InterfacesRegexp": "javax\\.servlet\\.Servlet\\|weblogic\\.servlet\\.jsp\\.StaleIndicator\\|javax\\.servlet\\.jsp\\.HttpJspPage",
"LoaderClassNameRegexp": "",
"LogicalSymbol": 0,
"MatchMode": 0,
"ModifyTime": "2025-06-24 10:39:40",
"PolicyName": "test_old1",
"Source": "memshell_scan",
"Status": 0,
"SuperClassNameRegexp": "weblogic\\.servlet\\.jsp\\.JspBase",
"TCSSEffective": 0,
"TCSSMachinesNums": "0",
"TCSSQuuids": [],
"TCSSScope": 0
},
{
"AnnotationsRegexp": "",
"AttackType": 0,
"CWPEffective": 0,
"CWPMachinesNums": "0",
"CWPQuuids": [],
"CWPScope": 0,
"ClassNameRegexp": "jsp_servlet\\._config\\._keystore\\.__1750147605303_temp",
"Content": "",
"CreateTime": "2025-06-24 10:39:39",
"EksEffective": 0,
"EksMachinesNums": "0",
"EksNodeUniqueID": [],
"EksScope": 0,
"FilterType": 0,
"HandleHistory": 1,
"IP": "",
"Id": 294,
"InterfacesRegexp": "javax\\.servlet\\.Servlet\\|weblogic\\.servlet\\.jsp\\.StaleIndicator\\|javax\\.servlet\\.jsp\\.HttpJspPage",
"LoaderClassNameRegexp": "",
"LogicalSymbol": 0,
"MatchMode": 0,
"ModifyTime": "2025-06-24 10:39:39",
"PolicyName": "test_old1",
"Source": "memshell_scan",
"Status": 0,
"SuperClassNameRegexp": "weblogic\\.servlet\\.jsp\\.JspBase",
"TCSSEffective": 0,
"TCSSMachinesNums": "0",
"TCSSQuuids": [],
"TCSSScope": 0
},
{
"AnnotationsRegexp": "",
"AttackType": 0,
"CWPEffective": 0,
"CWPMachinesNums": "0",
"CWPQuuids": [],
"CWPScope": 0,
"ClassNameRegexp": "jsp_servlet\\._config\\._keystore\\.__1750147605303_temp",
"Content": "",
"CreateTime": "2025-06-24 10:39:39",
"EksEffective": 0,
"EksMachinesNums": "0",
"EksNodeUniqueID": [],
"EksScope": 0,
"FilterType": 0,
"HandleHistory": 1,
"IP": "",
"Id": 293,
"InterfacesRegexp": "javax\\.servlet\\.Servlet\\|weblogic\\.servlet\\.jsp\\.StaleIndicator\\|javax\\.servlet\\.jsp\\.HttpJspPage",
"LoaderClassNameRegexp": "",
"LogicalSymbol": 0,
"MatchMode": 0,
"ModifyTime": "2025-06-24 10:39:39",
"PolicyName": "test_old1",
"Source": "memshell_scan",
"Status": 0,
"SuperClassNameRegexp": "weblogic\\.servlet\\.jsp\\.JspBase",
"TCSSEffective": 0,
"TCSSMachinesNums": "0",
"TCSSQuuids": [],
"TCSSScope": 0
}
],
"RequestId": "61209031-57f0-4772-b0cd-60c4bfdf9dae",
"TotalCount": 13
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.DateRange | 时间区间格式错误。 |
| InvalidParameter.IllegalRequest | 非法请求。 |
| InvalidParameter.InvalidFormat | 参数格式错误。 |
| InvalidParameter.MissingParameter | 参数缺失。 |
| InvalidParameter.ParsingError | 参数解析错误。 |
| InvalidParameter.RegexRuleError | 正则参数格式错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded.AreaQuota | 超出批量添加数量。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |