Exporting Table Information

Function

This API is used to export table information. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

URI

POST /v3/{project_id}/instances/{instance_id}/table-volume/export

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After the request is processed, the value of X-Subject-Token in the message header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn en-us Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
database_name	Yes	String	Definition Database name. Constraints N/A Range N/A Default Value N/A
schema_names	Yes	Array of strings	Definition Schema name. Constraints N/A
table_name	No	String	Definition Table name. Constraints N/A Range N/A Default Value N/A
user_name	No	String	Definition Username of a table. Constraints N/A Range N/A Default Value N/A
sort_key	No	String	Definition Sorting field. Constraints N/A Range table_size: table size id: table ID table_name: table name table_owner: name of the user that the table belongs to database_name: database name schema_name: schema name is_part_type: whether the table or index has the property of a partitioned table is_hash_cluster_key: whether the table contains a hash-partitioned column tuples: number of rows in the table create_time: creation time update_time: modification time average_size: average table size (total table size divided by the number of DNs), which is the ideal size of tables distributed on each DN max_ratio: ratio of the maximum table size on a single DN to the total table size min_ratio: ratio of the minimum table size on a single DN to the total table size skew_size: table skew (the maximum table size on a single DN minus the minimum table size on a single DN) skew_ratio: table skew ratio (skew size divided by total table size) skew_stddev: standard deviation of table distribution (For two tables of the same size, a larger deviation indicates a more severe skew.) Default Value N/A
sort_order	No	String	Definition Sorting method. Constraints N/A Range DESC: descending order ASC: ascending order Default Value N/A

Response Parameters

None

Example Request

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/1528a5fecb4449ec9d383630ec58b1d3/instances/d04686c6baae4f65a742771186f47b7ain14/table-volume/export
{
  "database_name": "postgres",
  "schema_names": [
    "snapshot"
  ]
}