文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 实例管理/ 查询数据库实例列表

更新时间：2024-10-22 GMT+08:00

查询数据库实例列表

功能介绍

查询数据库实例列表/查询实例详情。

调用接口前，您需要了解API 认证鉴权。
调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

URI

GET https://{Endpoint}/v3.2/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
id	否	String	实例ID。 “”为系统保留字符，如果iID是以“”起始，表示按照后面的值模糊匹配，否则，按照ID精确匹配查询。不能只传入“”。
name	否	String	实例名称。 “”为系统保留字符，如果name是以“”起始，表示按照后面的值模糊匹配，否则，按照name精确匹配查询。不能只传入“”。
type	否	String	按照实例类型查询，取值区分大小写。取值范围： Enterprise（区分大小写），对应分布式实例（独立部署）。 Centralization_standard（区分大小写），对应主备版实例。
datastore_type	否	String	数据库类型，支持“GaussDB”，区分大小写。
vpc_id	否	String	虚拟私有云ID。方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。方法2：获取方法请参见《虚拟私有云API参考》中“查询VPC列表”的内容。
subnet_id	否	String	子网的网络ID信息。方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。方法2：获取方法请参见《虚拟私有云API参考》中“查询子网列表”的内容。
offset	否	Integer	索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。
limit	否	Integer	查询记录数。默认为100，不能为负数，最小值为1，最大值为100
tags	否	Array	根据实例标签键值对进行查询。 {key}表示标签键，不可以为空或重复。最大长度127个unicode字符。key不能为空或者空字符串，不能为空格，使用之前先trim前后半角空格。不能包含+/?#&=,%特殊字符。 {value}表示标签值，可以为空。最大长度255个unicode字符，使用之前先trim 前后半角空格。不能包含+/?#&=,%特殊字符。如果value为空，则表示any_value（查询任意value）。如果同时使用多个标签键值对进行查询，中间使用逗号分隔开，最多包含10组。
charge_mode	否	String	计费模式。取值范围： postPaid：后付费，即按需付费。 prePaid：预付费，即包年/包月。

请求参数

无。

响应参数

表3 响应参数
参数	参数类型	描述
instances	Array of 表4 objects	实例信息。
total_count	Integer	总记录数。

