有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

获取基线规则列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBaselineRuleList。
Version String 公共参数,本接口取值:2018-02-28。
Region String 公共参数,此参数为可选参数。
Filters.N Array of Filter
  • RuleName - String - 是否必填:否 - 规则名称
  • CategoryId - int64 - 是否必填:否 自定义筛选为-1 - 规则分类
  • RuleType - int - 是否必填:否 0:系统 1:自定义 - 规则类型
  • Limit Integer 限制条数,默认10,最大100
    Offset Integer 偏移量,默认0
    Order String 排序方式: [ASC:升序|DESC:降序]
    By String 可选排序列

    3. 输出参数

    参数名称 类型 描述
    List Array of BaselineRule
    Total Integer 总数
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 规则列表

    输入示例

    POST / HTTP/1.1
    Host: cwp.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeBaselineRuleList
    <公共请求参数>
    
    {
        "Limit": "10",
        "Filters": [
            {
                "Values": [
                    "test"
                ],
                "Name": "RuleName"
            }
        ],
        "Offset": "0"
    }

    输出示例

    {
        "Response": {
            "List": [
                {
                    "RuleName": "test111",
                    "CategoryId": -1,
                    "RuleDesc": "test111",
                    "Items": [
                        {
                            "ItemId": 1000
                        }
                    ],
                    "RuleId": 35184372088862,
                    "RuleType": 1,
                    "HostCount": 0
                }
            ],
            "RequestId": "8d445426-dfea-459c-9a13-1c1a3141353d",
            "Total": 1
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    InternalError 内部错误。
    InvalidParameter 参数错误。