ListDataSource--数据库传输服务-火山引擎

文档中心

立即注册

导航

数据库传输服务

ListDataSource

最近更新时间：2025.06.04 11:14:02首次发布时间：2023.08.10 18:31:10

调用 ListDataSource 接口查询数据源列表。

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
NamePrefix	String	否	test	名称前缀，支持模糊搜索数据源。
EndpointTypes	Array of String	否	["Volc_MySQL"]	实例的接入方式，取值如下： `Volc_MySQL`：表示火山引擎版 MySQL。 `Volc_veDB_MySQL`：表示火山引擎版 veDB MySQL。 `Volc_PostgreSQL`：表示火山引擎版 PostgreSQL。 `Volc_Mongo`：表示火山引擎版 MongoDB。 `Volc_ElasticSearch`：表示火山引擎版 ElasticSearch。 `Volc_Kafka`：表示消息队列 Kafka 版。 `Volc_RocketMQ`：表示消息队列 RocketMQ 版。 `Volc_Redis`：表示火山引擎版 Redis。 `Public_MySQL`：表示公网自建 MySQL。 `Public_PostgreSQL`：表示公网自建 PostgreSQL。 `Public_Mongo`：表示公网自建 MongoDB。 `Public_ElasticSearch`：表示公网自建 ElasticSearch。 `Public_Redis`：表示公网自建 Redis。 `Builtin_Kafka`：表示内置中间件。 `Express_MySQL`：表示专有网络 MySQL。 `Express_PostgreSQL`：表示专有网络 PostgreSQL。 `Express_Mongo`：表示专有网络 MongoDB。 `Express_Redis`：表示专有网络 Redis。
Categories	Array of String	否	["MySQL"]	数据库类型。取值如下： `MySQL`：表示数据源的数据库类型为 MySQL。 `MongoDB`：表示数据源的数据库类型为 MongoDB。 `Redis`：表示数据源的数据库类型为 Redis。 `PostgreSQL`：表示数据源的数据库类型为 PostgreSQL。 `Elasticsearch`：表示数据源的数据库类型为 Elasticsearch。 `Kafka`：表示数据源的数据库类型为 Kafka。 `RocketMQ`：表示数据源的数据库类型为 RocketMQ。
PageNum	Integer	否	1	页码。取值范围 1~1000，默认值为 1。
PageSize	Integer	否	10	每页记录数。取值范围 1~1000，默认值为 10。

返回参数

名称类型 示例值 描述

名称	类型	示例值	描述
DataSourceList	Array of DataSource	`[ { "Category": "MySQL", "CreateTime": 1713382724876, "DataSourceId": "178067480074262**", "EndpointType": "Volc_MySQL", "Name": "src", "VolcMySQLSettings": { "DBInstanceId": "mysql-7734b621", "DBInstanceName": "", "Password": "Admin@", "RegionSettings": { "Region": "cn-beijing" }, "Username": "test*" } } ]`	数据源列表。详细信息，请参见 DataSourceObject。
Count	Integer	1	数据源的总数量。

DataSourceList

Array of DataSource

[
    {
        "Category": "MySQL",
        "CreateTime": 1713382724876,
        "DataSourceId": "178067480074262****",
        "EndpointType": "Volc_MySQL",
        "Name": "src",
        "VolcMySQLSettings": {
            "DBInstanceId": "mysql-7734b621****",
            "DBInstanceName": "",
            "Password": "Admin@****",
            "RegionSettings": {
                "Region": "cn-beijing"
            },
            "Username": "test***"
        }
    }
]

数据源列表。详细信息，请参见 DataSourceObject。

Count Integer 1 数据源的总数量。

请求示例

POST /?Action=ListDataSource&Version=2022-10-01 HTTP/1.1
Content-Type: application/json
Host:dts.cn-beijing.volcengineapi.com
X-Date: 20221001T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20221001/cn-beijing/dts/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****

{
    "Categories":["Mongo"]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202406121112198BD27340EB1C38A9E28E-fbd62a",
        "Action": "ListDataSource",
        "Version": "2022-10-01",
        "Service": "dts",
        "Region": "cn-beijing"
    },
    "Result": {
        "Count": 1,
        "DataSourceList": [
            {
                "Category": "MongoDB",
                "CreateTime": 1718104049581,
                "DataSourceId": "1800470012301987863",
                "EndpointType": "Volc_Mongo",
                "Name": "w",
                "VolcMongoSettings": {
                    "DBInstanceId": "mongo-replica-386df9f4****",
                    "DBInstanceName": "",
                    "DeployType": "ReplicaSet",
                    "MongoAuthSourceDB": "",
                    "Password": "c",
                    "RegionSettings": {
                        "Region": "cn-beijing"
                    },
                    "Username": "c"
                }
            }
        ]
    }
}

错误码

更多详情，请参见错误码。