表4 instances
参数	参数类型	描述
id	String	实例ID。
name	String	创建的实例名称。
status	String	实例状态。取值：值为“BUILD”，表示实例正在创建。值为“ACTIVE”，表示实例正常。值为“FAILED”，表示实例异常。值为“FROZEN”，表示实例冻结。值为“MODIFYING”，表示实例正在扩容磁盘或者变更规格。值为“EXPANDING”，表示实例正在添加只读节点或扩容CN或DN。值为“REBOOTING”，表示实例正在重启。值为“REDUCING”, 表示实例正在删除只读节点。值为“UPGRADING”，表示实例正在升级。值为“RESTORING”，表示实例正在恢复。值为“SWITCHOVER”，表示实例正在主备切换。值为“MIGRATING”，表示实例正在迁移。值为“BACKING UP”，表示实例正在进行备份。值为“UPGRADE TO BE OBSERVED”，表示实例正在进行升级待观察。值为“REDUCING REPLICATION”，表示实例正在降副本。值为“STORAGE FULL”，表示实例磁盘空间满。
private_ips	Array of strings	实例内网IP地址列表。分布式CN所在的弹性云服务器创建成功后该值存在，主备版DN所在的弹性云服务器创建成功后该值存在，其他情况下为空字符串。
public_ips	Array of strings	实例外网IP地址列表。绑定弹性公网IP后，该值不为空。
port	Integer	数据库端口号。 GaussDB数据库端口设置范围为1024~39998（其中2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,20049,20050,21731,21732被系统占用不可设置）。当不传该参数时，默认端口8000。
type	String	实例类型，区分大小写。 Enterprise：分布式实例（企业版）。
ha	表5 object	获取分布式/主备版实例时返回。
replica_num	Integer	实例副本数。
region	String	实例所在区域。
datastore	表6 object	数据库信息。
created	String	创建时间，格式为“yyyy-mm-dd hh:mm:ss timezone”。其中timezone是指时区。说明：创建时该值为实例下发创建的时间，创建完成后，该值为创建完成时间。例如：2024-07-02 08:32:07 UTC。
updated	String	更新时间，格式与“created”字段对应格式完全相同。说明：创建时返回值为空，数据库实例创建成功后该值不为空。
db_user_name	String	默认用户名。
vpc_id	String	虚拟私有云ID。
subnet_id	String	子网的网络ID信息。
security_group_id	String	安全组ID。
flavor_ref	String	规格码。参考查询数据库规格中“spec_code”字段获取。
flavor_info	表8 object	规格信息。
volume	表9 object	Volume信息。
switch_strategy	String	数据库切换策略。如果创建实例时没有选择切换策略，则该字段不显示。取值为“Reliability”或“Availability”，分别对应于可靠性优先和可用性优先。若创建时没有选择切换策略，则不予显示。
backup_strategy	表10 object	备份策略。
maintenance_window	String	可维护时间窗，为UTC时间。
nodes	Array of 表11 objects	实例节点信息列表。
disk_encryption_id	String	磁盘加密密钥ID。只有创建磁盘加密实例才会显示该参数。
enterprise_project_id	String	企业项目标签ID。非企业项目账号的实例，企业项目默认0。
instance_mode	String	实例类型。 basic：基础版。 enterprise：企业版。
disk_encryption_id	String	磁盘加密密钥ID。只有创建磁盘加密实例才会显示该参数。
charge_info	表12 object	计费类型信息，支持按需和包周期。
time_zone	String	时区。
tags	Array of 表13 objects	标签列表，没有标签不返回该参数。
disk_usage	String	实例磁盘的可使用率，值范围[0-1]，值保留四位小数。
mysql_compatibility	表14 mysql_compatibility object	实例M兼容配置。

表5 ha
参数	参数类型	描述
consistency	String	数据库一致性类型，仅支持分布式实例。取值范围： strong：强一致性。 eventual：最终一致性。
replication_mode	String	备机同步参数，非空，支持“sync”，表示同步模式。

表6 datastore
参数	参数类型	描述
type	String	数据库引擎。
version	String	数据库大版本。
complete_version	String	数据库小版本。
target_version	String	数据库正在升级的目标版本。
complete_kernel_version	String	数据库内核版本。
hotfix_version_infos	Array of 表7 objects	热补丁信息列表。

表7 hotfix_version_infos
参数	参数类型	描述
version	String	热补丁版本。
upgrade_finished_time	String	热补丁升级完成时间列表。热补丁升级完成时间，格式为“yyyy-mm-dd hh:mm:ss timezone”。其中timezone是指时区。

表8 flavor_info
参数	参数类型	描述
vcpu	Integer	CPU核数。
mem	Integer	内存大小。

表9 volume
参数	参数类型	描述
type	String	磁盘类型。仅支持ULTRAHIGH和ESSD，区分大小写，分别表示SSD和极速云盘。
size	Integer	磁盘大小。

**表10** backup_strategy
参数	参数类型	描述
start_time	String	备份时间段。自动备份将在该时间段内触发。当前时间指UTC时间。
keep_days	Integer	已生成的备份文件可以保存的天数。取值范围：1～732。

**表11** nodes
参数	参数类型	描述
id	String	节点ID。
name	String	节点名称。
role	String	节点类型。 master：主节点。 slave：备节点。 secondary：日志节点。 readreplica：只读节点。
status	String	节点状态。值为“BUILD_FAILED”，表示节点创建失败。
availability_zone	String	可用区。
private_ip	String	节点内网IP。分布式实例类型下该参数仅针对CN节点有效，主备版实例类型下该参数对所有节点有效，且在弹性云服务器创建成功后参数值存在。
public_ip	String	绑定的外网IP。分布式实例类型下该参数仅针对CN节点有效，主备版实例类型下该参数对所有节点有效，且在弹性云服务器创建成功并绑定弹性公网IP后参数值存在。
component_names	String	节点上组件信息（例组件ID:分布式ID），多个组件信息用;隔开。

