Obtaining the Space Analysis Data List

Function

This API is used to obtain the space analysis data list. The file system generates instance-level data, and the information_schema.tables table generates database-level and table-level data. Space & Metadata Analysis allows you to analyze a maximum of 10,000 tables. If tablespace data is missing, there may be too many instance tables, or the account password has not been saved. If the password has not been saved, use the user management API or page to save the database account. This function is supported for MySQL, TaurusDB, and SQL Server.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID To obtain the value, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
object_type	Yes	String	Object type Default value: database Enumerated values: database table
database_id	No	String	Database ID
offset	No	String	Offset. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value must be a number but cannot be a negative number. The offset value must be an integer multiple of limit value. Default value: 0.
limit	No	String	Number of records to be queried. The default value is 100. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100. Default value: 100
show_instance_info	No	String	Whether to return instance data. The value can be true or false. Default value: true
datastore_type	Yes	String	Engine type Enumerated values: MySQL TaurusDB SQLServer

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token
X-Language	No	String	Language Enumerated values: zh-cn en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Long	Total number of records
db_objects	Array of DbObjectSpaceInfo objects	DB objects
instance_info	InstanceSpaceInfo object	Instance storage usage: The data comes from the file system. The used space includes the data space, log space, and other space. Other space includes space for storing temporary files generated by the engine.

**Table 5** DbObjectSpaceInfo
Parameter	Type	Description
object_type	String	Object type. If the object type is table, database_id must be transferred. Enumerated values: database table
object_name	String	Object name
object_id	String	Object ID
used_size	Long	Used space, in bytes
data_size	Long	Data space, in bytes
index_size	Long	Index space, in bytes
estimated_rows	Long	Number of estimated value rows, in bytes

**Table 6** InstanceSpaceInfo
Parameter	Type	Description
total_size	Long	Total instance space, in bytes. The total space of a TaurusDB instance is not returned.
used_size	Long	Used space, in bytes
data_size	Long	Data space, in bytes
log_size	Long	Log space, in bytes
avg_daily_growth	Long	Average daily data growth in the last seven days, in bytes
last_result_time	Long	Time when the last analysis result is generated, in milliseconds

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum length: 8 characters Maximum length: 36 characters
error_msg	String	Error message Minimum length: 2 characters Maximum length: 512 characters

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum length: 8 characters Maximum length: 36 characters
error_msg	String	Error message Minimum length: 2 characters Maximum length: 512 characters

Example Request

Obtaining the database list

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

Obtaining the table list

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

Example Response

Status code: 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
  }
}