DescribeDBInstanceDataBloat - AnalyticDB for PostgreSQL - Alibaba Cloud Documentation Center

Queries the information about data bloat for an AnalyticDB for PostgreSQL instance.

Operation description

You can call this operation to query the details of data bloat on an AnalyticDB for PostgreSQL instance in elastic storage mode. The minor version of the instance must be V6.3.10.1 or later. For more information about how to view and update the minor version of an instance, see View the minor engine version and Update the minor engine version.

Limits

You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:DescribeDBInstanceDataBloat	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance. Note You can call the DescribeDBInstances operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.	gp-bp12ga6v69h86****
PageSize	integer	No	The number of entries to return on each page. Valid values: 30 50 100 Default value: 30.	30
PageNumber	integer	No	The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
TotalCount	integer	The total number of entries.	1
PageNumber	integer	The page number of the returned page.	1
Items	object []	Details of data bloat.
Sequence	integer	The sequence number.	1
DatabaseName	string	The name of the database.	adbtest
SchemaName	string	The name of the schema.	schema1
TableName	string	The name of the table.	tab1
StorageType	string	The storage type of the table. Valid values: Heap Table Append-Only Heap Table Append-Only Columnar Table	Heap Table
ExpectTableSize	string	The expected size of the table. It indicates the size of the table that has no data bloat.	1MB
RealTableSize	string	The actual size of the table.	1.2MB
BloatSize	string	The bloat size of the table. It indicates the amount of space that can be released.	0.2MB
BloatCeoff	string	The coefficient of data bloat. It is calculated by using the following formula: Bloat coefficient = Number of dead rows/Number of active rows.	1.03
SuggestedAction	string	This parameter is not returned.	null
TimeLastVacuumed	string	The time when the table was last vacuumed. The time is displayed in UTC.	2022-08-08T16:00:00Z
TimeLastUpdated	string	The time when the table was last deleted, inserted, or updated.	2022-08-08T20:00:00Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "TotalCount": 1,
  "PageNumber": 1,
  "Items": [
    {
      "Sequence": 1,
      "DatabaseName": "adbtest",
      "SchemaName": "schema1",
      "TableName": "tab1",
      "StorageType": "Heap Table",
      "ExpectTableSize": "1MB",
      "RealTableSize": "1.2MB",
      "BloatSize": "0.2MB",
      "BloatCeoff": "1.03",
      "SuggestedAction": "null",
      "TimeLastVacuumed": "2022-08-08T16:00:00Z",
      "TimeLastUpdated": "2022-08-08T20:00:00Z"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history