文档首页/ 数据管理服务 DAS/ API参考/ API（不再推广）/ 获取空间分析数据列表
更新时间：2024-12-04 GMT+08:00
查看PDF
分享

获取空间分析数据列表

功能介绍

获取空间分析数据列表。实例级别数据来源于文件系统，库级别和表级别数据来源于information_schema.tables表。空间&元数据分析最多分析10000张表，若缺少库表空间数据，可能是因为数据库实例表个数过多或者账号未保存密码。如果未保存密码，请使用用户管理接口或页面录入数据库账号。支持MySQL、TaurusDB和SQLServer引擎。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/instances/{instance_id}/space-analysis

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

获取方法请参见获取项目ID。

instance_id

是

String

实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

object_type

是

String

对象类型。

缺省值：database

枚举值：

  • database
  • table

database_id

否

String

数据库ID。

offset

否

String

偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。offset必须是limit的整数倍。

缺省值：0

limit

否

String

查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

缺省值：100

show_instance_info

否

String

是否返回实例级别数据，取值：true或者false。

缺省值：true

datastore_type

是

String

引擎类型。

枚举值：

  • MySQL
  • TaurusDB
  • SQLServer

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户token。

X-Language

否

String

语言。

枚举值：

  • zh-cn
  • en-us

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Long

记录总数。

db_objects

Array of DbObjectSpaceInfo objects

数据库对象列表。

instance_info

InstanceSpaceInfo object

实例空间信息。数据来源于文件系统。已用空间包含数据空间、日志空间和其他空间，其他空间包括引擎产生的临时文件等。
表5 DbObjectSpaceInfo

参数

参数类型

描述

object_type

String

对象类型，如果是table，同时需要传database_id。

枚举值：

  • database
  • table

object_name

String

对象名称。

object_id

String

对象ID。

used_size

Long

已使用空间，以字节为单位。

data_size

Long

数据空间，以字节为单位。

index_size

Long

索引空间，以字节为单位。

estimated_rows

Long

估算值行数，以字节为单位。
表6 InstanceSpaceInfo

参数

参数类型

描述

total_size

Long

实例总空间，以字节为单位。TaurusDB不会返回总空间。

used_size

Long

已使用空间，以字节为单位。

data_size

Long

数据空间，以字节为单位。

log_size

Long

日志空间，以字节为单位。

avg_daily_growth

Long

近七日的数据平均日增长量，以字节为单位。

last_result_time

Long

最后一次分析的结果时间，毫秒单位时间戳。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：36

error_msg

String

错误描述。

最小长度：2

最大长度：512

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：36

error_msg

String

错误描述。

最小长度：2

最大长度：512

请求示例

  • 获取数据库列表。 
    GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/fa7d0b6e40704cd48facf9889d6e745bin01/space-analysis?datastore_type=MySQL&object_type=database&show_instance_info=true&offset=0&limit=100
  • 获取表列表。 
    GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/fa7d0b6e40704cd48facf9889d6e745bin01/space-analysis?datastore_type=MySQL&object_type=table&database_id=24937&show_instance_info=false&offset=0&limit=100

响应示例

状态码： 200

Success.

{
  "db_objects" : [ {
    "object_type" : "database",
    "object_name" : "db_01",
    "object_id" : "24937",
    "used_size" : 171687936,
    "data_size" : 129646592,
    "index_size" : 38895616
  }, {
    "object_type" : "database",
    "object_name" : "test_db",
    "object_id" : "24936",
    "used_size" : 84574208,
    "data_size" : 41484288,
    "index_size" : 38895616
  } ],
  "total" : 2,
  "instance_info" : {
    "total_size" : 42949672960,
    "used_size" : 2635862016,
    "data_size" : 256262144,
    "log_size" : 2100001252,
    "avg_daily_growth" : 86016,
    "last_result_time" : 1615323657065
  }
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： API（不再推广）

相关文档