查询实例列表和详情-凯发k8国际娱乐官网入口

接口说明

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

调试

您可以在中调试该接口。

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。
  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	是	数据库版本。支持4.2、4.0、3.4版本，取值为“4.2”、“4.0”、“3.4”。 说明： 目前dds 4.2版本受限商用，详情请参见。 为了保证您的文档数据库使用体验，建议创建4.0版本的数据库。
  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
  id	string	是	组id。节点类型为shard和config时，该参数有效。
  name	string	是	组名称。节点类型为shard和config时，该参数有效。
  status	string	是	组状态。节点类型为shard和config时，该参数有效。
  volume	object	是	volume信息。详情请参见表7。节点类型为shard、config、replica、single时，该参数有效。
  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，节点异常时返回该值。
  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”的值为示例值。

状态码

详情请参见。

错误码

详情请参见。