查询实例列表v2
更新时间 2025-11-06 11:22:12
最近更新时间: 2025-11-06 11:22:12
接口功能介绍
查询用户的实例列表
接口约束
无
URI
GET /DDS2/v2/openApi/getAllInstances
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNow | 否 | Integer | 当前页，不传默认为1 | 1 | |
| pageSize | 否 | Integer | 页大小，不传默认为10 | 10 | |
| resDbEngine | 否 | String | 版本号 | 4.0 | |
| prodInstName | 否 | String | 实例名称 | dds-xxx | |
| prodInstId | 否 | String | 实例ID | xxxx |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | 0 | |
| regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应码 取值范围：800为成功，900为失败 | 800 | |
| message | String | 响应信息 | 查询文档数据库服务的实例列表成功 | |
| returnObj | Object | 返回对象数组 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。 | ||
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| lastPage | Integer | 最后一页的页码 | 1 | |
| navigatepageNums | Array of Integers | 可用于导航的页码数组 | [1] | |
| startRow | Integer | 当前页的第一行的索引 | 1 | |
| hasNextPage | Boolean | 指示是否有下一页数据可用 | false | |
| prePage | Integer | 前一页的页码 | 0 | |
| nextPage | Integer | 下一页的页码 | 0 | |
| endRow | Integer | 当前页的最后一行的索引 | 1 | |
| pageSize | Integer | 每页包含的数据条目数量 | 10 | |
| list | Array of Objects | 查询结果主体 | list | |
| pageNum | Integer | 当前页的页码 | 1 | |
| navigatePages | Integer | 导航页数的数量 | 8 | |
| total | Integer | 总数据条目数量 | 1 | |
| pages | Integer | 总页数 | 1 | |
| firstPage | Integer | 第一页的页码 | 1 | |
| size | Integer | 当前页包含的数据条目数量 | 1 | |
| isLastPage | Boolean | 指示当前页是否是最后一页 | true | |
| hasPreviousPage | Boolean | 指示是否有前一页数据可用 | false | |
| isFirstPage | Boolean | 指示当前页是否是第一页 | true | |
| 表 list |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| prodInstId | String | 实例id | 60d420bffb394************************* | |
| prodInstName | String | 实例名称 | dds-668-yunhong | |
| prodType | Integer | 0:单机 2:副本集(三节点) 4:副本集(五节点) 6:副本集(七节点) 10:分片集群 | 10 | |
| tplName | String | 模板名称 | DDS-4.0-集群版 | |
| prodDbEngine | String | dds数据库产品的版本 | 4.0 | |
| prodRunningStatus | Integer | 实例运行状态: 0->运行正常, 1->重启中, 2-备份操作中,3->恢复操作中,4->转换ssl,5->异常,6->修改参数组中,7->已冻结,8->已注销,9->施工中,10->施工失败,11->扩容中,12->主备切换中 | 0 | |
| billMode | Integer | 1:包周期计费,2:按需计费 | 1 | |
| createTime | Integer | 创建时间 | 1688626478000 | |
| expireTime | Integer | 到期时间 | 1691304902000 | |
| releasedTime | Integer | 回收时间 | 1691604903000 | |
| innerVersion | String | 小版本号 | v00 |
枚举参数
无
请求示例
请求url
/v2/openApi/getAllInstances
请求头header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
请求体body
无
响应示例
{
"statusCode": 800,
"message": "查询文档数据库服务的实例列表成功",
"returnObj": {
"lastPage": 0,
"navigatepageNums": null,
"startRow": 0,
"hasNextPage": false,
"prePage": 0,
"nextPage": 0,
"endRow": 0,
"pageSize": 1,
"list": [
{
"innerVersion": "v00",
"expireTime": 1717999024000,
"prodInstName": "dds-549-pzy",
"tplName": "DDS-4.0-副本集三副本",
"createTime": 1715324696000,
"prodDbEngine": "4.0",
"prodRunningStatus": 9,
"releasedTime": null,
"billMode": 1,
"prodInstId": "3242364bc0134397baa24d5712d7f87e",
"prodType": 2
}
],
"pageNum": 1,
"navigatePages": 0,
"total": 22,
"pages": 0,
"firstPage": 0,
"size": 0,
"isLastPage": false,
"hasPreviousPage": false,
"isFirstPage": false
}
}
状态码
请参考 状态码
错误码
请参考 错误码
