导出实例列表 - ExportingtheInstanceList
调试
您可以在API Explorer中调试该接口。
URI
POST /v3/{project_id}/instances/export
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
X-Language |
否 |
String |
参数解释: 语言。 约束限制: 不涉及。 取值范围:
默认取值: en-us |
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
instance_list |
否 |
Array of strings |
参数解释: 实例ID列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
user_defined_columns |
是 |
Array of strings |
参数解释: 导出字段列表。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
|
time_zone |
否 |
String |
参数解释: 时区。 约束限制: 不涉及。 取值范围: +08:00 默认取值: +08:00 |
|
language |
否 |
String |
参数解释: 语言。 约束限制: 不涉及。 取值范围:
默认取值: zh-cn |
响应参数
|
名称 |
参数类型 |
说明 |
|---|---|---|
|
- |
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-zlq-1,,e81eb780836340ea83007a004342171ein14,集中式版,企业版,GAUSSDBV2.0-9.0.0.SPC0500,正常,按需计费,4核|16GB,可用区1 |可用区3 |可用区2 ,192.168.0.217 / 192.168.0.139 / 192.168.0.91 / 192.168.0.204,,,8000,,\"2025/12/08 14:49:49 GMT+08:00\",超高IO,40GB,default_vpc,8293cb58-053d-4789-a6ab-485f6c191fc5,default,default,,1主2备"
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。