API 中心
开发与运维产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>云安全中心>资产中心相关接口>数据库资产列表

数据库资产列表

最近更新时间：2024-11-04 16:57:45

我的收藏

本页目录：

1. 接口描述

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

数据库资产列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeDbAssets。
Version 是 String 公共参数，本接口取值：2022-11-21。
Region 否 String 公共参数，此参数为可选参数。
MemberId.N 否 Array of String 集团账号的成员id
示例值：["mem-6wfo0fzks3","mem-85fo0fzks4"]
Filter 否 Filter 过滤器参数
示例值：{ "Limit": 0, "Offset": 0, "Order": "desc", "By": "create_time", "Filters": [ { "Name": "name", "Values": [ "foo" ], "OperatorType": 7 } ], "StartTime": "2020-09-22 00:00:00", "EndTime": "2020-09-22 00:00:00" }
AssetTypes.N 否 Array of String 资产类型:MYSQL/MARIADB/REDIS/MONGODB/POSTGRES/CTS/ES/KAFKA/COS/CBS/CFS
示例值：["MYSQL","MARIADB"]

3. 输出参数

参数名称 类型 描述
Total Integer 总数
示例值：10
Data Array of DBAssetVO 资产总数
示例值：[ { "AssetId": "postgres-n3rvf26b", "AssetType": "POSTGRES", "Region": "ap-guangzhou", "VpcName": "li-用完删", "ConfigurationRisk": 1, "AssetName": "Unnamed", "VpcId": "vpc-ewf1aiej", "Domain": "example.foo2.com", "AssetCreateTime": "2024-01-30 16:17:21", "LastScanTime": "2024-10-30 05:02:29", "Attack": 0, "Access": 0, "ScanTask": 28, "AppId": 130215132961, "Uin": "10001459297899", "NickName": "声声乌龙2", "Port": 0, "Tag": [ { "Name": "new", "Value": "sign" }, { "Name": "业务测试", "Value": "业务测试数据" } ], "PrivateIp": "192.168.222.101:5432", "PublicIp": "1.1.1.1", "Status": 1, "IsCore": 2, "IsNewAsset": 0 }, { "AssetId": "tdsql-kfbdnfy9", "AssetType": "MARIADB", "Region": "ap-guangzhou", "VpcName": "li-用完删", "ConfigurationRisk": 1, "AssetName": "tdsql-kfbdnfy9", "VpcId": "vpc-ewf1aiej", "Domain": "example.foo.com", "AssetCreateTime": "2024-01-30 16:12:58", "LastScanTime": "2024-10-30 05:02:29", "Attack": 0, "Access": 0, "ScanTask": 28, "AppId": 130215132961, "Uin": "10001459297899", "NickName": "声声乌龙2", "Port": 0, "Tag": [ { "Name": "new", "Value": "sign" } ], "PrivateIp": "192.168.222.104:3306", "PublicIp": "1.1.1.1", "Status": 1, "IsCore": 2, "IsNewAsset": 0 }, { "AssetId": "cdb-4dckmpb7", "AssetType": "MYSQL", "Region": "ap-guangzhou", "VpcName": "li-用完删", "ConfigurationRisk": 5, "AssetName": "cdb419972", "VpcId": "vpc-ewf1aiej", "Domain": "example.foo1.com", "AssetCreateTime": "2024-01-30 15:45:08", "LastScanTime": "2024-10-30 05:02:29", "Attack": 0, "Access": 0, "ScanTask": 28, "AppId": 130215132961, "Uin": "10001459297899", "NickName": "声声乌龙2", "Port": 0, "Tag": [ { "Name": "new", "Value": "sign" } ], "PrivateIp": "192.168.222.103:3306", "PublicIp": "1.1.1.1", "Status": 1, "IsCore": 2, "IsNewAsset": 0 } ]
RegionList Array of FilterDataObject 地域枚举
示例值：[ { "Text": "广州", "Value": "ap-guangzhou" } ]
AssetTypeList Array of FilterDataObject 资产类型枚举
示例值：[ { "Text": "MySQL", "Value": "MYSQL" }, { "Text": "PostgreSQL", "Value": "POSTGRES" }, { "Text": "MariaDB", "Value": "MARIADB" } ]
VpcList Array of FilterDataObject Vpc枚举
示例值：[ { "Text": "Default-VPC", "Value": "vpc-ommo5hlv" }, { "Text": "li-用完删", "Value": "vpc-ewf1aiej" }, { "Text": "fengqqian2", "Value": "vpc-fw2ndu5f" } ]
AppIdList Array of FilterDataObject Appid枚举
示例值：[ { "Text": "130215123961", "Value": "130215123961" } ]
PublicPrivateAttr Array of FilterDataObject 公网内网枚举
示例值：[ { "Text": "内网服务", "Value": "0" }, { "Text": "公网服务", "Value": "1" } ]
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 数据库资产列表查询

