1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
查询用户所有实例的详细信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。 |
| Offset | 是 | Integer | 偏移量 示例值：1 |
| Limit | 是 | Integer | 容量 示例值：20 |
| Filters.N | 否 | Array of FiltersItemNew | 过滤数组 示例值：[{"Name":"Region","Values":["ap-chengdu"],"ExactMatch":true},{"Name":"Edition","Values":["sparta-waf"],"ExactMatch":true}] |
| FreeDelayFlag | 否 | Integer | 释放延期标识 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总数 示例值：1 |
| Instances | Array of InstanceInfo | instance列表 示例值：[{"AppId":1256704386,"InstanceId":"waf_2kw60zgy0908e8j3","InstanceName":"广州双栈集群企业版","ResourceIds":"waf_2kw60zgy0908e8j3","Edition":"sparta-waf","Region":"gz","PayMode":1,"Status":0,"RenewFlag":1,"AttackLogPost":1,"Level":3,"ElasticBilling":100000,"ValidTime":"2024-12-01 15:27:23","BeginTime":"2022-09-01 15:27:23","SubDomainLimit":30,"MainDomainLimit":3,"APISecurity":1,"IsAPISecurityTrial":0,"BillingItem":"sv_wsm_waf_package_enterprise","FreeDelayFlag":0,"Mode":1,"DomainCount":18,"MainDomainCount":3,"MaxQPS":50,"MaxBandwidth":203021,"QPS":{"ResourceIds":"","ValidTime":"","RenewFlag":0,"Count":0,"Region":"","BillingItem":""},"BotQPS":{"ResourceIds":"","ValidTime":"","Count":0,"Region":"","MaxBotQPS":50,"RenewFlag":0},"DomainPkg":{"ResourceIds":"","ValidTime":"","RenewFlag":0,"Count":0,"Region":""},"BotPkg":{"ResourceIds":"waf_2kw60zgy0908e8j3","Status":1,"Region":1,"BeginTime":"2022-01-05 15:38:04","EndTime":"2022-01-15 15:38:04","Type":"sv_wsm_waf_scene_bot","InquireNum":1,"UsedNum":0,"RenewFlag":0,"BotCPWaf":0,"BotNPWaf":0,"IsBotTrial":0},"FraudPkg":{"ResourceIds":"waf_2kw60zgy0908e8j3_0_fraud","Status":1,"Region":1,"BeginTime":"2024-06-19 19:22:59","EndTime":"2024-12-01 19:22:59","InquireNum":5000,"UsedNum":37,"RenewFlag":1},"MajorEventsPkg":{"ResourceIds":"","Status":0,"Region":0,"BeginTime":"","EndTime":"","InquireNum":0,"UsedNum":0,"BillingItem":"","RenewFlag":0,"HWState":0},"HybridPkg":{"ResourceIds":"","Status":0,"Region":0,"BeginTime":"","EndTime":"","InquireNum":0,"UsedNum":0,"RenewFlag":0},"ApiPkg":{"ResourceIds":"waf_2kw60zgy0908e8j3_0_api","Status":1,"Region":1,"BeginTime":"2024-04-23 00:01:51","EndTime":"2024-12-01 00:01:51","InquireNum":1,"UsedNum":0,"BillingItem":"sv_wsm_waf_scene_ent","RenewFlag":1,"APICPWaf":0,"APINPWaf":0,"IsAPISecurityTrial":0},"MiniPkg":{"ResourceIds":"waf_2kw60zgy0908e8j3_1_mini","Status":1,"Region":1,"BeginTime":"2024-04-11 11:31:01","EndTime":"2024-12-01 11:31:01","Count":5,"BillingItem":"sv_wsm_waf_scene_mini","RenewFlag":1,"AccessAppidNum":4,"DdosThreshold":300,"ElasticMode":1,"ElasticBilling":473000},"MiniExtendPkg":{"ResourceIds":"waf_2kw60zgy0908e8j3_0_mini_extend","Status":1,"Region":1,"BeginTime":"2024-05-30 23:35:08","EndTime":"2024-12-01 23:35:08","Count":1,"BillingItem":"sv_wsm_waf_exp_exp","RenewFlag":1},"QpsStandard":105000,"BandwidthStandard":2600,"SandboxQps":115000,"LastQpsExceedTime":"","MiniQpsStandard":473500,"MiniMaxQPS":2}] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询用户所有实例的详细信息
查询用户所有实例的详细信息
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<公共请求参数>
{
"Offset": 1,
"Limit": 20,
"Filters": [
{
"Name": "Edition",
"Values": [],
"ExactMatch": true
},
{
"Name": "Region",
"Values": [
"ap-beijing",
"ap-guangzhou"
],
"ExactMatch": true
},
{
"Name": "InstanceName",
"Values": [
"实例"
],
"ExactMatch": false
},
{
"Name": "InstanceId",
"Values": [
"waf"
],
"ExactMatch": false
}
]
}输出示例
{
"Response": {
"RequestId": "d206a27c-2c9c-4ac8-a9e0-6cdf4703247c",
"Total": 2,
"Instances": [
{
"AppId": 87524381,
"InstanceId": "waf_2kw60zgy0908e8j3",
"InstanceName": "广州双栈集群企业版",
"ResourceIds": "waf_2kw60zgy0908e8j3",
"Edition": "sparta-waf",
"Region": "gz",
"PayMode": 1,
"Status": 0,
"RenewFlag": 1,
"AttackLogPost": 1,
"Level": 3,
"ElasticBilling": 100000,
"ValidTime": "2024-11-01 15:27:23",
"BeginTime": "2022-09-01 15:27:23",
"SubDomainLimit": 30,
"MainDomainLimit": 3,
"APISecurity": 1,
"IsAPISecurityTrial": 0,
"BillingItem": "sv_wsm_waf_package_enterprise",
"FreeDelayFlag": 0,
"Mode": 1,
"DomainCount": 19,
"MainDomainCount": 3,
"MaxQPS": 50,
"MaxBandwidth": 203021,
"QPS": {
"ResourceIds": "waf_2kw60zgy0908e8j3_qps",
"ValidTime": "2024-11-01 15:27:23",
"RenewFlag": 0,
"Count": 0,
"Region": "gz",
"BillingItem": "sv_wsm_waf_package_enterprise"
},
"BotQPS": {
"ResourceIds": "waf_2kw60zgy0908e8j3_0_botqps",
"ValidTime": "2024-11-01 15:27:23",
"Count": 0,
"Region": "gz",
"MaxBotQPS": 50,
"RenewFlag": 0
},
"DomainPkg": {
"ResourceIds": "waf_2kw60zgy0908e8j3_domain",
"ValidTime": "2024-11-01 15:27:23",
"RenewFlag": 0,
"Count": 1,
"Region": "gz"
},
"BotPkg": {
"ResourceIds": "waf_2kw60zgy0908e8j3_0_bot",
"Status": 1,
"Region": 1,
"BeginTime": "2022-01-05 15:38:04",
"EndTime": "2025-01-15 15:38:04",
"Type": "sv_wsm_waf_scene_bot",
"InquireNum": 1,
"UsedNum": 0,
"RenewFlag": 0,
"BotCPWaf": 0,
"BotNPWaf": 0,
"IsBotTrial": 0
},
"FraudPkg": {
"ResourceIds": "waf_2kw60zgy0908e8j3_0_fraud",
"Status": 1,
"Region": 1,
"BeginTime": "2024-06-19 19:22:59",
"EndTime": "2024-11-01 19:22:59",
"InquireNum": 5000,
"UsedNum": 37,
"RenewFlag": 1
},
"MajorEventsPkg": {
"ResourceIds": "waf_2kw60zgy0908e8j3_0_major_events",
"Status": 1,
"Region": 1,
"BeginTime": "2024-05-16 16:57:16",
"EndTime": "2024-08-16 16:57:16",
"InquireNum": 1000,
"UsedNum": 0,
"BillingItem": "sv_wsm_waf_scene_major_events_basic",
"RenewFlag": 0,
"HWState": 3
},
"HybridPkg": {
"ResourceIds": "waf_2kw60zgy0908e8j3_0_hcn",
"Status": 0,
"Region": 0,
"BeginTime": "2024-05-16 16:57:16",
"EndTime": "2024-08-16 16:57:16",
"InquireNum": 0,
"UsedNum": 0,
"RenewFlag": 0
},
"ApiPkg": {
"ResourceIds": "waf_2kw60zgy0908e8j3_0_api",
"Status": 1,
"Region": 1,
"BeginTime": "2024-04-23 00:01:51",
"EndTime": "2024-11-01 00:01:51",
"InquireNum": 1,
"UsedNum": 0,
"BillingItem": "sv_wsm_waf_scene_ent",
"RenewFlag": 1,
"IsAPISecurityTrial": 0
},
"MiniPkg": {
"ResourceIds": "waf_2kw60zgy0908e8j3_1_mini",
"Status": 1,
"Region": 1,
"BeginTime": "2024-04-11 11:31:01",
"EndTime": "2024-11-01 11:31:01",
"Count": 5,
"BillingItem": "sv_wsm_waf_scene_mini",
"RenewFlag": 1
},
"MiniExtendPkg": {
"ResourceIds": "waf_2kw60zgy0908e8j3_0_mini_extend",
"Status": 1,
"Region": 1,
"BeginTime": "2024-05-30 23:35:08",
"EndTime": "2024-11-01 23:35:08",
"Count": 1,
"BillingItem": "sv_wsm_waf_exp_exp",
"RenewFlag": 1
},
"QpsStandard": 105000,
"BandwidthStandard": 2600,
"SandboxQps": 115000,
"LastQpsExceedTime": "2024-11-01 23:35:08",
"MiniQpsStandard": 473500,
"MiniMaxQPS": 1
},
{
"AppId": 87524381,
"InstanceId": "waf_2kuil2fm02vqm7z3",
"InstanceName": "gz-Default1",
"ResourceIds": "waf_2kuil2fm02vqm7z3",
"Edition": "clb-waf",
"Region": "cd,cq,gz,bj",
"PayMode": 1,
"Status": 0,
"RenewFlag": 1,
"AttackLogPost": 1,
"Level": 3,
"ElasticBilling": 2510000,
"ValidTime": "2024-11-28 16:35:25",
"BeginTime": "2021-09-17 16:35:25",
"SubDomainLimit": 130,
"MainDomainLimit": 13,
"APISecurity": 1,
"IsAPISecurityTrial": 0,
"BillingItem": "sv_wsm_waf_package_enterprise_clb",
"FreeDelayFlag": 0,
"Mode": 0,
"DomainCount": 24,
"MainDomainCount": 6,
"MaxQPS": 24,
"MaxBandwidth": 52091,
"QPS": {
"ResourceIds": "waf_2kuil2fm02vqm7z3_qps",
"ValidTime": "2024-11-18 21:22:10",
"RenewFlag": 1,
"Count": 1000,
"Region": "gz",
"BillingItem": "sv_wsm_waf_qps_ep_clb"
},
"BotQPS": {
"ResourceIds": "waf_2kuil2fm02vqm7z3_0_botqps",
"ValidTime": "2024-11-01 15:27:23",
"Count": 0,
"Region": "gz",
"MaxBotQPS": 50,
"RenewFlag": 0
},
"DomainPkg": {
"ResourceIds": "waf_2kw60zgy0908e8j3_domain",
"ValidTime": "2024-11-01 15:27:23",
"RenewFlag": 0,
"Count": 1,
"Region": "gz"
},
"BotPkg": {
"ResourceIds": "waf_2kuil2fm02vqm7z3_0_bot",
"Status": 1,
"Region": 1,
"BeginTime": "2022-01-05 15:38:04",
"EndTime": "2022-01-15 15:38:04",
"Type": "sv_wsm_waf_scene_bot",
"InquireNum": 1,
"UsedNum": 0,
"RenewFlag": 0,
"BotCPWaf": 0,
"BotNPWaf": 0,
"IsBotTrial": 0
},
"FraudPkg": {
"ResourceIds": "waf_2kuil2fm02vqm7z3_0_fraud",
"Status": 1,
"Region": 1,
"BeginTime": "2024-06-19 19:22:59",
"EndTime": "2024-11-01 19:22:59",
"InquireNum": 5000,
"UsedNum": 37,
"RenewFlag": 1
},
"MajorEventsPkg": {
"ResourceIds": "waf_2kuil2fm02vqm7z3_0_major_events",
"Status": 1,
"Region": 1,
"BeginTime": "2024-05-16 16:57:16",
"EndTime": "2024-08-16 16:57:16",
"InquireNum": 1000,
"UsedNum": 0,
"BillingItem": "sv_wsm_waf_scene_major_events_basic",
"RenewFlag": 0,
"HWState": 3
},
"HybridPkg": {
"ResourceIds": "waf_2kuil2fm02vqm7z3_0_hcn",
"Status": 0,
"Region": 1,
"BeginTime": "2023-09-29 11:16:20",
"EndTime": "2024-09-29 11:16:20",
"InquireNum": 1,
"UsedNum": 0,
"RenewFlag": 0
},
"ApiPkg": {
"ResourceIds": "waf_2kuil2fm02vqm7z3_api",
"Status": 1,
"Region": 1,
"BeginTime": "2023-11-06 20:34:31",
"EndTime": "2024-11-18 16:35:25",
"InquireNum": 1,
"UsedNum": 0,
"BillingItem": "sv_wsm_waf_scene_cent",
"RenewFlag": 1,
"IsAPISecurityTrial": 0
},
"MiniPkg": {
"ResourceIds": "waf_2kuil2fm02vqm7z3_1_mini",
"Status": 1,
"Region": 1,
"BeginTime": "2024-04-11 11:31:01",
"EndTime": "2024-11-01 11:31:01",
"Count": 5,
"BillingItem": "sv_wsm_waf_scene_mini",
"RenewFlag": 1
},
"MiniExtendPkg": {
"ResourceIds": "waf_2kuil2fm02vqm7z3_0_mini_extend",
"Status": 1,
"Region": 1,
"BeginTime": "2024-05-30 23:35:08",
"EndTime": "2024-11-01 23:35:08",
"Count": 1,
"BillingItem": "sv_wsm_waf_exp_exp",
"RenewFlag": 1
},
"QpsStandard": 11000,
"BandwidthStandard": 350,
"SandboxQps": 18000,
"LastQpsExceedTime": "2024-11-01 23:35:08",
"MiniQpsStandard": 0,
"MiniMaxQPS": 0
}
]
}
}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签名/鉴权错误。 |
| DryRunOperation | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidCertificate | 证书内容非法。 |
| InvalidParameter.QueryCertBySSLIDFailed | 根据ID查询证书失败。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