**表12** charge_info
参数	参数类型	描述
charge_mode	String	计费模式。取值范围： postPaid：后付费，即按需付费。 prePaid：预付费，即包年/包月。

**表13** tags
参数	参数类型	描述
key	String	标签键。
value	String	标签值。

**表14** mysql_compatibility
参数	参数类型	描述
port	String	M兼容端口。

请求示例

根据指定条件查询实例列表。

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.2/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in14&name=hy&type=Enterprise&datastore_type=GaussDB&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10

查询所有实例列表。

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.2/97b026aa9cc4417888c14c84a1ad9860/instances

响应示例

实例列表：

{ 
  "instances" : [ { 
    "id" : "b331ed66cc3249f78bc20737308c01f4in14", 
    "status" : "ACTIVE", 
    "name" : "gauss-9e88", 
    "port" : 8000, 
    "type" : "enterprise", 
    "ha" : { 
      "consistency" : "strong", 
      "replication_mode" : "sync" 
    }, 
    "region" : "cn-xianhz-1", 
    "datastore" : { 
      "type" : "GaussDB", 
      "version" : "2.7", 
      "complete_version" : "2.7.2", 
      "target_version" : "3.208.0", 
      "complete_kernel_version" : "V500R002C10SPC610" 
    }, 
    "created" : "2021-01-15 01:46:40 UTC", 
    "updated" : "2021-01-15 02:05:03 UTC", 
    "volume" : { 
      "type" : "ULTRAHIGH", 
      "size" : 120 
    }, 
    "nodes" : [ { 
      "id" : "02ebf757aaf94074855f49cc6e0e4712no14", 
      "name" : "gauss-9e88_gaussdbv5cn_2", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "cn_5001:" 
    }, { 
      "id" : "0a87b8ecbfeb46aba1409cfc0f0d5c34no14", 
      "name" : "gauss-9e88_gaussdbv5cn_0", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "cn_5002:" 
    }, { 
      "id" : "2d9fec1ab3834936b074d63acf48b1f2no14", 
      "name" : "gauss-9e88_gaussdbv5dn3_2", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6003:60073" 
    }, { 
      "id" : "48bb08a2d635435891ac0caa1c0bf2e3no14", 
      "name" : "gauss-9e88_gaussdbv5dn1_0", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6001:60011" 
    }, { 
      "id" : "5df830f652204827ada32f8bc28b107eno14", 
      "name" : "gauss-9e88_gaussdbv5dn1_1", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6002:60011" 
    }, { 
      "id" : "8a97a246cee841b38c5b47290d4c9c38no14", 
      "name" : "gauss-9e88_gaussdbv5cn_1", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "cn_5003:" 
    }, { 
      "id" : "8c1a3f8eecca4d9e9974a868bb6dd942no14", 
      "name" : "gauss-9e88_gaussdbv5dn2_0", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6004:60042" 
    }, { 
      "id" : "9bd0c80b8a684cc9bd7d99dd5adffb07no14", 
      "name" : "gauss-9e88_gaussdbv5dn3_1", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6005:60073" 
    }, { 
      "id" : "9e2a3cd541e249d4af5aa57c5d3a7f39no14", 
      "name" : "gauss-9e88_gaussdbv5dn1_2", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6006:60011" 
    }, { 
      "id" : "b046d28989ec4ae5a1a9ab20fe65f248no14", 
      "name" : "gauss-9e88_gaussdbv5dn2_2", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6007:60042" 
    }, { 
      "id" : "b614cc12fd3742dbb230245f88a7bf00no14", 
      "name" : "gauss-9e88_gaussdbv5dn3_0", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6008:60073" 
    }, { 
      "id" : "caba8e88c3c84ae58202f1f589490611no14", 
      "name" : "gauss-9e88_gaussdbv5dn2_1", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6009:60042" 
    } ], 
    "private_ips" : [ "192.168.28.81 / 192.168.27.52 / 192.168.16.253" ], 
    "public_ips" : [ ], 
    "db_user_name" : "root", 
    "vpc_id" : "5f84a5c4-2f93-41de-8359-d7acedb585cc", 
    "subnet_id" : "300036af-a92f-4e9e-8e9f-7d20e7878b05", 
    "security_group_id" : "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", 
    "flavor_ref" : "gaussdb.opengauss.ee.dn.m6.large.8.in", 
    "flavor_info" : { 
      "vcpu" : 2, 
      "mem" : 16 
    }, 
    "switch_strategy" : "Reliability", 
    "charge_info" : { 
      "charge_mode" : "prePaid" 
    }, 
    "backup_strategy" : { 
      "start_time" : "19:00-20:00", 
      "keep_days" : 7 
    }, 
    "maintenance_window" : "18:00-22:00", 
    "disk_encryption_id" : "24ae42b5-4009-4ea2-b66a-0b211e424dab", 
    "enterprise_project_id" : "6e76681b-a2f5-4c5f-97c5-ba4fd3c0dfb2", 
    "instance_mode" : "enterprise", 
    "time_zone" : "UTC+08:00", 
  
    "disk_usage" : "0.9890", 
    "mysql_compatibility" : { 
      "port" : 3306 
    } 
  }, { 
    "id" : "226b4afcfcc84c86bf1b9cb345d3b00fin14", 
    "status" : "ACTIVE", 
    "name" : "UTS-gauss-ad53-2C3D", 
    "port" : 8000, 
    "type" : "enterprise", 
    "ha" : { 
      "consistency" : "strong", 
      "replication_mode" : "sync" 
    }, 
    "region" : "cn-xianhz-1", 
    "datastore" : { 
      "type" : "GaussDB", 
      "version" : "2.7", 
      "complete_version" : "2.7.2", 
      "complete_kernel_version" : "V500R002C10SPC610", 
      "target_version" : "3.208.0", 
      "hotfix_version_infos" : [ { 
        "version" : "2.7.2.1", 
        "upgrade_finished_time" : "2020-12-23 03:21:41 UTC" 
      }, { 
        "version" : "2.7.2.2", 
        "upgrade_finished_time" : "2020-12-23 03:22:41 UTC" 
      } ] 
    }, 
    "created" : "2021-01-08 09:18:27 UTC", 
    "updated" : "2021-01-14 13:25:03 UTC", 
    "volume" : { 
      "type" : "ULTRAHIGH", 
      "size" : 120 
    }, 
    "nodes" : [ { 
      "id" : "07538a1def584cee99e2a5685eeab36ano14", 
      "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn3_1", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6009:60072" 
    }, { 
      "id" : "21f41baba1e2454f82331b7cb5aeabe5no14", 
      "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn1_2", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6008:60042" 
    }, { 
      "id" : "2909771a3b3e4e3998f9388e77d22391no14", 
      "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn1_0", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6007:60011" 
    }, { 
      "id" : "2bd9a90a5da242a6b0743a7f597f6106no14", 
      "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn2_2", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6006:60042" 
    }, { 
      "id" : "77092f1dadb74d3ea13d28269cdd3590no14", 
      "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn3_2", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6005:60072" 
    }, { 
      "id" : "a46bfaa6d5a24355a60fce7432b964cano14", 
      "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn3_0", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6004:60072" 
    }, { 
      "id" : "aa5277736f3844e2a7adeb9de529e2b1no14", 
      "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn2_1", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6003:60042" 
    }, { 
      "id" : "b1d798e4ea7344dfa95032984bc6cfd7no14", 
      "name" : "UTS-gauss-ad53-2C3D_gaussdbv5cn_1", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "cn_5002:" 
    }, { 
      "id" : "b9a46540186f4c0781eabaa2a79594cbno14", 
      "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn1_1", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6002:60011" 
    }, { 
      "id" : "d283813030364060ab64371d50294977no14", 
      "name" : "UTS-gauss-ad53-2C3D_gaussdbv5dn2_0", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6001:60042" 
    }, { 
      "id" : "eb7bce29b2284cd290405eaddc1b1a1eno14", 
      "name" : "UTS-gauss-ad53-2C3D_gaussdbv5cn_0", 
      "role" : "master", 
      "status" : "FAILED", 
      "availability_zone" : "az2xahz", 
      "component_names" : "cn_5001:" 
    } ], 
    "private_ips" : [ "192.168.30.44 / 192.168.29.231" ], 
    "public_ips" : [ "10.154.217.248" ], 
    "db_user_name" : "root", 
    "vpc_id" : "5f84a5c4-2f93-41de-8359-d7acedb585cc", 
    "subnet_id" : "300036af-a92f-4e9e-8e9f-7d20e7878b05", 
    "security_group_id" : "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", 
    "flavor_ref" : "gaussdb.opengauss.ee.dn.m6.large.8.in", 
    "flavor_info" : { 
      "vcpu" : 2, 
      "mem" : 16 
    }, 
    "switch_strategy" : "Reliability", 
    "charge_info" : { 
      "charge_mode" : "prePaid" 
    }, 
    "backup_strategy" : { 
      "start_time" : "18:00-19:00", 
      "keep_days" : 7 
    }, 
    "maintenance_window" : "18:00-22:00", 
    "enterprise_project_id" : "0", 
    "instance_mode" : "enterprise", 
    "time_zone" : "UTC+08:00", 
    "disk_usage" : "1.0000", 
    "mysql_compatibility" : { 
      "port" : 3306 
    } 
  }, { 
    "id" : "706c65c3dd7d497ab16f5b3a113690abin14", 
    "status" : "ACTIVE", 
    "name" : "UTS-gauss-7362", 
    "port" : 8000, 
    "type" : "enterprise", 
    "ha" : { 
      "replication_mode" : "sync" 
    }, 
    "region" : "cn-xianhz-1", 
    "datastore" : { 
      "type" : "GaussDB", 
      "version" : "2.7", 
      "complete_version" : "2.7.2", 
      "complete_kernel_version" : "V500R002C10SPC610", 
      "target_version" : "3.208.0", 
      "hotfix_version_infos" : [ { 
        "version" : "2.7.2.1", 
        "upgrade_finished_time" : "2020-12-23 03:21:41 UTC" 
      }, { 
        "version" : "2.7.2.2", 
        "upgrade_finished_time" : "2020-12-23 03:22:41 UTC" 
      } ] 
    }, 
    "created" : "2020-12-23 03:21:41 UTC", 
    "updated" : "2021-01-15 02:32:13 UTC", 
    "volume" : { 
      "type" : "ULTRAHIGH", 
      "size" : 80 
    }, 
    "nodes" : [ { 
      "id" : "25b7f16ee4084b7884d52f1bdfab4e68no14", 
      "name" : "UTS-gauss-7362_gaussdbv5dn1_2", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6003:60011" 
    }, { 
      "id" : "ad6f02f31744422fa8ce487e81c9e7afno14", 
      "name" : "UTS-gauss-7362_gaussdbv5cn_0", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "cn_5001:" 
    }, { 
      "id" : "b30c56582bf44a548e3bb5b5af6c4773no14", 
      "name" : "UTS-gauss-7362_gaussdbv5dn1_1", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6002:60011" 
    }, { 
      "id" : "f79ea0600cba42b2888bd9bd67e52a79no14", 
      "name" : "UTS-gauss-7362_gaussdbv5dn1_0", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6001:60011" 
    } ], 
    "private_ips" : [ "192.168.26.70" ], 
    "public_ips" : [ ], 
  
    "db_user_name" : "root", 
    "vpc_id" : "5f84a5c4-2f93-41de-8359-d7acedb585cc", 
    "subnet_id" : "300036af-a92f-4e9e-8e9f-7d20e7878b05", 
    "security_group_id" : "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", 
    "flavor_ref" : "gaussdb.opengauss.ee.dn.m6.large.8.in", 
    "flavor_info" : { 
      "vcpu" : 2, 
      "mem" : 16 
    }, 
    "switch_strategy" : "Reliability", 
    "charge_info" : { 
      "charge_mode" : "postPaid" 
    }, 
    "backup_strategy" : { 
      "start_time" : "16:00-17:00", 
      "keep_days" : 7 
    }, 
    "maintenance_window" : "18:00-22:00", 
    "enterprise_project_id" : "0", 
    "instance_mode" : "enterprise", 
    "time_zone" : "UTC+08:00", 
    "disk_usage" : "0.9940", 
    "mysql_compatibility" : { 
      "port" : 3306 
    } 
  }, { 
    "id" : "4ad42d079a3948d88c28d6236211b21ein14", 
    "status" : "ACTIVE", 
    "name" : "UTS-gauss-4336", 
    "port" : 8000, 
    "type" : "enterprise", 
    "ha" : { 
      "replication_mode" : "sync" 
    }, 
    "region" : "cn-xianhz-1", 
    "datastore" : { 
      "type" : "GaussDB", 
      "version" : "2.7", 
      "complete_version" : "2.7.2", 
      "complete_kernel_version" : "V500R002C10SPC610", 
      "target_version" : "3.208.0", 
      "hotfix_version_infos" : [ { 
        "version" : "2.7.2.1", 
        "upgrade_finished_time" : "2020-12-23 03:21:41 UTC" 
      }, { 
        "version" : "2.7.2.2", 
        "upgrade_finished_time" : "2020-12-23 03:22:41 UTC" 
      } ] 
    }, 
    "created" : "2020-12-03 14:28:53 UTC", 
    "updated" : "2021-01-14 13:20:10 UTC", 
    "volume" : { 
      "type" : "ULTRAHIGH", 
      "size" : 40 
    }, 
    "nodes" : [ { 
      "id" : "254dbda6f03643519ad64b39481bd11cno14", 
      "name" : "UTS-gauss-4336_gaussdbv5dn1_2", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az1xahz", 
      "component_names" : "dn_6001:60011" 
    }, { 
      "id" : "6ad76d4db26443c2a93b280739a31558no14", 
      "name" : "UTS-gauss-4336_gaussdbv5dn1_1", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az1xahz", 
      "component_names" : "dn_6002:60011" 
    }, { 
      "id" : "9fdebf821bdf444a8689b19c0ff588ceno14", 
      "name" : "UTS-gauss-4336_gaussdbv5cn_0", 
      "role" : "master", 
      "status" : "FAILED", 
      "availability_zone" : "az1xahz", 
      "component_names" : "cn_5001:" 
    }, { 
      "id" : "dd64bdbc02a542d88823b1582f772d25no14", 
      "name" : "UTS-gauss-4336_gaussdbv5cn_1", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az1xahz", 
      "component_names" : "cn_5002:" 
    }, { 
      "id" : "de3c41461045466faf6c2b96eb709540no14", 
      "name" : "UTS-gauss-4336_gaussdbv5dn1_0", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az1xahz", 
      "component_names" : "dn_6001:60011" 
    } ], 
    "private_ips" : [ "192.168.30.93 / 192.168.29.232" ], 
    "public_ips" : [ ], 
    "db_user_name" : "root", 
    "vpc_id" : "5f84a5c4-2f93-41de-8359-d7acedb585cc", 
    "subnet_id" : "300036af-a92f-4e9e-8e9f-7d20e7878b05", 
    "security_group_id" : "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", 
    "flavor_ref" : "gaussdb.opengauss.ee.dn.m6.large.8.in", 
    "flavor_info" : { 
      "vcpu" : 2, 
      "mem" : 16 
    }, 
    "switch_strategy" : "Reliability", 
    "charge_info" : { 
      "charge_mode" : "postPaid" 
    }, 
    "backup_strategy" : { 
      "start_time" : "18:00-19:00", 
      "keep_days" : 7 
    }, 
    "maintenance_window" : "18:00-22:00", 
    "enterprise_project_id" : "0", 
    "instance_mode" : "basic", 
    "time_zone" : "UTC+08:00", 
    "disk_usage" : "1.0000", 
    "mysql_compatibility" : { 
      "port" : 3306 
    } 
  } ], 
  "total_count" : 4 
}

