数据安全治理中心数据资产报告-查询数据资产概览接口-资产报告相关接口-API 中心-腾讯云

1. 接口描述

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

数据资产报告页面-查询数据资产概览接口（包括数据库资产详情和存储资产详情）

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAssetOverview。
Version	是	String	公共参数，本接口取值：2019-07-23。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-shanghai-fsi, ap-singapore 。
DspaId	是	String	dspa实例id 示例值：dspa-44b7bd87
ComplianceId	是	Integer	合规组id 示例值：12
AssetList.N	是	Array of AssetList	查询的资产信息列表示例值：[ { "DataSourceType": "cdb", "DataSourceInfo": [ { "DataSourceId": "cdb-14nmkefc", "BindList": [ "verify_db" ] } ] } ]

3. 输出参数

参数名称	类型	描述
DBInstanceNums	Integer	数据库实例id 示例值：1
DBNums	Integer	数据库个数示例值：1
TableNums	Integer	表的个数示例值：2
FieldNums	Integer	字段个数示例值：2
DBInstanceDistribution	Array of Note	数据库实例的分布情况示例值：[{mysql,1},{mongoDB,2}]
DBDistribution	Array of Note	db分布情况示例值： [{mysql,1},{mongoDB,2}]
BucketNums	Integer	cos桶的数量示例值：1
FileNums	Integer	文件个数示例值：2
Remark	String	用于对用户进行提示信息示例值：提示
EsInstanceNums	Integer	es实例数量示例值：1
EsIndexNums	Integer	es索引数量示例值：1
EsFieldNums	Integer	es字段数量示例值：1
MongoInstanceNums	Integer	mongo实例数量示例值：1
MongoDbNums	Integer	mongo数据库数量示例值：1
MongoColNums	Integer	mongo集合数量示例值：1
MongoFieldNums	Integer	mongo字段数量示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询数据资产概览接口

资产报告 - 查询数据资产概览接口

输入示例

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

{
    "DspaId": "dspa-44b7bd87",
    "ComplianceId": 1,
    "AssetList": [
        {
            "DataSourceType": "cdb",
            "DataSourceInfo": [
                {
                    "DataSourceId": "cdb-14njkefc",
                    "BindList": [
                        "test_db"
                    ]
                }
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "DBInstanceNums": 0,
        "DBNums": 0,
        "TableNums": 0,
        "FieldNums": 0,
        "DBInstanceDistribution": [
            {
                "Key": "第一个数据源",
                "Value": 1
            }
        ],
        "DBDistribution": [
            {
                "Key": "第二个数据源",
                "Value": 2
            }
        ],
        "BucketNums": 0,
        "FileNums": 0,
        "Remark": "数据源cdb-23uhda9s未扫描",
        "EsInstanceNums": 1,
        "EsIndexNums": 1,
        "EsFieldNums": 1,
        "MongoInstanceNums": 1,
        "MongoDbNums": 1,
        "MongoColNums": 1,
        "MongoFieldNums": 1,
        "RequestId": "7020bf74-4fec-0aab-6a3c-52c2e94ad60a"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

数据资产报告-查询数据资产概览接口

本页目录：