Docs Overview/
DescribeAvailableCustomActionsForRuleEngine/

DescribeAvailableCustomActionsForRuleEngine

1. API Description

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

This API is used to query the list of available custom configurations for rule engine operations on a site.

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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeAvailableCustomActionsForRuleEngine.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesString

Zone ID.

Filters.NNoArray of AdvancedFilter

Filter criteria. Multiple conditions have an AND relationship. The maximum number of Filters.Values is 20. If this parameter is left empty, return all available rule engine custom configurations under the current site. Detailed filter criteria:

  • action-id: Filter by the unique identification ID of the custom configuration.
  • name: Filter by the name of the custom configuration.
    • Fuzzy query only supports filtering fields named name.

    LimitNoInteger

    Paginated query limit.

    Value ranges from 0 to 1000.

    Default value: 20.

    OffsetNoInteger

    Paging offset.

    Default value: 0.

    SortByNoString

    Sorting field. Valid values:

  • action-id: Sort by custom configuration unique identification ID.
  • create-time: Sort by custom configuration creation time.
    • Default value: action-id.

    SortOrderNoString

    Sorting method. Valid values:

  • asc: ascending sort;
  • desc: sort in descending order.
    • Default value: desc.

    3. Output Parameters

    Parameter NameTypeDescription
    TotalCountInteger

    Total number of eligible rule engine custom configurations.

    CustomActionSetArray of RuleEngineCustomAction

    List of eligible rule engine custom configurations.

    RequestIdStringThe 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 Query the list of available custom configurations for the rule engine

    Query the list of custom configurations available for the rule engine at the site.

    Input Example

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

{
    "ZoneId": "zone-3**********x",
    "Filters": [
        {
            "Name": "action-id",
            "Values": [
                "ca-3**********n"
            ]
        }
    ],
    "Limit": 1,
    "Offset": 0,
    "SortBy": "action-id",
    "SortOrder": "desc"
}

    Output Example

    {
    "Response": {
        "CustomActionSet": [
            {
                "ActionId": "ca-3**********n",
                "Description": "Rate limiting for client IP access.",
                "Name": "ClientIPRateLimit",
                "Parameters": [
                    {
                        "Default": "100",
                        "Description": "The maximum QPS of the client IP",
                        "MaxValue": 10000,
                        "MinValue": 1,
                        "Name": "MaxQPS",
                        "Required": false,
                        "ValueType": "Integer"
                    }
                ],
                "SupportedConditions": [
                    "http.request.host"
                ]
            }
        ],
        "TotalCount": 1,
        "RequestId": "bbd3abd8-aeb6-4ca5-a623-6502f8f19c1a"
    }
}

    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

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error CodeDescription
    InvalidParameterValue.ZoneNotFoundNo corresponding site. please ensure correct information entry.