tencent cloud

APIs

DescribeLLMWafProtectRules

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-11-17 19:19:05

1. API Description

Domain name for API request: waf.intl.tencentcloudapi.com.

This API is used to query LLM rule requests.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeLLMWafProtectRules.
Version Yes String Common Params. The value used for this API: 2018-01-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-seoul, ap-singapore.
ServiceId No String

In SDK mode, pass ServiceId (choose either this or Domain).

InstanceId No String

Instance id

RuleType No String

Rule type.

Domain No String

In domain mode, pass Domain (choose either this or ServiceId).

3. Output Parameters

Parameter Name Type Description
Categories Array of CategoryGroup

Category list.

RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying Prompt Injection

Input Example

POST / HTTP/1.1
Host: waf.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLLMWafProtectRules
<Common request parameters>

{
    "ServiceId": "9000002874",
    "InstanceId": "waf_2l15d14809yfq9sf",
    "RuleType": "prompt_injection"
}

Output Example

{
    "Response": {
        "Categories": [
            {
                "Category": "prompt_injection",
                "Count": 4,
                "Rules": [
                    {
                        "Action": "log",
                        "Description": "Detects attack behaviors in user input that attempt to override or tamper with system instructions.",
                        "DesensitizeSample": "",
                        "RuleId": "grl-safety-prompt-001",
                        "RuleName": "Instruction Override Detection",
                        "Severity": "critical",
                        "Status": 1
                    }
                ]
            }
        ],
        "RequestId": "9f0960eb-a57f-43bf-8ac0-69cbc49ac924"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Ajuda e Suporte

Esta página foi útil?

comentários