Exporting the Instance List

Function

This API is used to export the instance list. 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/export

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	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

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 a response is returned, the value of X-Subject-Token in the response header is the token. 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** Parameter description
Parameter	Mandatory	Type	Description
instance_list	No	Array of strings	Definition Instance IDs. Constraints N/A Range N/A Default Value N/A
user_defined_columns	Yes	Array of strings	Definition Fields to be exported. Constraints N/A Range name: instance name id: instance ID alias: instance description editionMode: edition type haModel: instance type deployMode: deployment model engine: DB engine version hotfixVersions: upgraded hot patch versions instanceStatus: instance status payModel: billing mode targetEngineVersion: target version flavor: instance specifications availableZones: AZs privateIp: private IP address dnsName: DNS ipv6: IPv6 address dbPort: database port publicIp: EIP createAt: creation time volumeType: storage type volumeSize: storage capacity vpcName: VPC name vpcId: VPC ID securityGroupName: security group enterpriseProjectName: enterprise project Default Value N/A
time_zone	No	String	Definition Time zone. Constraints N/A Range +08:00 Default Value +08:00
language	No	String	Definition Language. Constraints N/A Range zh-cn: Chinese en-us: English Default Value zh-cn

Response Parameters

**Table 4** Parameter description
Parameter	Type	Description
-	string	Definition CSV-formatted string. Range N/A

Example Request

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/export
{
	"language": "en-us",
	"instance_list": [],
	"time_zone": "+08:00",
	"user_defined_columns": [
		"name",
		"id",
		"alias",
		"editionMode",
		"haModel",
		"deployMode",
		"engine",
		"hotfixVersions",
		"instanceStatus",
		"payModel",
		"targetEngineVersion",
		"flavor",
		"availableZones",
		"privateIp",
		"dnsName",
		"ipv6",
		"dbPort",
		"publicIp",
		"createAt",
		"volumeType",
		"volumeSize",
		"vpcName",
		"vpcId",
		"securityGroupName",
		"enterpriseProjectName"
	]
}

Example Response

"DB Instance Name,alias,DB Instance ID,DB Instance Type,editionMode,DB Engine Version,Status,Billing Mode,Instance Class,AZ,Private IP Address,DNS Name,ipv6,Database Port,EIP,Created,Storage Type,Storage Size,VPC,VPC ID,Project,hotfixVersions,Deploy Mode,targetEngineVersion gauss-b703-jsw-in1,,971d91556d66421aad6dae7054cb39bain14,Distributed,enterprise,GAUSSDBV2.0-10.0.0,Creation failed,Pay-per-use,4vCPUs|16GB,az1 ,,,,8000,,"Dec 23, 2025 16:01:24 GMT+08:00",Ultra-high I/O,40GB,vpc-dr-master,08f140e0-c8de-4df5-ac90-37c0f2edf749,default,,Independent"