输入示例

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

{
    "Filter": {
        "Filters": [
            {
                "Name": "Status",
                "Values": [
                    "1"
                ],
                "OperatorType": 7
            },
            {
                "Name": "TimeRange",
                "Values": [
                    "2"
                ],
                "OperatorType": 7
            }
        ],
        "Limit": 10,
        "Offset": 0,
        "Order": "desc",
        "By": "AssetCreateTime"
    },
    "MemberId": [
        "mem-625225cc0913c901"
    ]
}

输出示例

{
    "Response": {
        "AppIdList": [
            {
                "Text": "130215132961",
                "Value": "130215132961"
            }
        ],
        "AssetTypeList": [
            {
                "Text": "MySQL",
                "Value": "MYSQL"
            },
            {
                "Text": "PostgreSQL",
                "Value": "POSTGRES"
            },
            {
                "Text": "MariaDB",
                "Value": "MARIADB"
            }
        ],
        "Data": [
            {
                "AssetId": "postgres-n3rvf26b",
                "AssetType": "POSTGRES",
                "Region": "ap-guangzhou",
                "VpcName": "li-用完删",
                "ConfigurationRisk": 1,
                "AssetName": "Unnamed",
                "VpcId": "vpc-ewf1aiej",
                "Domain": "example.foo2.com",
                "AssetCreateTime": "2024-01-30 16:17:21",
                "LastScanTime": "2024-10-30 05:02:29",
                "Attack": 0,
                "Access": 0,
                "ScanTask": 28,
                "AppId": 130215132961,
                "Uin": "10001459297899",
                "NickName": "声声乌龙2",
                "Port": 0,
                "Tag": [
                    {
                        "Name": "new",
                        "Value": "sign"
                    },
                    {
                        "Name": "业务测试",
                        "Value": "业务测试数据"
                    }
                ],
                "PrivateIp": "192.168.222.101:5432",
                "PublicIp": "1.1.1.1",
                "Status": 1,
                "IsCore": 2,
                "IsNewAsset": 0
            },
            {
                "AssetId": "tdsql-kfbdnfy9",
                "AssetType": "MARIADB",
                "Region": "ap-guangzhou",
                "VpcName": "li-用完删",
                "ConfigurationRisk": 1,
                "AssetName": "tdsql-kfbdnfy9",
                "VpcId": "vpc-ewf1aiej",
                "Domain": "example.foo.com",
                "AssetCreateTime": "2024-01-30 16:12:58",
                "LastScanTime": "2024-10-30 05:02:29",
                "Attack": 0,
                "Access": 0,
                "ScanTask": 28,
                "AppId": 130215132961,
                "Uin": "10001459297899",
                "NickName": "声声乌龙2",
                "Port": 0,
                "Tag": [
                    {
                        "Name": "new",
                        "Value": "sign"
                    }
                ],
                "PrivateIp": "192.168.222.104:3306",
                "PublicIp": "1.1.1.1",
                "Status": 1,
                "IsCore": 2,
                "IsNewAsset": 0
            },
            {
                "AssetId": "cdb-4dckmpb7",
                "AssetType": "MYSQL",
                "Region": "ap-guangzhou",
                "VpcName": "li-用完删",
                "ConfigurationRisk": 5,
                "AssetName": "cdb419972",
                "VpcId": "vpc-ewf1aiej",
                "Domain": "example.foo1.com",
                "AssetCreateTime": "2024-01-30 15:45:08",
                "LastScanTime": "2024-10-30 05:02:29",
                "Attack": 0,
                "Access": 0,
                "ScanTask": 28,
                "AppId": 130215132961,
                "Uin": "10001459297899",
                "NickName": "声声乌龙2",
                "Port": 0,
                "Tag": [
                    {
                        "Name": "new",
                        "Value": "sign"
                    }
                ],
                "PrivateIp": "192.168.222.103:3306",
                "PublicIp": "1.1.1.1",
                "Status": 1,
                "IsCore": 2,
                "IsNewAsset": 0
            }
        ],
        "PublicPrivateAttr": [
            {
                "Text": "内网服务",
                "Value": "0"
            },
            {
                "Text": "公网服务",
                "Value": "1"
            }
        ],
        "RegionList": [
            {
                "Text": "广州",
                "Value": "ap-guangzhou"
            }
        ],
        "RequestId": "1eca062f-ccb9-44c4-b43c-eda42b62607e",
        "Total": 3,
        "VpcList": [
            {
                "Text": "Default-VPC",
                "Value": "vpc-ommo5hlv"
            },
            {
                "Text": "li-用完删",
                "Value": "vpc-ewf1aiej"
            },
            {
                "Text": "fengqqian2",
                "Value": "vpc-fw2ndu5f"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

中国站
文档活动
message-icon联系我们
目录