# 导出实例列表 - ExportingtheInstanceList #### 功能介绍 导出实例列表。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ExportInstanceInfos)中调试该接口。 #### URI POST /v3/{project_id}/instances/export 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | 表3参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | instance_list | 否 | Array of strings | **参数解释** **：** 实例ID列表。获取方式请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)。 **约束限制** **：** 不涉及。 **取值范围** **：** 不涉及。 **默认取值** **：** 不涉及。 | | user_defined_columns | 是 | Array of strings | **参数解释** **：** 导出字段列表。 **约束限制** **：** 不涉及。 **取值范围** **：** - name：实例名称。 - id：实例ID。 - alias：实例备注。 - editionMode：产品类型。 - haModel：实例类型。 - deployMode：部署形态。 - engine：数据库引擎版本。 - hotfixVersions：已升级热补丁。 - instanceStatus：实例状态。 - payModel：计费模式。 - targetEngineVersion：目标版本。 - flavor：性能规格。 - availableZones：可用区。 - privateIp：内网地址。 - dnsName：DNS。 - ipv6：IPv6地址。 - dbPort：数据库端口。 - publicIp：弹性公网IP。 - createAt：创建时间。 - volumeType：存储空间类型。 - volumeSize：存储空间大小。 - vpcName：虚拟私有云名称。 - vpcId：虚拟私有云ID。 - securityGroupName：安全组。 - enterpriseProjectName：企业项目。 **默认取值** **：** 不涉及。 | | time_zone | 否 | String | **参数解释** **：** 时区。 **约束限制** **：** 不涉及。 **取值范围** **：** +08:00 **默认取值** **：** +08:00 | | language | 否 | String | **参数解释** **：** 语言。 **约束限制** **：** 不涉及。 **取值范围** **：** - zh-cn：中文。 - en-us：英文。 **默认取值** **：** zh-cn | #### 响应参数 表4参数说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | - | string | **参数解释** **：** csv格式字符串。 **取值范围** **：** 不涉及。 | #### 请求示例 ``` POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/export { "language": "zh-cn", "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" ] } ``` #### 响应示例 ``` "实例名称,实例备注,实例ID,实例类型,产品类型,数据库引擎版本,实例状态,计费模式,性能规格,可用区,内网地址,内网域名,IPv6地址,数据库端口,弹性公网IP,创建时间,存储空间类型,存储空间大小,虚拟私有云,虚拟私有云ID,安全组,企业项目,已升级热补丁版本,部署形态,目标版本 gauss-9c1d,,37828da9b52b43f38fb33ac52beaccbain14,集中式版,企业版,GAUSSDBV2.0-10.1.0,正常,按需计费,4核|32GB,可用区3 ,192.168.232.105 / 192.168.76.223 / 192.168.140.19,,,8000,,"2026/08/28 15:17:34 GMT+08:00",超高IO,40GB,vpc-more-subnet,44a8dcb3-c802-4be9-8114-ba6bf42ac3ee,default,default,,1主2备" ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。