查询实例列表和详情

接口说明

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

调试

您可以在API Explorer中调试该接口。

URI

• URI格式

  GET https://{Endpoint}/v3/{project_id}/instances?id={id}&name={name}&mode={mode}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}&tags={key}={value},{key}={value}

• URI样例
  • 查询所有实例列表和详情

    https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances

  • 根据指定条件查询实例列表和详情

    https://dds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances?offset=0&limit=10&id=ed7cc6166ec24360a5ed5c5c9c2ed726in02&name=hy&mode=ReplicaSet&datastore_type=DDS-Community&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&tags=key1=value1,key2=value2

请求消息

无。

响应消息

• 参数说明

  表2 响应Body参数

  名称	参数类型	是否必选	描述
  instances	Array of objects	是	实例信息。详情请参见表3。
  total_count	Integer	是	总记录数。

  表3 instances字段数据结构说明

  名称	参数类型	是否必选	描述
  id	String	是	实例ID。
  name	String	是	实例名称。
  remark	String	是	实例备注。
  status	String	是	实例状态。 取值： normal，表示实例正常。 abnormal，表示实例异常。 creating，表示实例创建中。 frozen，表示实例被冻结。 data_disk_full，表示存储空间满。 createfail，表示实例创建失败。 enlargefail，表示实例扩容节点个数失败。 说明： 实例正在执行的动作（actions），例如“rebooting，重启中”与实例状态（status）有本质的区别。详情请参见该表中的actions字段。
  port	String	是	数据库端口号。文档数据库实例支持的端口号范围为2100～9500。
  mode	String	是	实例类型。与请求参数相同。
  region	String	是	实例所在区域。
  datastore	Object	是	数据库信息。 详情请参见表4。
  engine	String	是	存储引擎。支持WiredTiger/RocksDB存储引擎。 数据库版本为4.2及以上时，存储引擎为RocksDB，取值为“rocksDB”。 数据库版本为4.0和3.4时，存储引擎为WiredTiger，取值为“wiredTiger”。
  created	String	是	实例创建时间。
  updated	String	是	实例操作最新变更的时间。
  db_user_name	String	是	默认用户名。取值为“rwuser”。
  ssl	Integer	是	是否开启SSL安全连接。 取值为“1”，表示开启。 取值为“0”，表示不开启。
  vpc_id	String	是	虚拟私有云ID。
  subnet_id	String	是	子网的网络ID。
  security_group_id	String	是	安全组ID列表。当实例存在多安全组时，多个安全组ID采用英文逗号分隔。
  backup_strategy	Object	是	备份策略。 详情请参见表5。
  pay_mode	String	否	计费方式。 取值为“0”，表示按需计费。 取值为“1”，表示包年/包月计费。
  maintenance_window	String	是	系统可维护时间窗。
  groups	Array of objects	是	组信息。 详情请参见表6。
  disk_encryption_id	String	是	磁盘加密的密钥ID。该参数仅在实例磁盘被加密时返回。
  enterprise_project_id	String	是	企业项目ID。 取值为“0”，表示为default企业项目。
  time_zone	String	是	时区。
  dss_pool_id	String	否	Dec用户专属存储ID。
  actions	Array of strings	是	实例正在执行的动作。 取值： RESTARTING，重启中。 RESTORE，恢复中。 RESIZE_FLAVOR，规格变更中。 RESTORE_TO_NEW_INSTANCE，恢复中。 MODIFY_VPC_PEER，跨子网访问设置中。 CREATE，创建中。 FROZEN，冻结。 RESIZE_VOLUME，存储扩容中。 RESTORE_CHECK，恢复检查中。 RESTORE_FAILED_HANGUP，恢复失败。 CLOSE_AUDIT_LOG，关闭审计策略中。 OPEN_AUDIT_LOG，打开审计策略中。 PERIOD_RESOURCE_SPEC_CHG，包周期资源变更检查中。 CREATE_IP_SHARD，shard IP显示开启中。 CREATE_IP_CONFIG，config IP显示开启中。 GROWING，节点扩容中。 SET_CONFIGURATION，修改参数中。 RESTORE_TABLE，恢复中。 MODIFY_SECURITYGROUP，修改安全组中。 BIND_EIP，修改公网EIP中。 UNBIND_EIP，解绑EIP中。 SWITCH_SSL，切换SSL中。 SWITCH_PRIMARY，主备切换中。 CHANGE_DBUSER_PASSWORD，修改密码中。 MODIFY_PORT，修改端口号中。 MODIFY_IP，修改内网IP中。 DELETE_INSTANCE，实例删除中。 REBOOT，重启中。 BACKUP，备份中。 MIGRATE_AZ，可用区迁移中。 PWD_RESETING，重置密码中。 UPGRADE_DATABASE，补丁升级中。 DATA_MIGRATION，数据迁移中。 SHARD_GROWING，分片扩容中。 APPLY_CONFIGURATION，变更参数组中。 RESET_PASSWORD，重置密码中。 GROWING_REVERT，删除节点中。 SHARD_GROWING_REVERT，分片删除中。 ONDEMAND_TO_PERIOD，转包周期中。 LOG_PLAINTEXT_SWITCH，慢日志配置修改中。 CREATE_DATABASE_USER，创建数据库用户中。 CREATE_DATABASE_ROLE，创建数据库角色中。 MODIFY_NAME，修改名称中。 MODIFY_PRIVATE_DNS，修改内网域名中。 MODIFY_OP_LOG_SIZE，oplog大小修改中。 ADD_READONLY_NODES，只读节点扩容中。
  order_id	String	否	订单ID，仅包周期场景返回。
  tags	Array of objects	是	标签列表。 详情请参见表9。

  表4 datastore字段数据结构说明

  名称	参数类型	是否必选	描述
  type	String	是	数据库引擎。
  version	String	是	数据库版本。支持5.0、4.4、4.2、4.0、3.4版本，取值为“5.0”、“4.4”、“4.2”、“4.0”、“3.4”。
  patch_available	Boolean	是	当前实例是否有可升级的补丁，返回true时可以通过“数据库补丁升级”进行升级。

  表5 backup_strategy字段数据结构说明

  名称	参数类型	是否必选	描述
  start_time	String	是	备份时间段。自动备份将在该时间段内触发。当前时间指UTC时间。
  keep_days	Integer	是	已生成备份文件可以保存的天数。取值范围：0~732。

  表6 groups字段数据结构说明

  名称	参数类型	是否必选	描述
  type	String	是	节点类型。 取值： shard config mongos replica single readonly
  id	String	是	组ID。节点类型为shard、config和readonly时，该参数有效。
  name	String	是	组名称。节点类型为shard、config和readonly时，该参数有效。
  status	String	是	组状态。节点类型为shard、config和readonly时，该参数有效。
  volume	Object	是	volume信息。详情请参见表7。节点类型为shard、config、replica、single、readonly时，该参数有效。
  nodes	Array of objects	是	节点信息。详情请参见表8。

  表7 volume字段数据结构说明

  名称	参数类型	是否必选	描述
  size	String	是	磁盘大小。单位：GB。
  used	String	是	磁盘使用量。单位：GB。

  表8 nodes字段数据结构说明

  名称	参数类型	是否必选	描述
  id	String	是	节点ID。
  name	String	是	节点名称。
  status	String	是	节点状态。
  role	String	是	节点角色。 取值： master，mongos节点返回该值。 Primary，shard组主节点、config组主节点、副本集主节点、单节点返回该值。 Secondary，shard组备节点、config组备节点、副本集备节点返回该值。 Hidden，shard组隐藏节点、config组隐藏节点、副本集隐藏节点返回该值。 unknown，节点异常时返回该值。 Readonly, 只读节点返回改值。
  private_ip	String	是	节点内网IP。该参数默认仅针对集群实例的mongos节点、副本集实例、以及单节点实例有效，且在弹性云服务器创建成功后参数值存在，否则，值为""。 注意： 打开shard或者config IP 之后，集群实例的shard节点或者config节点的Primary、Secondary节点也会有该值。
  public_ip	String	是	绑定的外网IP。该参数仅针对集群实例的mongos节点、副本集实例的主节点和备节点、以及单节点实例有效。
  spec_code	String	是	资源规格编码。关于实例的规格信息，请参见查询数据库规格中响应参数“flavors.spec_code”的值。
  availability_zone	String	是	可用区。

  表9 tag字段说明

  名称	参数类型	是否必选	描述
  key	String	是	标签键。
  value	String	是	标签值。

  

  响应示例中参数“region”和“availability_zone”的值为示例值。

状态码

详情请参见状态码。

错误码

详情请参见错误码。