GetDatabaseProfile - 获取库数据概况

获取库数据概况的详细信息。

接口说明

使用数据概况需要先将该库的 OSS Bucket 进行 Location 托管。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dlf:GetDatabaseProfile
*全部资源
*

请求语法

GET /webapi/metastorehouse/catalog/database/databaseprofile HTTP/1.1

请求参数

名称类型必填描述示例值
CatalogIdstring

数据目录 ID,默认填写主账号 ID

1344371
DatabaseNamestring

元数据库名称

test_db

返回参数

名称类型描述示例值
object

Response

Codestring

错误码

-
Messagestring

错误信息

-
RequestIdstring

请求 ID

AEA7DCC8-DBF5-561B-A7FD-0747D7D51FEB
Successboolean

请求是否成功。取值如下:

  • true:成功。
  • false:失败。
true
DatabaseProfileDatabaseProfile

库数据概况

{ "FileCnt": 213, "FileSize": 34324 }

示例

正常返回示例

JSON格式

{
  "Code": "-",
  "Message": "-",
  "RequestId": "AEA7DCC8-DBF5-561B-A7FD-0747D7D51FEB",
  "Success": true,
  "DatabaseProfile": {
    "FileCnt": 3234,
    "FileSize": 1254312,
    "Name": "test_db",
    "CreateTime": "2023-08-16 18:02:22",
    "Location": "oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_db/",
    "ObjectSize": 1254312,
    "ObjectCnt": 3234,
    "LatestDate": "2023-08-30 19:16:10"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-03-03新增 OpenAPI查看变更详情