# 获取空间分析数据列表 - ObtainTheSpaceAnalysisDataList #### 功能介绍 获取空间分析数据列表。实例级别数据来源于文件系统，库级别和表级别数据来源于information_schema.tables表。空间\&元数据分析最多分析10000张表，若缺少库表空间数据，可能是因为数据库实例表个数过多或者账号未保存密码。如果未保存密码，请使用用户管理接口或页面录入数据库账号。支持MySQL、TaurusDB和SQLServer引擎。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DAS&api=ListSpaceAnalysis)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-das/das_01_0130.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | das:clouddba:listSpaceAnalysis | list | instance | - | - | - | #### URI GET /v3/{project_id}/instances/{instance_id}/space-analysis 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-das/das_01_0036.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值：** 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID，实例的唯一标识。可通过查看实例列表或者实例详情获取实例ID信息。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | object_type | 是 | String | **参数解释：** 对象类型。 **约束限制：** 不涉及。 **取值范围：** - database - table **默认取值：** 不涉及。 | | database_id | 否 | String | **参数解释：** 数据库ID。 **约束限制：** 仅在object_type为table时需要。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | offset | 否 | String | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。例如：该参数指定为1，limit指定为10，则只展示第2\~11条数据。 **约束限制：** 不涉及。 **取值范围**： \[0, 2\^31-1\] **默认取值：** 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 否 | String | **参数解释：** 查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值：** 100。 | | show_instance_info | 否 | String | **参数解释：** 是否返回实例级别数据。 **约束限制：** 不涉及。 **取值范围：** - true - false **默认取值：** true | | datastore_type | 是 | String | **参数解释：** 数据库引擎类型。 **约束限制：** 不涉及。 **取值范围：** - MySQL - TaurusDB - SQLServer **默认取值：** 不涉及。 | #### 请求参数 无。 #### 响应参数 **状态码： 200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Long | **参数解释：** 记录总数。 **取值范围：** 不涉及。 | | db_objects | Array of [DbObjectSpaceInfo] objects | **参数解释：** 数据库对象列表。 | | instance_info | [InstanceSpaceInfo] object | **参数解释：** 实例空间信息。数据来源于文件系统。已用空间包含数据空间、日志空间和其他空间，其他空间包括引擎产生的临时文件等。 **取值范围：** 不涉及。 | 表4DbObjectSpaceInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释：** 估算值行数，以字节为单位。 **取值范围：** 不涉及。 | 表5InstanceSpaceInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_size | Long | **参数解释：** 实例总空间，以字节为单位。TaurusDB不会返回总空间。 **取值范围：** 不涉及。 | | used_size | Long | **参数解释：** 已使用空间，以字节为单位。 **取值范围：** 不涉及。 | | data_size | Long | **参数解释：** 数据空间，以字节为单位。 **取值范围：** 不涉及。 | | log_size | Long | **参数解释：** 日志空间，以字节为单位。 **取值范围：** 不涉及。 | | avg_daily_growth | Long | **参数解释：** 近七日的数据平均日增长量，以字节为单位。 **取值范围：** 不涉及。 | | last_result_time | Long | **参数解释：** 最后一次分析的结果时间，毫秒单位时间戳。 **取值范围：** 不涉及。 | #### 请求示例 - 获取数据库列表。 ``` 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. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-das/das_01_0035.html)。