有奖捉虫:行业应用 & 管理与支持文档专题 HOT

1. 接口描述

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

获取分类分级规则列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDSPADiscoveryRules。
Version String 公共参数,本接口取值:2019-07-23。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-singapore 。
DspaId String DSPA实例ID
示例值:dspa-001
Offset Integer 偏移量
示例值:0
Limit Integer 返回上限,默认值10, 最大值10000。
示例值:10
RuleId Integer 规则ID
示例值:1
Name String 规则名称
示例值:测试规则
FilterRuleSource Boolean 是否需要过滤别名
示例值:false

3. 输出参数

参数名称 类型 描述
TotalCount Integer 规则ID
示例值:1
Items Array of DspaDiscoveryRuleDetail 规则集合
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取分类分级规则列表

xx

输入示例

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

{
    "DspaId": "casb_1",
    "RuleId": 1,
    "Limit": 10,
    "Name": "test_rule",
    "Offset": 0
}

输出示例

{
    "Response": {
        "TotalCount": 0,
        "Items": [
            {
                "RuleId": 0,
                "Name": "abc",
                "Description": "abc",
                "Source": 0,
                "RDBRules": {
                    "Status": 0,
                    "MatchOperator": "abc",
                    "MetaRule": {
                        "Operator": "abc",
                        "Contents": [
                            {
                                "RuleType": "abc",
                                "RuleContent": "abc",
                                "ExtendParameters": [
                                    {
                                        "Name": "abc",
                                        "Value": "abc"
                                    }
                                ]
                            }
                        ]
                    },
                    "ContentRule": {
                        "Operator": "abc",
                        "Contents": [
                            {
                                "RuleType": "abc",
                                "RuleContent": "abc",
                                "ExtendParameters": [
                                    {
                                        "Name": "abc",
                                        "Value": "abc"
                                    }
                                ]
                            }
                        ]
                    }
                },
                "COSRules": {
                    "Status": 0,
                    "RegexRule": {
                        "Operator": "abc",
                        "Contents": [
                            {
                                "RuleContent": "abc",
                                "IsIgnoreCase": true
                            }
                        ]
                    },
                    "KeywordRule": {
                        "Operator": "abc",
                        "Contents": [
                            {
                                "RuleContent": "abc",
                                "IsIgnoreCase": true
                            }
                        ]
                    },
                    "IgnoreStringRule": {
                        "Operator": "abc",
                        "Contents": [
                            {
                                "RuleContent": "abc",
                                "IsIgnoreCase": true
                            }
                        ]
                    },
                    "MaxMatch": 0
                }
            }
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
ResourceInUse 资源被占用。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。