GetAgenticDatabase - 查询 Database 详情

更新时间:
复制 MD 格式

根据 Database UUID 查询 Agentic DMS 的 Database 详情。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dms:GetAgenticDatabase

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

DatabaseUuid

string

是

Database UUID。可通过 ListAgenticDatabase 或 SearchAgenticDatabase 获取。

md-HZ-fp9K7r***

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

67E910F2-4B62-5B0C-ACA3-7547695C****

Success

boolean

请求是否成功,返回值如下:

  • true:请求成功。

  • false:请求失败。

true

ErrorCode

string

错误码,请求异常时返回。

UnknownError

ErrorMessage

string

调用失败时,返回的错误信息。

UnknownError

Data AgenticDatabase

Database 详情。

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

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