帮你快速理解、总结文档立即下载

查询后付费实例列表

最近更新时间:2026-10-21 02:50:38
我的收藏

1. 接口描述

接口请求域名: waf.tencentcloudapi.com 。

查询后付费实例列表。响应结构与 DescribeInstances 保持一致,全量返回实例字段(含各类套餐包信息),并额外填充 LLMTokenUsage(当天 token 消耗量与近 7 天趋势)。

针对按量后付费基础安全实例(Edition 为 sparta-waf / clb-waf),额外返回实例维度的实时统计,用于控制台「实例管理」页展示:

  1. DomainCount:实时去重后的接入域名数(含云原生防护对象默认虚拟域名);
  2. ExpertRuleCount:实时开启的专家规则数,口径为接入域名数 × 1;
  3. CustomRuleCount:该实例下所有接入域名的实时自定义规则条数之和。

注意事项:

  • 上述 3 个字段均为调用时刻的实时快照,非按小时的计费计量值;
  • 与账单接口 DescribeWafPostpaidBillDetail 返回的小时计量值(DomainUsage / ExpertUsage / CustomUsage)可能存在差异:账单侧按自然小时计量、包含小时内已删除的规则,且自定义规则在多实例共用同一域名时会平分并向上取整,而本接口不做平分、不含已删除规则;
  • Edition 为 llm-sdk-waf 等非基础安全实例无域名接入与规则概念,上述 3 个字段固定为 0。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeAfterPayInstances。
Version 是 String 公共参数,本接口取值:2018-01-25。
Region 是 String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。
Offset 是 Integer 偏移量
示例值:1
Limit 是 Integer 容量
示例值:20
Filters.N 否 Array of FiltersItemNew 过滤数组
FreeDelayFlag 否 Integer 释放延期标识
示例值:1

3. 输出参数

参数名称 类型 描述
Total Integer 总数
示例值:1
Instances Array of AfterPayInstanceInfo 后付费实例列表(结构与 DescribeInstances 的 InstanceInfo 一致,全量返回实例字段含各类套餐包信息,额外填充 LLMTokenUsage)
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询后付费基础安全实例列表(含域名与规则实时统计)

查询后付费基础安全实例列表。Filters 需同时指定 Type 与 Edition;响应中 DomainCount 为实时去重后的接入域名数,ExpertRuleCount 为专家规则数(等于接入域名数),CustomRuleCount 为该实例下所有域名的自定义规则条数之和。

输入示例

POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAfterPayInstances
<公共请求参数>

{
    "Offset": 0,
    "Limit": 20,
    "Filters": [
        {
            "Name": "Type",
            "Values": [
                "sp_wsm_waf_pay"
            ],
            "ExactMatch": true
        },
        {
            "Name": "Edition",
            "Values": [
                "sparta-waf",
                "clb-waf"
            ],
            "ExactMatch": true
        }
    ]
}

输出示例

{
    "Response": {
        "Total": 1,
        "Instances": [
            {
                "AppId": 251437166,
                "InstanceId": "waf_2l2s8g260autuly7",
                "InstanceName": "gz-postpaid",
                "ResourceIds": "waf_2l2s8g260autuly7",
                "Edition": "sparta-waf",
                "Region": "gz",
                "PayMode": 0,
                "Status": 0,
                "RenewFlag": 0,
                "Level": 203,
                "ValidTime": "2038-01-01 00:00:00",
                "BeginTime": "2026-09-01 10:00:00",
                "ModifyTime": "2026-09-01 10:00:00",
                "BillingItem": "sv_wsm_waf_payg_instance",
                "DomainCount": 17,
                "MainDomainCount": 3,
                "ExpertRuleCount": 17,
                "CustomRuleCount": 10
            }
        ],
        "RequestId": "9f3c1f26-6b7d-4d21-9c2e-2b5f0a71d8e4"
    }
}

示例2 查询后付费实例列表

分页查询后付费实例列表。响应结构与 DescribeInstances 保持一致,复用全量 InstanceDetail(含各类套餐包),并额外填充 LLMTokenUsage。

输入示例

POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAfterPayInstances
<公共请求参数>

{
    "Offset": 0,
    "Limit": 20,
    "Filters": [
        {
            "Name": "DealName",
            "Values": [
                "20211119002000712600571"
            ],
            "ExactMatch": true
        }
    ],
    "FreeDelayFlag": 1
}

输出示例

{
    "Response": {
        "Total": 1,
        "Instances": [
            {
                "AppId": 251437166,
                "InstanceId": "waf_2l2r0gne0amhqdp3",
                "InstanceName": "gz-Default",
                "ResourceIds": "waf_2l2r0gne0amhqdp3",
                "Edition": "llm-sdk-waf",
                "Region": "gz",
                "PayMode": 0,
                "Status": 0,
                "RenewFlag": 0,
                "AttackLogPost": 0,
                "Level": 201,
                "ElasticBilling": 0,
                "ValidTime": "2038-01-01 00:00:00",
                "BeginTime": "2026-07-06 16:17:09",
                "ModifyTime": "2026-07-06 16:17:09",
                "SubDomainLimit": 0,
                "MainDomainLimit": 0,
                "APISecurity": 0,
                "IsAPISecurityTrial": 0,
                "BillingItem": "sv_wsm_waf_llm_prompt_attack",
                "FreeDelayFlag": 0,
                "BasicFlag": 0,
                "Mode": 0,
                "DomainCount": 0,
                "MainDomainCount": 0,
                "ExpertRuleCount": 0,
                "CustomRuleCount": 0,
                "MaxQPS": 0,
                "MaxBandwidth": 0,
                "QPS": null,
                "BotQPS": null,
                "DomainPkg": null,
                "BotPkg": null,
                "FraudPkg": null,
                "MajorEventsPkg": null,
                "HybridPkg": null,
                "ApiPkg": null,
                "MiniPkg": null,
                "MiniExtendPkg": null,
                "LLMPkg": {
                    "ResourceIds": "waf_2l2r0gne0amhqdp3_0_llm",
                    "Status": 1,
                    "Region": 1,
                    "BeginTime": "2026-07-06 16:17:09",
                    "EndTime": "2038-01-01 00:00:00",
                    "InquireNum": 0,
                    "InquireKey": "sv_wsm_waf_llm_prompt_attack"
                },
                "QpsStandard": 0,
                "BandwidthStandard": 0,
                "SandboxQps": 0,
                "LLMTokenUsage": {
                    "PromptUsage": 1000,
                    "ContentTextUsage": 2000,
                    "SensitiveDataUsage": 500,
                    "ContentImageUsage": 10,
                    "TokenTrend": [
                        {
                            "DayTime": "20260706",
                            "TokenUsage": 3500
                        }
                    ],
                    "ImageTrend": [
                        {
                            "DayTime": "20260706",
                            "ImageUsage": 10
                        }
                    ]
                }
            }
        ],
        "RequestId": "842e99eb-3b4b-4faa-a7d7-7e34e201c3c4"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
DryRunOperation DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourcesSoldOut 资源售罄。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。