- 最新动态
- 功能总览
-
服务公告
- 漏洞公告
-
产品公告
- 【通知】2024年11月5日起文档数据库服务DDS5.0版本集群开放公测
- 【通知】2024年10月11日起文档数据库服务DDS副本集5.0版本开始转商计费
- 【通知】华为云文档数据库服务DDS3.4版本计划于2024年10月11日停售
- 【通知】2024年07月24日起文档数据库服务DDS5.0版本开放公测
- 【通知】2023年02月15日起文档数据库服务上线x86架构增强Ⅱ型副本集和集群shard的1:8系列规格
- 【通知】文档数据库服务DDS4.4邀请公测
- 【停售公告】华为云文档数据库服务DDS单节点规格计划于2023年07月15日停售内部通知
- 【通知】2023年10月8日起文档数据库服务DDS4.4版本开始转商计费
- 版本说明
- 产品发布说明
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 购买实例
- 连接实例
- 数据迁移
- 性能调优
- 权限管理
- 实例生命周期管理
- 变更实例
- 数据备份
- 数据恢复
- 参数模板管理
- 连接管理
- 数据库使用
- 数据安全性
- 监控与告警
- 审计
- 日志管理
- 任务中心
- 智能DBA助手
- SQL自动查杀
- 跨可用区容灾
- 标签管理
- 配额管理
- DDS使用规范建议
- 开发指南
- 最佳实践
- 安全白皮书
- 性能白皮书
-
API参考
- 使用前必读
- API概览
- 如何调用API
- 快速入门
-
API v3(推荐)
- 查询API版本
- 查询数据库版本信息
- 查询数据库规格
- 查询数据库磁盘类型
-
实例管理
- 创建实例
- 重启实例
- 删除实例
- 查询实例列表和详情
- 扩容实例存储容量
- 扩容集群实例的节点数量
- 变更实例规格
- 切换副本集实例的主备节点
- 切换SSL开关
- 修改实例名称
- 修改实例备注
- 修改数据库端口
- 变更实例安全组
- 绑定弹性公网IP
- 解绑弹性公网IP
- 修改实例内网地址
- 创建集群的Shard/Config IP
- 副本集跨网段访问配置
- 查询实例可迁移到的可用区
- 实例可用区迁移
- 设置实例回收站策略
- 扩容副本集实例的节点数量
- 实例新增只读节点
- 数据库补丁升级
- 开启/关闭秒级监控
- 查询秒级监控配置
- 设置可维护时间段
- 查询实例回收站策略
- 查询回收站实例列表
- 检查弱密码
- 查询数据库补丁升级预估时长
- 查询实例磁盘信息
- 获取SSL证书下载地址
- 查询数据库复制集名称
- 修改数据库复制集名称
- 删除实例的节点
- 删除实例的只读节点
- 查询副本集跨网段访问配置
- 查询LTS日志配置信息
- 关联LTS日志流
- 解除关联LTS日志流
- 设置磁盘自动扩容策略
- 查询磁盘自动扩容策略
- 批量数据库补丁升级
- 连接管理
- 备份与恢复
- 参数配置
- 获取日志信息
- 标签管理
- 管理数据库和用户
- 配额管理
- 数据库运维
- 任务管理
- API v3(即将下线)
- 应用示例
- 权限策略和授权项
- 附录
- SDK参考
- 常见问题
-
故障排除
- 概述
- DDS实例节点故障处理机制
- 连接失败,提示:network error while attempting to run command ‘isMaster’
- 连接失败,提示:No route to host以及connection attempt failed
- 连接失败,提示:Authentication failed
- 连接失败,提示:couldn't connect to server
- 连接失败,提示:cannot list multiple servers in URL without ‘replicaSet’ option
- Java驱动连接实例失败,提示:Timeout while receiving message
- 连接失败,提示:exception: login failed 以及 U_STRINGPREP_PROHIBITED_ERROR
- 视频帮助
- 产品术语
-
更多文档
- 用户指南(阿布扎比区域)
- API参考(阿布扎比区域)
- 用户指南(巴黎区域)
- API参考 (巴黎区域)
- 用户指南(吉隆坡区域)
- API参考(吉隆坡区域)
- 通用参考
链接复制成功!
查询实例列表
功能介绍
根据指定条件查询实例列表。
URI
- URI格式
GET /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}
- 参数说明
表1 参数说明 名称
是否必选
参数类型
描述
project_id
是
String
租户在某一region下的project ID。
id
否
String
实例ID。
name
否
String
实例名称。
如果name以“*”起始,表示按照“*”后面的值模糊匹配,否则,按照实际填写的name精确匹配查询。
说明:
“*”为系统保留字符,不能只传入该字符。
mode
否
String
实例类型。
- 取值为“Sharding”,表示集群实例。
- 取值为“ReplicaSet”,表示副本集实例。
datastore_type
否
String
数据库版本类型。取值为“DDS-Community”。
vpc_id
否
String
虚拟私有云ID,获取方法如下:
- 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。
- 方法2:获取方法请参见《虚拟私有云API参考》中“查询VPC列表”的内容。
subnet_id
否
String
子网的网络ID,获取方法如下:
- 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。
- 方法2:获取方法请参见《虚拟私有云API参考》中“查询子网列表”的内容。
offset
否
Integer
索引位置偏移量,表示从指定project ID下最新的实例创建时间开始,按时间的先后顺序偏移offset条数据后查询对应的实例信息。
取值大于或等于0。不传该参数时,查询偏移量默认为0,表示从最新的实例创建时间对应的实例开始查询。
limit
否
Integer
查询实例个数上限值。
取值范围:1~100。不传该参数时,默认查询前100条实例信息。
请求消息
- 请求头
根据指定条件查询实例列表:
GET https://DDS的Endpoint/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
响应消息
- 要素说明
表2 要素说明 名称
参数类型
描述
instances
Array of objects
实例信息。详情请参见表3。
total_count
Integer
总记录数。
表3 instances字段数据结构说明 名称
参数类型
描述
id
String
实例ID。
name
String
实例名称。
status
String
实例状态。
取值:
- normal,表示实例正常。
- abnormal,表示实例异常。
- creating,表示实例创建中。
- data_disk_full,表示实例磁盘已满。
- createfail,表示实例创建失败。
- enlargefail,表示实例扩容节点个数失败。
port
Integer
数据库端口号。文档数据库实例支持的端口号范围为2100~9500。
mode
String
实例类型。与请求参数相同。
region
String
实例所在区域。
datastore
Object
数据库信息。详情请参见表4。
engine
String
存储引擎。取值为“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”。
maintenance_window
String
系统可维护时间窗。
groups
Array of objects
组信息。详情请参见表6。
time_zone
String
时区。
actions
Array of strings
实例正在执行的动作。
表5 backup_strategy字段数据结构说明 名称
参数类型
描述
start_time
String
备份时间段。自动备份将在该时间段内触发。当前时间指UTC时间。
keep_days
Integer
已生成备份文件可以保存的天数。取值范围:0~732。
表6 groups字段数据结构说明 名称
参数类型
描述
type
String
节点类型。
取值:
- shard
- config
- mongos
- replica
id
String
组ID。节点类型为shard和config时,该参数有效。
name
String
组名称。节点类型为shard和config时,该参数有效。
status
String
组状态。节点类型为shard和config时,该参数有效。
volume
Object
volume信息。详情请参见表7。节点类型为shard、config、replica时,该参数有效。
nodes
Array of objects
节点信息。详情请参见表8。
表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节点以及副本集实例有效,且在弹性云服务器创建成功后参数值存在,否则,值为""。
public_ip
String
绑定的外网IP。该参数仅针对集群实例的mongos节点、副本集实例的主节点和备节点有效。
spec_code
String
资源规格编码。关于实例的规格信息,请参见查询所有实例规格信息中响应参数“flavors.spec_code”的值。
availability_zone
String
可用区。
说明:
响应样例中参数“region”和“availability_zone”的值为示例值。
- 响应样例
状态码
详情请参见状态码。
错误码
详情请参见错误码。