1. 接口描述
接口请求域名: dsgc.tencentcloudapi.com 。
获取单个合规组下的RDB关系数据库分类分级数据资产
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDSPARDBDataAssetByComplianceId。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-shanghai-fsi, ap-singapore 。 |
DspaId | 是 | String | DSPA实例ID 示例值:dspa-89asd23n |
ComplianceId | 是 | Integer | 合规组ID 示例值:1 |
DataSourceType | 否 | String | 数据源类型,不填默认过滤非自建的所有关系型数据源类型,填selfbuilt-db只过滤自建类型 示例值:selfbuilt-db |
BuildType | 否 | String | 自建还是云上 示例值:cloud |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Stats | DspaRDBDataAssetCount | 符合条件的RDB关系数据库敏感数据资产统计记录 注意:此字段可能返回 null,表示取不到有效值。 示例值:{ "DataAssetType": 0, "TotalDbCnt": 4, "TotalTableCnt": 10, "SensitiveCategoryCnt": 2, "SensitiveFieldCnt": 2, "SensitiveLevel": [ { "LevelId": 1, "LevelCnt": 1, "LevelRiskName": "高", "LevelRiskScore": 10 }, { "LevelId": 2, "LevelCnt": 1, "LevelRiskName": "中", "LevelRiskScore": 5 } ], "SensitiveDbCnt": 2, "SensitiveTableCnt": 2, "TotalFieldCnt": 225, "CategoryDistributed": [ { "CategoryId": 101, "CategoryName": "账户信息", "Count": 1, "CategoryFullPath": "["账户信息"]" }, { "CategoryId": 103, "CategoryName": "个人基本信息", "Count": 1, "CategoryFullPath": "["个人基本信息"]" } ] } |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取单个合规组下的RDB关系数据库分类分级数据资产
输入示例
POST / HTTP/1.1
Host: dsgc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDSPARDBDataAssetByComplianceId
<公共请求参数>
{
"DspaId": "dspa-89asd23n",
"ComplianceId": 1
}
输出示例
{
"Response": {
"Stats": {
"DataAssetType": 0,
"TotalDbCnt": 2,
"TotalTableCnt": 5,
"SensitiveCategoryCnt": 1,
"SensitiveFieldCnt": 6,
"SensitiveLevel": [
{
"LevelId": 101,
"LevelCnt": 2,
"LevelRiskName": "高",
"LevelRiskScore": 10
}
],
"SensitiveDbCnt": 2,
"SensitiveTableCnt": 2,
"TotalFieldCnt": 8,
"CategoryDistributed": [
{
"CategoryId": 103,
"CategoryName": "个人基本信息",
"Count": 5,
"CategoryFullPath": "基本信息/个人基本信息"
}
]
},
"RequestId": "1f1765cf-c01a-4a93-95b2-99108f4aa04f"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
OperationDenied | 操作被拒绝。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |