有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

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

获取分类规则树信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDSPACategoryTreeWithRules。
Version String 公共参数,本接口取值:2019-07-23。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-singapore 。
DspaId String dspa实例id
示例值:dspa-xxx
ComplianceId Integer 合规组模板id
示例值:1
CategoryId Integer 分类id
示例值:1

3. 输出参数

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

4. 示例

示例1 获取分类规则树信息

获取分类规则树信息

输入示例

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

{
    "DspaId": "dspa-001",
    "ComplianceId": 1
}

输出示例

{
    "Response": {
        "RequestId": "128009ac-7df4-0530-cc92-52f0d945e191",
        "ResultJson": "[{\"Id\":163,\"Name\":\"一级分类\",\"ComplianceId\":5,\"ParentId\":-1,\"IsLeaf\":1,\"Source\":1,\"Grade\":1,\"Rules\":null,\"Children\":[{\"Id\":164,\"Name\":\"二级分类\",\"ComplianceId\":5,\"ParentId\":163,\"IsLeaf\":0,\"Source\":1,\"Grade\":2,\"Rules\":null,\"Children\":[{\"Id\":165,\"Name\":\"三级分类1\",\"ComplianceId\":5,\"ParentId\":164,\"IsLeaf\":1,\"Source\":1,\"Grade\":3,\"Rules\":[{\"RuleId\":1,\"RuleName\":\"银行卡\",\"LevelId\":5,\"LevelName\":\"S3\"},{\"RuleId\":2,\"RuleName\":\"信用卡\",\"LevelId\":6,\"LevelName\":\"S2\"}],\"Children\":null},{\"Id\":166,\"Name\":\"三级分类2\",\"ComplianceId\":5,\"ParentId\":164,\"IsLeaf\":0,\"Source\":1,\"Grade\":3,\"Rules\":null,\"Children\":[{\"Id\":168,\"Name\":\"四级分类1\",\"ComplianceId\":5,\"ParentId\":166,\"IsLeaf\":0,\"Source\":1,\"Grade\":4,\"Rules\":null,\"Children\":null},{\"Id\":169,\"Name\":\"四级分类3\",\"ComplianceId\":5,\"ParentId\":166,\"IsLeaf\":0,\"Source\":1,\"Grade\":4,\"Rules\":null,\"Children\":[{\"Id\":170,\"Name\":\"五级分类3\",\"ComplianceId\":5,\"ParentId\":169,\"IsLeaf\":0,\"Source\":1,\"Grade\":5,\"Rules\":null,\"Children\":null}]}]},{\"Id\":167,\"Name\":\"三级分类3\",\"ComplianceId\":5,\"ParentId\":164,\"IsLeaf\":0,\"Source\":1,\"Grade\":3,\"Rules\":null,\"Children\":[{\"Id\":172,\"Name\":\"四级分类5\",\"ComplianceId\":5,\"ParentId\":167,\"IsLeaf\":1,\"Source\":1,\"Grade\":4,\"Rules\":null,\"Children\":null}]},{\"Id\":171,\"Name\":\"五级分类2\",\"ComplianceId\":5,\"ParentId\":164,\"IsLeaf\":1,\"Source\":1,\"Grade\":3,\"Rules\":null,\"Children\":null}]}]}]"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
ResourceNotFound 资源不存在。