实例详情

{ 
  "instances" : [ { 
    "id" : "706c65c3dd7d497ab16f5b3a113690abin14", 
    "status" : "ACTIVE", 
    "name" : "UTS-gauss-7362", 
    "port" : 8000, 
    "type" : "enterprise", 
    "ha" : { 
      "replication_mode" : "sync" 
    }, 
    "region" : "cn-xianhz-1", 
    "datastore" : { 
      "type" : "GaussDB", 
      "version" : "2.7", 
      "complete_version" : "2.7.2", 
      "complete_kernel_version" : "V500R002C10SPC610", 
      "target_version" : "3.208.0", 
      "hotfix_version_infos" : [ { 
        "version" : "2.7.2.1", 
        "upgrade_finished_time" : "2020-12-23 03:21:41 UTC" 
      }, { 
        "version" : "2.7.2.2", 
        "upgrade_finished_time" : "2020-12-23 03:22:41 UTC" 
      } ] 
    }, 
    "created" : "2020-12-23 03:21:41 UTC", 
    "updated" : "2021-01-15 02:32:13 UTC", 
    "volume" : { 
      "type" : "ULTRAHIGH", 
      "size" : 80 
    }, 
    "nodes" : [ { 
      "id" : "25b7f16ee4084b7884d52f1bdfab4e68no14", 
      "name" : "UTS-gauss-7362_gaussdbv5dn1_2", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6003:60011" 
    }, { 
      "id" : "ad6f02f31744422fa8ce487e81c9e7afno14", 
      "name" : "UTS-gauss-7362_gaussdbv5cn_0", 
      "role" : "master", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "cn_6004:" 
    }, { 
      "id" : "b30c56582bf44a548e3bb5b5af6c4773no14", 
      "name" : "UTS-gauss-7362_gaussdbv5dn1_1", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6002:60011" 
    }, { 
      "id" : "f79ea0600cba42b2888bd9bd67e52a79no14", 
      "name" : "UTS-gauss-7362_gaussdbv5dn1_0", 
      "role" : "slave", 
      "status" : "ACTIVE", 
      "availability_zone" : "az2xahz", 
      "component_names" : "dn_6001:60011" 
    } ], 
    "private_ips" : [ "192.168.26.70" ], 
    "public_ips" : [ ], 
    "db_user_name" : "root", 
    "vpc_id" : "5f84a5c4-2f93-41de-8359-d7acedb585cc", 
    "subnet_id" : "300036af-a92f-4e9e-8e9f-7d20e7878b05", 
    "security_group_id" : "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", 
    "flavor_ref" : "gaussdb.opengauss.ee.dn.m6.large.8.in", 
    "flavor_info" : { 
      "vcpu" : 2, 
      "mem" : 16 
    }, 
    "switch_strategy" : "Reliability", 
    "charge_info" : { 
      "charge_mode" : "postPaid" 
    }, 
    "backup_strategy" : { 
      "start_time" : "16:00-17:00", 
      "keep_days" : 7 
    }, 
    "maintenance_window" : "18:00-22:00", 
    "disk_encryption_id" : "", 
    "enterprise_project_id" : "0", 
    "instance_mode" : "enterprise", 
    "time_zone" : "UTC+08:00", 
    "disk_usage" : "0.9670" 
  } ], 
  "total_count" : 1 
}

状态码

正常
 200
异常
 请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

上一篇：删除数据库实例

下一篇：重置数据库密码

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消