按关键字、Catalog 类型、数据库类型或 Catalog UUID 列表搜索 Agentic DMS 的 Catalog,结果分页返回。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| SearchKey |
string |
否 |
搜索关键字,按 Catalog 名称、数据源别名或数据源连接地址前缀匹配,满足任一条件即命中。 |
prod_ |
| CatalogType |
string |
否 |
Catalog 类型,按类型精确筛选。取值:
|
JDBC |
| DbType |
string |
否 |
数据库类型,按 Catalog 关联数据源的数据库类型精确筛选。取值为大写的数据库类型名称,例如 MYSQL。 |
MYSQL |
| CatalogUuids |
string |
否 |
Catalog UUID 列表,按 UUID 精确筛选。多个 UUID 使用英文逗号(,)分隔,最多 500 个,且不能包含空值。与其他筛选条件同时传入时,按且(AND)关系组合。 |
mc-HZ-OfjcNc2z***,mc-HZ-Bq8Lx3wT*** |
| NextToken |
string |
否 |
下一次查询的令牌(Token)。首次查询无需传入;翻页时传入上一次返回的 NextToken。 |
f056501ada12**** |
| MaxResults |
integer |
否 |
每页最大返回条数。 |
20 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| Data |
array |
Catalog 列表。 |
|
| AgenticCatalog |
Catalog 信息。 |
||
| ErrorCode |
string |
错误码,请求异常时返回。 |
UnknownError |
| ErrorMessage |
string |
调用失败时,返回的错误信息。 |
UnknownError |
| MaxResults |
integer |
本次查询的每页最大返回条数。 |
20 |
| NextToken |
string |
下一次查询的令牌(Token)。为空表示没有更多数据;不为空时,将该值作为下一次请求的 NextToken 继续翻页。 |
NesLoKLEdIZrKhDT7I2gS**** |
| RequestId |
string |
请求 ID。 |
67E910F2-4B62-5B0C-ACA3-7547695C**** |
| Success |
boolean |
请求是否成功,返回值如下:
|
true |
示例
正常返回示例
JSON格式
{
"Data": [
{
"CatalogBizAttrs": {
"test": "test",
"test2": 1
},
"CatalogType": "JDBC",
"CatalogUuid": "mc-HZ-OfjcNc2z***",
"DataSourceUuid": "ds-HZ-Xk2Pq9Lm***",
"DbType": "MYSQL",
"Description": "Order production database",
"Name": "prod_mysql_order",
"Properties": {
"test": "test",
"test2": 1
},
"RegionId": "cn-hangzhou",
"State": 0,
"StorageLocation": "oss://examplebucket/datalake/"
}
],
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"MaxResults": 20,
"NextToken": "NesLoKLEdIZrKhDT7I2gS****",
"RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。