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 | 过滤数组 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总数 示例值：2 |
| Instances | Array of InstanceInfo | instance列表 |
| 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": "b7984267-1b60-4979-accb-8f1ca497f827",
"Total": 11,
"Instances": [
{
"AppId": 251197211,
"InstanceId": "waf_2kuj4t1k00awo4gp",
"InstanceName": "gz-Default",
"ResourceIds": "waf_2kuj4t1k00awo4gp",
"Edition": "sparta-waf",
"Region": "gz",
"PayMode": 1,
"RenewFlag": 1,
"Level": 4,
"ValidTime": "2021-11-09 10:37:20",
"BeginTime": "0001-01-01 00:00:00",
"SubDomainLimit": 40,
"MainDomainLimit": 4,
"Mode": 0,
"DomainCount": 6,
"MainDomainCount": 2,
"MaxQPS": 0,
"QPS": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"DomainPkg": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"BotPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
},
"FraudPkg": {
"ResourceIds": "",
"Status": 1,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
}
},
{
"AppId": 251197211,
"InstanceId": "waf_2kui15ko00a19t0r",
"InstanceName": "cd-Default",
"ResourceIds": "waf_2kui15ko00a19t0r",
"Edition": "sparta-waf",
"Region": "cd",
"PayMode": 1,
"RenewFlag": 1,
"Level": 4,
"ValidTime": "2021-09-24 15:34:09",
"BeginTime": "0001-01-01 00:00:00",
"SubDomainLimit": 40,
"MainDomainLimit": 4,
"Mode": 0,
"DomainCount": 7,
"MainDomainCount": 1,
"MaxQPS": 0,
"QPS": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"DomainPkg": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"BotPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
},
"FraudPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
}
},
{
"AppId": 251197211,
"InstanceId": "waf_2kui15ko00a19pwt",
"InstanceName": "gz-Default",
"ResourceIds": "waf_2kui15ko00a19pwt",
"Edition": "sparta-waf",
"Region": "gz",
"PayMode": 1,
"RenewFlag": 1,
"Level": 4,
"ValidTime": "2021-09-24 15:30:15",
"BeginTime": "0001-01-01 00:00:00",
"SubDomainLimit": 40,
"MainDomainLimit": 4,
"Mode": 0,
"DomainCount": 1,
"MainDomainCount": 1,
"MaxQPS": 0,
"QPS": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"DomainPkg": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"BotPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
},
"FraudPkg": {
"ResourceIds": "",
"Status": 1,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
}
},
{
"AppId": 251197211,
"InstanceId": "waf_2kui15ko00a19p7j",
"InstanceName": "测试删除域名",
"ResourceIds": "waf_2kui15ko00a19p7j",
"Edition": "sparta-waf",
"Region": "cd",
"PayMode": 1,
"RenewFlag": 1,
"Level": 4,
"ValidTime": "2022-09-24 15:28:34",
"BeginTime": "0001-01-01 00:00:00",
"SubDomainLimit": 40,
"MainDomainLimit": 4,
"Mode": 0,
"DomainCount": 2,
"MainDomainCount": 2,
"MaxQPS": 0,
"QPS": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"DomainPkg": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"BotPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
},
"FraudPkg": {
"ResourceIds": "",
"Status": 1,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
}
},
{
"AppId": 251197211,
"InstanceId": "waf_2kuhdsiw008rwhxt",
"InstanceName": "gz-Defaultssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssss",
"ResourceIds": "waf_2kuhdsiw008rwhxt",
"Edition": "clb-waf",
"Region": "",
"PayMode": 1,
"RenewFlag": 1,
"Level": 4,
"ValidTime": "2021-08-15 14:21:58",
"BeginTime": "0001-01-01 00:00:00",
"SubDomainLimit": 40,
"MainDomainLimit": 4,
"Mode": 0,
"DomainCount": 0,
"MainDomainCount": 0,
"MaxQPS": 0,
"QPS": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"DomainPkg": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"BotPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
},
"FraudPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
}
},
{
"AppId": 251197211,
"InstanceId": "waf_2kuhdkt4008qolw5",
"InstanceName": "带服务实例",
"ResourceIds": "waf_2kuhdkt4008qolw5",
"Edition": "sparta-waf",
"Region": "gz",
"PayMode": 1,
"RenewFlag": 1,
"Level": 4,
"ValidTime": "2021-08-14 15:14:55",
"BeginTime": "0001-01-01 00:00:00",
"SubDomainLimit": 40,
"MainDomainLimit": 4,
"Mode": 0,
"DomainCount": 12,
"MainDomainCount": 1,
"MaxQPS": 0,
"QPS": {
"ResourceIds": "waf_2kuhdkt4008qolw5_qps",
"ValidTime": "2021-08-14 15:15:01",
"RenewFlag": 1,
"Count": 1000,
"Region": "gz"
},
"DomainPkg": {
"ResourceIds": "waf_2kuhdkt4008qolw5_dmn",
"ValidTime": "2021-08-14 15:15:10",
"RenewFlag": 1,
"Count": 1,
"Region": "gz"
},
"BotPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
},
"FraudPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
}
},
{
"AppId": 251197211,
"InstanceId": "waf_2kuhdkt4008qnip1",
"InstanceName": "gz-Default",
"ResourceIds": "waf_2kuhdkt4008qnip1",
"Edition": "clb-waf",
"Region": "",
"PayMode": 1,
"RenewFlag": 1,
"Level": 4,
"ValidTime": "2021-08-14 15:10:38",
"BeginTime": "0001-01-01 00:00:00",
"SubDomainLimit": 40,
"MainDomainLimit": 4,
"Mode": 0,
"DomainCount": 0,
"MainDomainCount": 0,
"MaxQPS": 0,
"QPS": {
"ResourceIds": "waf_2kuhdkt4008qnip1_qps",
"ValidTime": "2021-08-14 15:10:38",
"RenewFlag": 1,
"Count": 1000,
"Region": "gz"
},
"DomainPkg": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"BotPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
},
"FraudPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
}
},
{
"AppId": 251197211,
"InstanceId": "waf_2kuhdkt4008qnsr9",
"InstanceName": "测试实例",
"ResourceIds": "waf_2kuhdkt4008qnsr9",
"Edition": "sparta-waf",
"Region": "gz",
"PayMode": 1,
"RenewFlag": 1,
"Level": 4,
"ValidTime": "2022-09-14 14:24:02",
"BeginTime": "2021-10-09 15:10:55",
"SubDomainLimit": 40,
"MainDomainLimit": 4,
"Mode": 0,
"DomainCount": 7,
"MainDomainCount": 2,
"MaxQPS": 5,
"QPS": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"DomainPkg": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"BotPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
},
"FraudPkg": {
"ResourceIds": "",
"Status": 1,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
}
},
{
"AppId": 251197211,
"InstanceId": "yuyuyuyuyu",
"InstanceName": "ModifyNamessssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssss",
"ResourceIds": "waf_2kuf279k004v9eb7",
"Edition": "sparta-waf",
"Region": "cd",
"PayMode": 1,
"RenewFlag": 0,
"Level": 4,
"ValidTime": "2021-07-01 20:27:54",
"BeginTime": "0001-01-01 00:00:00",
"SubDomainLimit": 40,
"MainDomainLimit": 4,
"Mode": 0,
"DomainCount": 38,
"MainDomainCount": 4,
"MaxQPS": 2,
"QPS": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"DomainPkg": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"BotPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
},
"FraudPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
}
},
{
"AppId": 251197211,
"InstanceId": "waf_2kugqn6w007lhqhd",
"InstanceName": "gz-Default",
"ResourceIds": "waf_2kugqn6w007lhqhd",
"Edition": "clb-waf",
"Region": "gz",
"PayMode": 1,
"RenewFlag": 1,
"Level": 4,
"ValidTime": "2021-07-07 16:45:33",
"BeginTime": "0001-01-01 00:00:00",
"SubDomainLimit": 40,
"MainDomainLimit": 4,
"Mode": 1,
"DomainCount": 2,
"MainDomainCount": 2,
"MaxQPS": 0,
"QPS": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"DomainPkg": {
"ResourceIds": "",
"ValidTime": "",
"RenewFlag": 0,
"Count": 0,
"Region": ""
},
"BotPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 0
},
"FraudPkg": {
"ResourceIds": "",
"Status": 0,
"Region": 0,
"BeginTime": "",
"EndTime": "",
"InquireNum": 0,
"UsedNum": 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 | 操作不支持。 |