查询规则引擎可用的定制配置列表-APIs-Tencent Cloud

1. 接口描述

接口请求域名： teo.tencentcloudapi.com 。

查询站点规则引擎操作可用的定制配置列表。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAvailableCustomActionsForRuleEngine。
Version	是	String	公共参数，本接口取值：2022-09-01。
Region	否	String	公共参数，此参数为可选参数。
ZoneId	是	String	站点 ID。
Filters.N	否	Array of AdvancedFilter	过滤条件，多个条件为且关系，Filters.Values 的上限为 20。该参数不填写时，返回当前站点下所有可用的规则引擎定制配置。详细的过滤条件如下： action-id：按照定制配置唯一标识 ID 进行过滤； name：按照定制配置名称进行过滤。模糊查询时仅支持过滤字段名为 `name`。
Limit	否	Integer	分页查询限制数目。取值范围：[0, 1000] 默认值：20
Offset	否	Integer	分页偏移量。默认值：0
SortBy	否	String	排序字段，取值有： action-id：按照定制配置唯一标识 ID 排序； create-time：按照定制配置创建时间排序。默认值：`action-id`。
SortOrder	否	String	排序方式，取值有： asc：升序排序； desc：降序排序。默认值：desc。

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合条件的规则引擎定制配置的总数。
CustomActionSet	Array of RuleEngineCustomAction	符合条件的规则引擎定制配置的列表。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询规则引擎可用的定制配置列表

查询站点下规则引擎可用的定制配置列表。

输入示例

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

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

输出示例

{
    "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. 开发者资源

腾讯云 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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InvalidParameterValue.ZoneNotFound	没有对应的站点，请确保站点信息填写正确。

查询规则引擎可用的定制配置列表

On this page: