SearchAgenticDatabase - 全局搜索 Database-数据管理 DMS-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
SearchKey	string	否	搜索关键字，匹配 Database 的名称、全限定名、搜索名，以及所属 Catalog 的名称或数据源别名。	order
CatalogUuid	string	否	限定搜索范围的 Catalog UUID。不传时在全部 Catalog 中搜索。	mc-HZ-OfjcNc2z***
DbType	string	否	数据库类型，按所属 Catalog 关联数据源的数据库类型精确筛选。取值为大写的数据库类型名称，例如 MYSQL。	MYSQL
EnvType	string	否	环境类型，按所属数据源的环境精确筛选。取值：product、pre、dev、test、sit、uat、pet、stag。	product
NextToken	string	否	下一次查询的令牌（Token）。首次查询无需传入；翻页时传入上一次返回的 NextToken。	f056501ada12****
MaxResults	integer	否	每页最大返回条数。	20

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Data	array	Database 列表。
	AgenticDatabase	Database 信息。
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：请求成功。 false：请求失败。	true

示例

正常返回示例

JSON格式

{
  "Data": [
    {
      "CatalogName": "prod_mysql_order",
      "CatalogType": "JDBC",
      "CatalogUuid": "mc-HZ-OfjcNc2z***",
      "DatabaseBizAttrs": {
        "test": "test",
        "test2": 1
      },
      "DatabaseUuid": "md-HZ-fp9K7r***",
      "DbType": "MYSQL",
      "Description": "Order database",
      "EngineMeta": {
        "CatalogName": "def",
        "Encoding": "utf8mb4",
        "SchemaName": "public",
        "StorageCapacity": 1024
      },
      "Name": "order_db",
      "Properties": {
        "test": "test",
        "test2": 1
      },
      "QualifiedName": "order_db",
      "RegionId": "cn-hangzhou",
      "SearchName": "order_db",
      "State": 0,
      "StorageLocation": "oss://examplebucket/datalake/order_db/"
    }
  ],
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "MaxResults": 20,
  "NextToken": "NesLoKLEdIZrKhDT7I2gS****",
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。